diff options
author | Junio C Hamano <gitster@pobox.com> | 2007-11-25 10:48:04 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2007-12-15 09:29:38 +0300 |
commit | 530e741c726a612d78de21957d531dd2215483b4 (patch) | |
tree | 52cc876e8da8eb90edfabb1f85159d065a78bc91 /Documentation/technical/api-in-core-index.txt | |
parent | fa4701601a62664a9246a211c5d26f238820737e (diff) |
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>
Diffstat (limited to 'Documentation/technical/api-in-core-index.txt')
-rw-r--r-- | Documentation/technical/api-in-core-index.txt | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/Documentation/technical/api-in-core-index.txt b/Documentation/technical/api-in-core-index.txt new file mode 100644 index 0000000000..adbdbf5d75 --- /dev/null +++ b/Documentation/technical/api-in-core-index.txt @@ -0,0 +1,21 @@ +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) |