@matheusbsbs / matheus-bagliano / commits / eff351c957
Fork 0

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>

J. Bruce Fields committed Jan 21, 2006 at 18:54 UTC eff351c957975055643f2e1359652ab3aac30256
1 file changed +26 -2
INSTALL
+26 -2
@@ -5,8 +5,8 @@ Normally you can just do "make" followed by "make install", and that
5 will install the git programs in your own ~/bin/ directory. If you want
6 to do a global install, you can do
7
8 - $ make prefix=/usr ;# as yourself
9 - # make prefix=/usr install ;# as root
8 + $ make prefix=/usr all doc ;# as yourself
9 + # make prefix=/usr install install-doc ;# as root
10
11 (or prefix=/usr/local, of course). Just like any program suite
12 that uses $prefix, the built results have some paths encoded,
@@ -90,3 +90,27 @@ Issues of note:
90 You can place local settings in config.mak and the Makefile
91 will include them. Note that config.mak is not distributed;
92 the name is reserved for local settings.
93 +
94 + - To build and install documentation suite, you need to have the
95 + asciidoc/xmlto toolchain. Alternatively, pre-formatted
96 + documentation are available in "html" and "man" branches of the git
97 + repository itself. For example, you could:
98 +
99 + $ mkdir manual && cd manual
100 + $ git init-db
101 + $ git clone-pack git://git.kernel.org/pub/scm/git/git.git man html |
102 + while read a b
103 + do
104 + echo $a >.git/$b
105 + done
106 + $ cp .git/refs/heads/man .git/refs/heads/master
107 + $ git checkout
108 +
109 + to checkout the pre-built man pages. Also in this repository:
110 +
111 + $ git checkout html
112 +
113 + would instead give you a copy of what you see at:
114 +
115 + http://www.kernel.org/pub/software/scm/git/docs/
116 +