Skip to content

Commit

Permalink
Makefile: add quick-install-doc for installing pre-built manpages
Browse files Browse the repository at this point in the history
This adds and uses the install-doc-quick.sh file to
Documentation/, which is usable for people who track either the
'html' or 'man' heads in Junio's repository (prefixed with
'origin/' if cloned locally).  You may override this by
specifying DOC_REF in the make environment or in config.mak.

GZ may also be set in the environment (or config.mak) if you
wish to gzip the documentation after installing it.

Signed-off-by: Eric Wong <normalperson@yhbt.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
  • Loading branch information
Eric Wong authored and Junio C Hamano committed Dec 23, 2006
1 parent 6be9351 commit 6538d1e
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 0 deletions.
4 changes: 4 additions & 0 deletions Documentation/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ man7dir=$(mandir)/man7
# DESTDIR=

INSTALL?=install
DOC_REF = origin/man

-include ../config.mak.autogen

Expand Down Expand Up @@ -112,3 +113,6 @@ $(patsubst %.txt,%.html,$(wildcard howto/*.txt)): %.html : %.txt

install-webdoc : html
sh ./install-webdoc.sh $(WEBDOC_DEST)

quick-install:
sh ./install-doc-quick.sh $(DOC_REF) $(mandir)
31 changes: 31 additions & 0 deletions Documentation/install-doc-quick.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/bin/sh
# This requires a branch named in $head
# (usually 'man' or 'html', provided by the git.git repository)
set -e
head="$1"
mandir="$2"
SUBDIRECTORY_OK=t
USAGE='<refname> <target directory>'
. git-sh-setup
export GIT_DIR

test -z "$mandir" && usage
if ! git-rev-parse --verify "$head^0" >/dev/null; then
echo >&2 "head: $head does not exist in the current repository"
usage
fi

GIT_INDEX_FILE=`pwd`/.quick-doc.index
export GIT_INDEX_FILE
rm -f "$GIT_INDEX_FILE"
git-read-tree $head
git-checkout-index -a -f --prefix="$mandir"/

if test -n "$GZ"; then
cd "$mandir"
for i in `git-ls-tree -r --name-only $head`
do
gzip < $i > $i.gz && rm $i
done
fi
rm -f "$GIT_INDEX_FILE"
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -824,6 +824,8 @@ install: all
install-doc:
$(MAKE) -C Documentation install

quick-install-doc:
$(MAKE) -C Documentation quick-install



Expand Down

0 comments on commit 6538d1e

Please sign in to comment.