documentation: retire unfinished documentation
authorStefan Beller <sbeller@google.com>
Thu, 19 Jan 2017 03:18:54 +0000 (19:18 -0800)
committerJunio C Hamano <gitster@pobox.com>
Thu, 19 Jan 2017 20:18:43 +0000 (12:18 -0800)
commit830c912a0ed5d0771e9043cd51b87322230c8b6f
treec32119c5c6b32dd78cad867363ab8fc05c693f7e
parent20cf41d02158cbb838faec70ad1d989172fc592f
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>
Documentation/technical/api-in-core-index.txt [deleted file]