INSTALL

   1
   2                 Git installation
   3
   4 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 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,
  13 which are derived from $prefix, so "make all; make prefix=/usr
  14 install" would not work.
  15
  16 Issues of note:
  17
  18  - git normally installs a helper script wrapper called "git", which
  19    conflicts with a similarly named "GNU interactive tools" program.
  20
  21    Tough.  Either don't use the wrapper script, or delete the old GNU
  22    interactive tools.  None of the core git stuff needs the wrapper,
  23    it's just a convenient shorthand and while it is documented in some
  24    places, you can always replace "git commit" with "git-commit"
  25    instead.
  26
  27    But let's face it, most of us don't have GNU interactive tools, and
  28    even if we had it, we wouldn't know what it does.  I don't think it
  29    has been actively developed since 1997, and people have moved over to
  30    graphical file managers.
  31
  32  - You can use git after building but without installing if you
  33    wanted to.  Various git commands need to find other git
  34    commands and scripts to do their work, so you would need to
  35    arrange a few environment variables to tell them that their
  36    friends will be found in your built source area instead of at
  37    their standard installation area.  Something like this works
  38    for me:
  39
  40         GIT_EXEC_PATH=`pwd`
  41         PATH=`pwd`:$PATH
  42         GITPERLLIB=`pwd`/perl/blib/lib:`pwd`/perl/blib/arch/auto/Git
  43         export GIT_EXEC_PATH PATH GITPERLLIB
  44
  45  - Git is reasonably self-sufficient, but does depend on a few external
  46    programs and libraries:
  47
  48         - "zlib", the compression library. Git won't build without it.
  49
  50         - "openssl".  The git-rev-list program uses bignum support from
  51           openssl, and unless you specify otherwise, you'll also get the
  52           SHA1 library from here.
  53
  54           If you don't have openssl, you can use one of the SHA1 libraries
  55           that come with git (git includes the one from Mozilla, and has
  56           its own PowerPC and ARM optimized ones too - see the Makefile).
  57
  58         - "libcurl" and "curl" executable.  git-http-fetch and
  59           git-fetch use them.  If you do not use http
  60           transfer, you are probabaly OK if you do not have
  61           them.
  62
  63         - expat library; git-http-push uses it for remote lock
  64           management over DAV.  Similar to "curl" above, this is optional.
  65
  66         - "GNU diff" to generate patches.  Of course, you don't _have_ to
  67           generate patches if you don't want to, but let's face it, you'll
  68           be wanting to. Or why did you get git in the first place?
  69
  70           Non-GNU versions of the diff/patch programs don't generally support
  71           the unified patch format (which is the one git uses), so you
  72           really do want to get the GNU one.  Trust me, you will want to
  73           do that even if it wasn't for git.  There's no point in living
  74           in the dark ages any more.
  75
  76         - "merge", the standard UNIX three-way merge program.  It usually
  77           comes with the "rcs" package on most Linux distributions, so if
  78           you have a developer install you probably have it already, but a
  79           "graphical user desktop" install might have left it out.
  80
  81           You'll only need the merge program if you do development using
  82           git, and if you only use git to track other peoples work you'll
  83           never notice the lack of it.
  84
  85         - "wish", the TCL/Tk windowing shell is used in gitk to show the
  86           history graphically
  87
  88         - "ssh" is used to push and pull over the net
  89
  90         - "perl" and POSIX-compliant shells are needed to use most of
  91           the barebone Porcelainish scripts.
  92
  93         - "python" 2.3 or more recent; if you have 2.3, you may need
  94           to build with "make WITH_OWN_SUBPROCESS_PY=YesPlease".
  95
  96  - Some platform specific issues are dealt with Makefile rules,
  97    but depending on your specific installation, you may not
  98    have all the libraries/tools needed, or you may have
  99    necessary libraries at unusual locations.  Please look at the
 100    top of the Makefile to see what can be adjusted for your needs.
 101    You can place local settings in config.mak and the Makefile
 102    will include them.  Note that config.mak is not distributed;
 103    the name is reserved for local settings.
 104
 105  - To build and install documentation suite, you need to have the
 106    asciidoc/xmlto toolchain.  Alternatively, pre-formatted
 107    documentation are available in "html" and "man" branches of the git
 108    repository itself.  For example, you could:
 109
 110         $ mkdir manual && cd manual
 111         $ git init-db
 112         $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html |
 113           while read a b
 114           do
 115             echo $a >.git/$b
 116           done
 117         $ cp .git/refs/heads/man .git/refs/heads/master
 118         $ git checkout
 119
 120    to checkout the pre-built man pages.  Also in this repository:
 121
 122         $ git checkout html
 123
 124    would instead give you a copy of what you see at:
 125
 126         http://www.kernel.org/pub/software/scm/git/docs/
 127