diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2007-11-24 23:48:04 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2007-12-14 22:29:38 -0800 |
| commit | 530e741c726a612d78de21957d531dd2215483b4 (patch) | |
| tree | 52cc876e8da8eb90edfabb1f85159d065a78bc91 /Documentation/technical/api-object-access.txt | |
| parent | Retire git-runstatus for real. (diff) | |
| download | tgif-530e741c726a612d78de21957d531dd2215483b4.tar.xz | |
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-object-access.txt')
| -rw-r--r-- | Documentation/technical/api-object-access.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/technical/api-object-access.txt b/Documentation/technical/api-object-access.txt new file mode 100644 index 0000000000..03bb0e950d --- /dev/null +++ b/Documentation/technical/api-object-access.txt @@ -0,0 +1,15 @@ +object access API +================= + +Talk about <sha1_file.c> and <object.h> family, things like + +* read_sha1_file() +* read_object_with_reference() +* has_sha1_file() +* write_sha1_file() +* pretend_sha1_file() +* lookup_{object,commit,tag,blob,tree} +* parse_{object,commit,tag,blob,tree} +* Use of object flags + +(JC, Shawn, Daniel, Dscho, Linus) |