From e6fc2346c17b9a4ee274d509429042eec9c14db5 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 25 Aug 2005 00:28:18 -0700 Subject: [PATCH] Link howto documents from the main git.txt documentation. Signed-off-by: Junio C Hamano --- Documentation/Makefile | 15 ++++++++++++++- Documentation/git.txt | 5 +++++ Documentation/howto-index.sh | 27 +++++++++++++++++++++++++++ Documentation/install-webdoc.sh | 25 +++++++++++++++++++++++++ 4 files changed, 71 insertions(+), 1 deletion(-) create mode 100755 Documentation/howto-index.sh create mode 100755 Documentation/install-webdoc.sh diff --git a/Documentation/Makefile b/Documentation/Makefile index 91addedca..bff43e0c6 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -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) diff --git a/Documentation/git.txt b/Documentation/git.txt index 664b88a91..d4ede094f 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -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 08/05/05 diff --git a/Documentation/howto-index.sh b/Documentation/howto-index.sh new file mode 100755 index 000000000..3a6afb9f6 --- /dev/null +++ b/Documentation/howto-index.sh @@ -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 index 000000000..1f534f1e7 --- /dev/null +++ b/Documentation/install-webdoc.sh @@ -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" -- 2.26.2