summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-revision-walking.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2007-11-24 23:48:04 -0800
committerJunio C Hamano <gitster@pobox.com>2007-12-14 22:29:38 -0800
commit530e741c726a612d78de21957d531dd2215483b4 (patch)
tree52cc876e8da8eb90edfabb1f85159d065a78bc91 /Documentation/technical/api-revision-walking.txt
parentfa4701601a62664a9246a211c5d26f238820737e (diff)
downloadgit-530e741c726a612d78de21957d531dd2215483b4.tar.gz
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-revision-walking.txt')
-rw-r--r--Documentation/technical/api-revision-walking.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/technical/api-revision-walking.txt b/Documentation/technical/api-revision-walking.txt
new file mode 100644
index 0000000000..01a24551af
--- /dev/null
+++ b/Documentation/technical/api-revision-walking.txt
@@ -0,0 +1,9 @@
+revision walking API
+====================
+
+Talk about <revision.h>, things like:
+
+* two diff_options, one for path limiting, another for output;
+* calling sequence: init_revisions(), setup_revsions(), get_revision();
+
+(Linus, JC, Dscho)