summaryrefslogtreecommitdiff
path: root/pack-objects.h
diff options
context:
space:
mode:
authorLibravatar Stefan Beller <sbeller@google.com>2017-01-18 19:18:54 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2017-01-19 12:18:43 -0800
commit830c912a0ed5d0771e9043cd51b87322230c8b6f (patch)
treec32119c5c6b32dd78cad867363ab8fc05c693f7e /pack-objects.h
parentcache.h: document add_[file_]to_index (diff)
downloadtgif-830c912a0ed5d0771e9043cd51b87322230c8b6f.tar.xz
documentation: retire unfinished documentation
When looking for documentation for a specific function, you may be tempted to run git -C Documentation grep index_name_pos only to find the file technical/api-in-core-index.txt, which doesn't help for understanding the given function. It would be better to not find these functions in the documentation, such that people directly dive into the code instead. In the previous patches we have documented * index_name_pos() * remove_index_entry_at() * add_[file_]to_index() in cache.h We already have documentation for: * add_index_entry() * read_index() Which leaves us with a TODO for: * cache -> the_index macros * refresh_index() * discard_index() * ie_match_stat() and ie_modified(); how they are different and when to use which. * write_index() that was renamed to write_locked_index * cache_tree_invalidate_path() * cache_tree_update() Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'pack-objects.h')
0 files changed, 0 insertions, 0 deletions