Re: [PATCH] Mention install-doc in INSTALL

Petr Baudis [off-list ref] writes:

But you really do not want to build the documentation as root.

True.

Cogito's "solution" is:

+ - By default, separate documentation (manpages, text, HTML) is not built
+   since it requires asciidoc and xmlto, and those tools are not so common.

That's cheating ;-), but I cannot blame you.

I'll push out this hopefully tonight.

---
From: J. Bruce Fields <redacted>
Date: Sat Jan 21 18:54:12 2006 -0500
[PATCH] Mention install-doc in INSTALL

I think most people will want to install the man pages as well.

[jc: incorporated Pasky's comment on not building them as root.
Some people may not want to install asciidoc/xmlto toolchain, so
redirect them to the man and html branches of the git.git
repository as well.]

Signed-off-by: J. Bruce Fields <redacted>
Signed-off-by: Junio C Hamano <redacted>

---

 INSTALL |   28 ++++++++++++++++++++++++++--
 1 files changed, 26 insertions(+), 2 deletions(-)

eff351c957975055643f2e1359652ab3aac30256

diff --git a/INSTALL b/INSTALL
index 916ddd4..433449f 100644
--- a/INSTALL
+++ b/INSTALL

@@ -5,8 +5,8 @@ Normally you can just do "make" followed
 will install the git programs in your own ~/bin/ directory.  If you want
 to do a global install, you can do
 
-	$ make prefix=/usr ;# as yourself
-	# make prefix=/usr install ;# as root
+	$ make prefix=/usr all doc ;# as yourself
+	# make prefix=/usr install install-doc ;# as root
 
 (or prefix=/usr/local, of course).  Just like any program suite
 that uses $prefix, the built results have some paths encoded,

@@ -90,3 +90,27 @@ Issues of note:
    You can place local settings in config.mak and the Makefile
    will include them.  Note that config.mak is not distributed;
    the name is reserved for local settings.
+
+ - To build and install documentation suite, you need to have the
+   asciidoc/xmlto toolchain.  Alternatively, pre-formatted
+   documentation are available in "html" and "man" branches of the git
+   repository itself.  For example, you could:
+
+	$ mkdir manual && cd manual
+	$ git init-db
+	$ git clone-pack git://git.kernel.org/pub/scm/git/git.git man html |
+	  while read a b
+	  do
+	    echo $a >.git/$b
+	  done
+	$ cp .git/refs/heads/man .git/refs/heads/master
+	$ git checkout
+
+   to checkout the pre-built man pages.  Also in this repository:
+
+	$ git checkout html
+
+   would instead give you a copy of what you see at:
+
+	http://www.kernel.org/pub/software/scm/git/docs/
+

-- 
1.1.4.g73f3

On Sat, Jan 21, 2006 at 07:29:02PM -0800, Junio C Hamano wrote:

Petr Baudis [off-list ref] writes:

quoted

But you really do not want to build the documentation as root.

True.

quoted

Cogito's "solution" is:

+ - By default, separate documentation (manpages, text, HTML) is not built
+   since it requires asciidoc and xmlto, and those tools are not so common.

That's cheating ;-), but I cannot blame you.

I'll push out this hopefully tonight.

Looks good to me; thanks!--b.