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