Merge commit 'junio/next' into next
[git/platforms/storm.git] / INSTALL
blobd9b425fa73e806751ff2636300ea24bd1e7f1e56
2                 Git installation
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
8         $ make prefix=/usr all doc info ;# as yourself
9         # make prefix=/usr install install-doc install-info ;# as root
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.
16 Alternatively you can use autoconf generated ./configure script to
17 set up install paths (via config.mak.autogen), so you can write instead
19         $ make configure ;# as yourself
20         $ ./configure --prefix=/usr ;# as yourself
21         $ make all doc ;# as yourself
22         # make install install-doc ;# as root
25 Issues of note:
27  - git normally installs a helper script wrapper called "git", which
28    conflicts with a similarly named "GNU interactive tools" program.
30    Tough.  Either don't use the wrapper script, or delete the old GNU
31    interactive tools.  None of the core git stuff needs the wrapper,
32    it's just a convenient shorthand and while it is documented in some
33    places, you can always replace "git commit" with "git-commit"
34    instead.
36    But let's face it, most of us don't have GNU interactive tools, and
37    even if we had it, we wouldn't know what it does.  I don't think it
38    has been actively developed since 1997, and people have moved over to
39    graphical file managers.
41    NOTE: As of gnuit-4.9.2, the GNU interactive tools package has been
42          renamed. You can compile gnuit with the --disable-transition
43          option and then it will not conflict with git.
45  - You can use git after building but without installing if you
46    wanted to.  Various git commands need to find other git
47    commands and scripts to do their work, so you would need to
48    arrange a few environment variables to tell them that their
49    friends will be found in your built source area instead of at
50    their standard installation area.  Something like this works
51    for me:
53         GIT_EXEC_PATH=`pwd`
54         PATH=`pwd`:$PATH
55         GITPERLLIB=`pwd`/perl/blib/lib
56         export GIT_EXEC_PATH PATH GITPERLLIB
58  - Git is reasonably self-sufficient, but does depend on a few external
59    programs and libraries:
61         - "zlib", the compression library. Git won't build without it.
63         - "openssl".  Unless you specify otherwise, you'll get the SHA1
64           library from here.
66           If you don't have openssl, you can use one of the SHA1 libraries
67           that come with git (git includes the one from Mozilla, and has
68           its own PowerPC and ARM optimized ones too - see the Makefile).
70         - "libcurl" and "curl" executable.  git-http-fetch and
71           git-fetch use them.  If you do not use http
72           transfer, you are probably OK if you do not have
73           them.
75         - expat library; git-http-push uses it for remote lock
76           management over DAV.  Similar to "curl" above, this is optional.
78         - "wish", the Tcl/Tk windowing shell is used in gitk to show the
79           history graphically, and in git-gui.
81         - "ssh" is used to push and pull over the net
83         - "perl" and POSIX-compliant shells are needed to use most of
84           the barebone Porcelainish scripts.
86         - "cpio" is used by git-clone when doing a local (possibly
87           hardlinked) clone.
89  - Some platform specific issues are dealt with Makefile rules,
90    but depending on your specific installation, you may not
91    have all the libraries/tools needed, or you may have
92    necessary libraries at unusual locations.  Please look at the
93    top of the Makefile to see what can be adjusted for your needs.
94    You can place local settings in config.mak and the Makefile
95    will include them.  Note that config.mak is not distributed;
96    the name is reserved for local settings.
98  - To build and install documentation suite, you need to have
99    the asciidoc/xmlto toolchain.  Because not many people are
100    inclined to install the tools, the default build target
101    ("make all") does _not_ build them.
103    Building and installing the info file additionally requires
104    makeinfo and docbook2X.  Version 0.8.3 is known to work.
106    The documentation is written for AsciiDoc 7, but "make
107    ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
109    Alternatively, pre-formatted documentation are available in
110    "html" and "man" branches of the git repository itself.  For
111    example, you could:
113         $ mkdir manual && cd manual
114         $ git init
115         $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html |
116           while read a b
117           do
118             echo $a >.git/$b
119           done
120         $ cp .git/refs/heads/man .git/refs/heads/master
121         $ git checkout
123    to checkout the pre-built man pages.  Also in this repository:
125         $ git checkout html
127    would instead give you a copy of what you see at:
129         http://www.kernel.org/pub/software/scm/git/docs/
131    It has been reported that docbook-xsl version 1.72 and 1.73 are
132    buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
133    the patch in contrib/patches/docbook-xsl-manpages-charmap.patch