Link howto documents from the main git.txt documentation.
authorJunio C Hamano <junkio@cox.net>
Thu, 25 Aug 2005 07:28:18 +0000 (00:28 -0700)
committerJunio C Hamano <junkio@cox.net>
Thu, 25 Aug 2005 07:28:18 +0000 (00:28 -0700)
Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/Makefile
Documentation/git.txt
Documentation/howto-index.sh [new file with mode: 0755]
Documentation/install-webdoc.sh [new file with mode: 0755]

index 91added..bff43e0 100644 (file)
@@ -44,7 +44,7 @@ git-diff-%.txt: diff-format.txt diff-options.txt
        touch $@
 
 clean:
-       rm -f *.xml *.html *.1 *.7
+       rm -f *.xml *.html *.1 *.7 howto-index.txt
 
 %.html : %.txt
        asciidoc -b xhtml11 -d manpage $<
@@ -62,3 +62,16 @@ glossary.html : glossary.txt sort_glossary.pl
 
 tutorial.html : tutorial.txt
        asciidoc -b xhtml11 tutorial.txt
+
+howto-index.txt: howto-index.sh $(wildcard howto/*.txt)
+       rm -f $@+ $@
+       sh ./howto-index.sh $(wildcard howto/*.txt) >$@+
+       mv $@+ $@
+
+howto-index.html: howto-index.txt
+       asciidoc -b xhtml11 howto-index.txt
+
+WEBDOC_DEST = /pub/software/scm/git/docs
+
+install-webdoc : html
+       sh ./install-webdoc.sh $(WEBDOC_DEST)
index 664b88a..d4ede09 100644 (file)
@@ -24,6 +24,11 @@ clarification info - read that first.  And of the commands, I suggest
 reading link:git-update-cache.html[git-update-cache] and
 link:git-read-tree.html[git-read-tree] first - I wish I had!
 
+After you get the general feel from the tutorial and this
+overview page, you may want to take a look at the
+link:howto-index.html[howto] documents.
+
+
 David Greaves <david@dgreaves.com>
 08/05/05
 
diff --git a/Documentation/howto-index.sh b/Documentation/howto-index.sh
new file mode 100755 (executable)
index 0000000..3a6afb9
--- /dev/null
@@ -0,0 +1,27 @@
+#!/bin/sh
+
+cat <<\EOF
+GIT Howto Index
+===============
+
+Here is a collection of mailing list postings made by various
+people describing how they use git in their workflow.
+
+EOF
+
+for txt
+do
+       title=`expr "$txt" : '.*/\(.*\)\.txt$'`
+       from=`sed -ne '
+       /^$/q
+       /^From:[        ]/{
+               s///
+               s/^[    ]*//
+               s/[     ]*$//
+               s/^/by /
+               p
+       }' "$txt"`
+       echo "
+       * link:$txt[$title] $from"
+
+done
diff --git a/Documentation/install-webdoc.sh b/Documentation/install-webdoc.sh
new file mode 100755 (executable)
index 0000000..1f534f1
--- /dev/null
@@ -0,0 +1,25 @@
+#!/bin/sh
+
+T="$1"
+
+for h in *.html howto/*.txt
+do
+       diff -u "$T/$h" "$h" || {
+               echo >&2 "# install $h $T/$h"
+               rm -f "$T/$h"
+               mkdir -p `dirname "$T/$h"`
+               cp "$h" "$T/$h"
+       }
+done
+strip_leading=`echo "$T/" | sed -e 's|.|.|g'`
+for th in "$T"/*.html "$T"/howto/*.txt
+do
+       h=`expr "$th" : "$strip_leading"'\(.*\)'`
+       case "$h" in
+       index.html) continue ;;
+       esac
+       test -f "$h" && continue
+       echo >&2 "# rm -f $th"
+       rm -f "$th"
+done
+ln -sf git.html "$T/index.html"