X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;ds=sidebyside;f=INSTALL;h=6f3bcb45253367e0bf7fc8e43e45ccb404b23824;hb=bc434e829c6f1757d2761c50e06a28278dc2f2c7;hp=361c65bacc50b4038cb9a32bab07c275a1ecdc76;hpb=1b2782a5e2f88bf5e6e2cbb58e54fea015e21af5;p=git.git diff --git a/INSTALL b/INSTALL index 361c65bac..6f3bcb452 100644 --- a/INSTALL +++ b/INSTALL @@ -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 all doc ;# as yourself - # make prefix=/usr install install-doc ;# as root + $ make prefix=/usr all doc info ;# as yourself + # make prefix=/usr install install-doc 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, @@ -31,7 +31,7 @@ Issues of note: interactive tools. None of the core git stuff needs the wrapper, it's just a convenient shorthand and while it is documented in some places, you can always replace "git commit" with "git-commit" - instead. + instead. But let's face it, most of us don't have GNU interactive tools, and even if we had it, we wouldn't know what it does. I don't think it @@ -56,9 +56,8 @@ Issues of note: - "zlib", the compression library. Git won't build without it. - - "openssl". The git-rev-list program uses bignum support from - openssl, and unless you specify otherwise, you'll also get the - SHA1 library from here. + - "openssl". Unless you specify otherwise, you'll get the SHA1 + library from here. If you don't have openssl, you can use one of the SHA1 libraries that come with git (git includes the one from Mozilla, and has @@ -73,13 +72,16 @@ Issues of note: management over DAV. Similar to "curl" above, this is optional. - "wish", the Tcl/Tk windowing shell is used in gitk to show the - history graphically + history graphically, and in git-gui. - "ssh" is used to push and pull over the net - "perl" and POSIX-compliant shells are needed to use most of the barebone Porcelainish scripts. + - "cpio" is used by git-clone when doing a local (possibly + hardlinked) clone. + - Some platform specific issues are dealt with Makefile rules, but depending on your specific installation, you may not have all the libraries/tools needed, or you may have @@ -89,10 +91,20 @@ Issues of note: 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: + - To build and install documentation suite, you need to have + the asciidoc/xmlto toolchain. Because not many people are + inclined to install the tools, the default build target + ("make all") does _not_ build them. + + 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 + "html" and "man" branches of the git repository itself. For + example, you could: $ mkdir manual && cd manual $ git init @@ -112,3 +124,6 @@ Issues of note: http://www.kernel.org/pub/software/scm/git/docs/ + It has been reported that docbook-xsl version 1.72 and 1.73 are + buggy; 1.72 misformats manual pages for callouts, and 1.73 needs + the patch in contrib/patches/docbook-xsl-manpages-charmap.patch