INSTALLon commit Fix unclosed here document in t3301.sh (85cb1d0)
   1
   2                Git installation
   3
   4Normally you can just do "make" followed by "make install", and that
   5will install the git programs in your own ~/bin/ directory.  If you want
   6to do a global install, you can do
   7
   8        $ make prefix=/usr all doc info ;# as yourself
   9        # make prefix=/usr install install-doc install-html install-info ;# as root
  10
  11(or prefix=/usr/local, of course).  Just like any program suite
  12that uses $prefix, the built results have some paths encoded,
  13which are derived from $prefix, so "make all; make prefix=/usr
  14install" would not work.
  15
  16The beginning of the Makefile documents many variables that affect the way
  17git is built.  You can override them either from the command line, or in a
  18config.mak file.
  19
  20Alternatively you can use autoconf generated ./configure script to
  21set up install paths (via config.mak.autogen), so you can write instead
  22
  23        $ make configure ;# as yourself
  24        $ ./configure --prefix=/usr ;# as yourself
  25        $ make all doc ;# as yourself
  26        # make install install-doc install-html;# as root
  27
  28If you're willing to trade off (much) longer build time for a later
  29faster git you can also do a profile feedback build with
  30
  31        $ make prefix=/usr profile
  32        # make prefix=/usr PROFILE=BUILD install
  33
  34This will run the complete test suite as training workload and then
  35rebuild git with the generated profile feedback. This results in a git
  36which is a few percent faster on CPU intensive workloads.  This
  37may be a good tradeoff for distribution packagers.
  38
  39Alternatively you can run profile feedback only with the git benchmark
  40suite. This runs significantly faster than the full test suite, but
  41has less coverage:
  42
  43        $ make prefix=/usr profile-fast
  44        # make prefix=/usr PROFILE=BUILD install
  45
  46Or if you just want to install a profile-optimized version of git into
  47your home directory, you could run:
  48
  49        $ make profile-install
  50
  51or
  52        $ make profile-fast-install
  53
  54As a caveat: a profile-optimized build takes a *lot* longer since the
  55git tree must be built twice, and in order for the profiling
  56measurements to work properly, ccache must be disabled and the test
  57suite has to be run using only a single CPU.  In addition, the profile
  58feedback build stage currently generates a lot of additional compiler
  59warnings.
  60
  61Issues of note:
  62
  63 - Ancient versions of GNU Interactive Tools (pre-4.9.2) installed a
  64   program "git", whose name conflicts with this program.  But with
  65   version 4.9.2, after long hiatus without active maintenance (since
  66   around 1997), it changed its name to gnuit and the name conflict is no
  67   longer a problem.
  68
  69   NOTE: When compiled with backward compatibility option, the GNU
  70   Interactive Tools package still can install "git", but you can build it
  71   with --disable-transition option to avoid this.
  72
  73 - You can use git after building but without installing if you want
  74   to test drive it.  Simply run git found in bin-wrappers directory
  75   in the build directory, or prepend that directory to your $PATH.
  76   This however is less efficient than running an installed git, as
  77   you always need an extra fork+exec to run any git subcommand.
  78
  79   It is still possible to use git without installing by setting a few
  80   environment variables, which was the way this was done
  81   traditionally.  But using git found in bin-wrappers directory in
  82   the build directory is far simpler.  As a historical reference, the
  83   old way went like this:
  84
  85        GIT_EXEC_PATH=`pwd`
  86        PATH=`pwd`:$PATH
  87        GITPERLLIB=`pwd`/perl/blib/lib
  88        export GIT_EXEC_PATH PATH GITPERLLIB
  89
  90 - Git is reasonably self-sufficient, but does depend on a few external
  91   programs and libraries.  Git can be used without most of them by adding
  92   the approriate "NO_<LIBRARY>=YesPlease" to the make command line or
  93   config.mak file.
  94
  95        - "zlib", the compression library. Git won't build without it.
  96
  97        - "ssh" is used to push and pull over the net.
  98
  99        - A POSIX-compliant shell is required to run many scripts needed
 100          for everyday use (e.g. "bisect", "pull").
 101
 102        - "Perl" version 5.8 or later is needed to use some of the
 103          features (e.g. preparing a partial commit using "git add -i/-p",
 104          interacting with svn repositories with "git svn").  If you can
 105          live without these, use NO_PERL.  Note that recent releases of
 106          Redhat/Fedora are reported to ship Perl binary package with some
 107          core modules stripped away (see http://lwn.net/Articles/477234/),
 108          so you might need to install additional packages other than Perl
 109          itself, e.g. Time::HiRes.
 110
 111        - "openssl" library is used by git-imap-send to use IMAP over SSL.
 112          If you don't need it, use NO_OPENSSL.
 113
 114          By default, git uses OpenSSL for SHA1 but it will use its own
 115          library (inspired by Mozilla's) with either NO_OPENSSL or
 116          BLK_SHA1.  Also included is a version optimized for PowerPC
 117          (PPC_SHA1).
 118
 119        - "libcurl" library is used by git-http-fetch and git-fetch.  You
 120          might also want the "curl" executable for debugging purposes.
 121          If you do not use http:// or https:// repositories, you do not
 122          have to have them (use NO_CURL).
 123
 124        - "expat" library; git-http-push uses it for remote lock
 125          management over DAV.  Similar to "curl" above, this is optional
 126          (with NO_EXPAT).
 127
 128        - "wish", the Tcl/Tk windowing shell is used in gitk to show the
 129          history graphically, and in git-gui.  If you don't want gitk or
 130          git-gui, you can use NO_TCLTK.
 131
 132        - A gettext library is used by default for localizing Git. The
 133          primary target is GNU libintl, but the Solaris gettext
 134          implementation also works.
 135
 136          We need a gettext.h on the system for C code, gettext.sh (or
 137          Solaris gettext(1)) for shell scripts, and libintl-perl for Perl
 138          programs.
 139
 140          Set NO_GETTEXT to disable localization support and make Git only
 141          use English. Under autoconf the configure script will do this
 142          automatically if it can't find libintl on the system.
 143
 144        - Python version 2.4 or later (but not 3.x, which is not
 145          supported by Perforce) is needed to use the git-p4 interface
 146          to Perforce.
 147
 148 - Some platform specific issues are dealt with Makefile rules,
 149   but depending on your specific installation, you may not
 150   have all the libraries/tools needed, or you may have
 151   necessary libraries at unusual locations.  Please look at the
 152   top of the Makefile to see what can be adjusted for your needs.
 153   You can place local settings in config.mak and the Makefile
 154   will include them.  Note that config.mak is not distributed;
 155   the name is reserved for local settings.
 156
 157 - To build and install documentation suite, you need to have
 158   the asciidoc/xmlto toolchain.  Because not many people are
 159   inclined to install the tools, the default build target
 160   ("make all") does _not_ build them.
 161
 162   "make doc" builds documentation in man and html formats; there are
 163   also "make man", "make html" and "make info". Note that "make html"
 164   requires asciidoc, but not xmlto. "make man" (and thus make doc)
 165   requires both.
 166
 167   "make install-doc" installs documentation in man format only; there
 168   are also "make install-man", "make install-html" and "make
 169   install-info".
 170
 171   Building and installing the info file additionally requires
 172   makeinfo and docbook2X.  Version 0.8.3 is known to work.
 173
 174   Building and installing the pdf file additionally requires
 175   dblatex.  Version >= 0.2.7 is known to work.
 176
 177   All formats require at least asciidoc 8.4.1.
 178
 179   There are also "make quick-install-doc", "make quick-install-man"
 180   and "make quick-install-html" which install preformatted man pages
 181   and html documentation. To use these build targets, you need to
 182   clone two separate git-htmldocs and git-manpages repositories next
 183   to the clone of git itself.
 184
 185   It has been reported that docbook-xsl version 1.72 and 1.73 are
 186   buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
 187   the patch in contrib/patches/docbook-xsl-manpages-charmap.patch
 188
 189   Users attempting to build the documentation on Cygwin may need to ensure
 190   that the /etc/xml/catalog file looks something like this:
 191
 192   <?xml version="1.0"?>
 193   <!DOCTYPE catalog PUBLIC
 194      "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
 195      "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"
 196   >
 197   <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
 198     <rewriteURI
 199       uriStartString = "http://docbook.sourceforge.net/release/xsl/current"
 200       rewritePrefix = "/usr/share/sgml/docbook/xsl-stylesheets"
 201     />
 202     <rewriteURI
 203       uriStartString="http://www.oasis-open.org/docbook/xml/4.5"
 204       rewritePrefix="/usr/share/sgml/docbook/xml-dtd-4.5"
 205     />
 206  </catalog>
 207
 208  This can be achieved with the following two xmlcatalog commands:
 209
 210  xmlcatalog --noout \
 211     --add rewriteURI \
 212        http://docbook.sourceforge.net/release/xsl/current \
 213        /usr/share/sgml/docbook/xsl-stylesheets \
 214     /etc/xml/catalog
 215
 216  xmlcatalog --noout \
 217     --add rewriteURI \
 218         http://www.oasis-open.org/docbook/xml/4.5/xsl/current \
 219         /usr/share/sgml/docbook/xml-dtd-4.5 \
 220     /etc/xml/catalog