X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=INSTALL;h=d1deb0b3c7a9aba961d40fe541490562fee486ac;hb=0f639abb68b29f6d4cd9b89ecfb66e41136dcfa3;hp=15462e970d7e4b8dbc7282391ea7f9c7a5228ef2;hpb=6fe570de05513bc13ac1e00ab3508ca525b41135;p=git.git diff --git a/INSTALL b/INSTALL index 15462e970..d1deb0b3c 100644 --- a/INSTALL +++ b/INSTALL @@ -6,7 +6,7 @@ will install the git programs in your own ~/bin/ directory. If you want to do a global install, you can do $ make prefix=/usr all doc info ;# as yourself - # make prefix=/usr install install-doc install-info ;# as root + # make prefix=/usr install install-doc install-html install-info ;# as root (or prefix=/usr/local, of course). Just like any program suite that uses $prefix, the built results have some paths encoded, @@ -19,7 +19,7 @@ set up install paths (via config.mak.autogen), so you can write instead $ make configure ;# as yourself $ ./configure --prefix=/usr ;# as yourself $ make all doc ;# as yourself - # make install install-doc ;# as root + # make install install-doc install-html;# as root Issues of note: @@ -89,13 +89,22 @@ Issues of note: inclined to install the tools, the default build target ("make all") does _not_ build them. + "make doc" builds documentation in man and html formats; there are + also "make man", "make html" and "make info". Note that "make html" + requires asciidoc, but not xmlto. "make man" (and thus make doc) + requires both. + + "make install-doc" installs documentation in man format only; there + are also "make install-man", "make install-html" and "make + install-info". + Building and installing the info file additionally requires makeinfo and docbook2X. Version 0.8.3 is known to work. The documentation is written for AsciiDoc 7, but "make ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8. - Alternatively, pre-formatted documentation are available in + Alternatively, pre-formatted documentation is available in "html" and "man" branches of the git repository itself. For example, you could: @@ -117,8 +126,9 @@ Issues of note: http://www.kernel.org/pub/software/scm/git/docs/ - There are also "make quick-install-doc" and "make quick-install-html" - which install preformatted man pages and html documentation. + There are also "make quick-install-doc", "make quick-install-man" + and "make quick-install-html" which install preformatted man pages + and html documentation. This does not require asciidoc/xmlto, but it only works from within a cloned checkout of git.git with these two extra branches, and will not work for the maintainer for obvious chicken-and-egg reasons.