summaryrefslogtreecommitdiff
path: root/Documentation/technical
diff options
context:
space:
mode:
authorStefan Beller <sbeller@google.com>2017-01-19 03:18:54 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-01-19 20:18:43 (GMT)
commit830c912a0ed5d0771e9043cd51b87322230c8b6f (patch)
treec32119c5c6b32dd78cad867363ab8fc05c693f7e /Documentation/technical
parent20cf41d02158cbb838faec70ad1d989172fc592f (diff)
downloadgit-830c912a0ed5d0771e9043cd51b87322230c8b6f.zip
git-830c912a0ed5d0771e9043cd51b87322230c8b6f.tar.gz
git-830c912a0ed5d0771e9043cd51b87322230c8b6f.tar.bz2
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 'Documentation/technical')
-rw-r--r--Documentation/technical/api-in-core-index.txt21
1 files changed, 0 insertions, 21 deletions
diff --git a/Documentation/technical/api-in-core-index.txt b/Documentation/technical/api-in-core-index.txt
deleted file mode 100644
index adbdbf5..0000000
--- a/Documentation/technical/api-in-core-index.txt
+++ /dev/null
@@ -1,21 +0,0 @@
-in-core index API
-=================
-
-Talk about <read-cache.c> and <cache-tree.c>, things like:
-
-* cache -> the_index macros
-* read_index()
-* write_index()
-* ie_match_stat() and ie_modified(); how they are different and when to
- use which.
-* index_name_pos()
-* remove_index_entry_at()
-* remove_file_from_index()
-* add_file_to_index()
-* add_index_entry()
-* refresh_index()
-* discard_index()
-* cache_tree_invalidate_path()
-* cache_tree_update()
-
-(JC, Linus)