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>
This commit is contained in:
28
Documentation/technical/api-index.sh
Executable file
28
Documentation/technical/api-index.sh
Executable file
@ -0,0 +1,28 @@
|
||||
#!/bin/sh
|
||||
|
||||
(
|
||||
c=////////////////////////////////////////////////////////////////
|
||||
skel=api-index-skel.txt
|
||||
sed -e '/^\/\/ table of contents begin/q' "$skel"
|
||||
echo "$c"
|
||||
|
||||
ls api-*.txt |
|
||||
while read filename
|
||||
do
|
||||
case "$filename" in
|
||||
api-index-skel.txt | api-index.txt) continue ;;
|
||||
esac
|
||||
title=$(sed -e 1q "$filename")
|
||||
html=${filename%.txt}.html
|
||||
echo "* link:$html[$title]"
|
||||
done
|
||||
echo "$c"
|
||||
sed -n -e '/^\/\/ table of contents end/,$p' "$skel"
|
||||
) >api-index.txt+
|
||||
|
||||
if test -f api-index.txt && cmp api-index.txt api-index.txt+ >/dev/null
|
||||
then
|
||||
rm -f api-index.txt+
|
||||
else
|
||||
mv api-index.txt+ api-index.txt
|
||||
fi
|
Reference in New Issue
Block a user