git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH] Makefile: add quick-install-doc for installing pre-built manpages

From
EWEric Wong <normalperson@yhbt.net>
Date
Dec 23, 2006, 16:26 UTC
Message-ID
<20061223162609.GA23084@localdomain>
In-Reply-To
<7virg3t54l.fsf@assigned-by-dhcp.cox.net>

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>
---
 Documentation/Makefile             |    4 ++++
 Documentation/install-doc-quick.sh |   31 +++++++++++++++++++++++++++++++
 Makefile                           |    2 ++
 3 files changed, 37 insertions(+), 0 deletions(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index d68bc4a..93c7024 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -32,6 +32,7 @@ man7dir=$(mandir)/man7
 # DESTDIR=
 
 INSTALL?=install
+DOC_REF = origin/man
 
 -include ../config.mak.autogen
 
@@ -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)
diff --git a/Documentation/install-doc-quick.sh b/Documentation/install-doc-quick.sh
new file mode 100755
index 0000000..a640549
--- /dev/null
+++ b/Documentation/install-doc-quick.sh
@@ -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"
diff --git a/Makefile b/Makefile
index 4362297..ebc1a17 100644
--- a/Makefile
+++ b/Makefile
@@ -824,6 +824,8 @@ install: all
 install-doc:
 	$(MAKE) -C Documentation install
 
+quick-install-doc:
+	$(MAKE) -C Documentation quick-install
 
 
 
-- 
1.4.4.3.gc902c
Previous: Junio C Hamano
Message 4 of 4 in “Makefile: add quick-install-doc for installing pre-built manpages”
  1. 1/2 Makefile: add quick-install-doc for installing pre-built manpagesEric Wong, Dec 23, 2006
  2. 2/2 Remove NO_ACCURATE_DIFF options from build systemsEric Wong, Dec 23, 2006
  3. Junio C HamanoDec 23, 2006
  4. Makefile: add quick-install-doc for installing pre-built manpagesEric Wong, Dec 23, 2006

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.