git/Documentation/technical/api-in-core-index.txt
Junio C Hamano 530e741c72 Start preparing the API documents.
Most of them are still stubs, but the procedure to build the HTML
documentation, maintaining the index and installing the end product are
there.

I placed names of people who are likely to know the most about the topic
in the stub files, so that volunteers will know whom to ask questions as
needed.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-12-14 22:29:38 -08:00

22 lines
457 B
Plaintext

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)