Browse Source

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 <bfields@citi.umich.edu>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
J. Bruce Fields 19 years ago committed by Junio C Hamano
parent
commit
eff351c957
  1. 28
      INSTALL

28
INSTALL

@ -5,8 +5,8 @@ Normally you can just do "make" followed by "make install", and that @@ -5,8 +5,8 @@ Normally you can just do "make" followed by "make install", and that
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: @@ -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/


Loading…
Cancel
Save