blob: 2a46d045928a1159caf5fedcbafb8d4f816ec8ec [file] [log] [blame]
Linus Torvaldsc538d2d2005-06-17 11:30:04 -07001
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
David Kastrup98e79f62007-08-07 12:02:12 +02008 $ make prefix=/usr all doc info ;# as yourself
Michael J Gruber414851a2008-09-10 10:19:34 +02009 # make prefix=/usr install install-doc install-html install-info ;# as root
Linus Torvaldsc538d2d2005-06-17 11:30:04 -070010
Junio C Hamanoc44922a2005-11-09 12:40:03 -080011(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.
Linus Torvaldsc538d2d2005-06-17 11:30:04 -070015
Brian Gernhardt5beb5772009-09-10 16:28:19 -040016The 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
Jakub Narebski55667712006-07-03 01:56:48 +020020Alternatively you can use autoconf generated ./configure script to
21set up install paths (via config.mak.autogen), so you can write instead
22
Jakub Narebski39001452006-08-08 18:35:23 +020023 $ make configure ;# as yourself
Jakub Narebski55667712006-07-03 01:56:48 +020024 $ ./configure --prefix=/usr ;# as yourself
25 $ make all doc ;# as yourself
Michael J Gruber414851a2008-09-10 10:19:34 +020026 # make install install-doc install-html;# as root
Jakub Narebski55667712006-07-03 01:56:48 +020027
Andi Kleen39001002011-06-20 15:41:01 -070028If 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
Andi Kleen066dd262014-07-07 23:35:11 -070031 $ make prefix=/usr profile
Theodore Ts'of2d713f2012-02-06 01:00:17 -050032 # make prefix=/usr PROFILE=BUILD install
Andi Kleen39001002011-06-20 15:41:01 -070033
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
Andi Kleen066dd262014-07-07 23:35:11 -070039Alternatively 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
Theodore Ts'of2d713f2012-02-06 01:00:17 -050046Or if you just want to install a profile-optimized version of git into
47your home directory, you could run:
48
Andi Kleen066dd262014-07-07 23:35:11 -070049 $ make profile-install
50
51or
52 $ make profile-fast-install
Theodore Ts'of2d713f2012-02-06 01:00:17 -050053
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.
Jakub Narebski55667712006-07-03 01:56:48 +020060
Linus Torvaldsc538d2d2005-06-17 11:30:04 -070061Issues of note:
62
Junio C Hamanoa958d8e2008-07-06 19:10:00 -070063 - 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.
Linus Torvaldsc538d2d2005-06-17 11:30:04 -070068
Abhijit Menon-Sen25032cc2008-08-05 07:41:04 +053069 NOTE: When compiled with backward compatibility option, the GNU
Junio C Hamanoa958d8e2008-07-06 19:10:00 -070070 Interactive Tools package still can install "git", but you can build it
71 with --disable-transition option to avoid this.
Miklos Vajna62a64d12008-05-04 16:55:11 +020072
Matthew Ogilvie90458012009-12-02 22:14:07 -070073 - 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:
Junio C Hamano3c767a02006-07-02 23:54:47 -070084
85 GIT_EXEC_PATH=`pwd`
86 PATH=`pwd`:$PATH
Ævar Arnfjörð Bjarmason20d2a302017-12-10 21:13:33 +000087 GITPERLLIB=`pwd`/perl/build/lib
Petr Baudis6fcca932006-07-03 23:16:32 +020088 export GIT_EXEC_PATH PATH GITPERLLIB
Junio C Hamano3c767a02006-07-02 23:54:47 -070089
Ævar Arnfjörð Bjarmason20d2a302017-12-10 21:13:33 +000090 - By default (unless NO_PERL is provided) Git will ship various perl
Ævar Arnfjörð Bjarmason1aca69c2018-03-03 15:38:17 +000091 scripts. However, for simplicity it doesn't use the
92 ExtUtils::MakeMaker toolchain to decide where to place the perl
93 libraries. Depending on the system this can result in the perl
Ævar Arnfjörð Bjarmason20d2a302017-12-10 21:13:33 +000094 libraries not being where you'd like them if they're expected to be
95 used by things other than Git itself.
96
97 Manually supplying a perllibdir prefix should fix this, if this is
98 a problem you care about, e.g.:
99
100 prefix=/usr perllibdir=/usr/$(/usr/bin/perl -MConfig -wle 'print substr $Config{installsitelib}, 1 + length $Config{siteprefixexp}')
101
102 Will result in e.g. perllibdir=/usr/share/perl/5.26.1 on Debian,
103 perllibdir=/usr/share/perl5 (which we'd use by default) on CentOS.
104
Ævar Arnfjörð Bjarmason1aca69c2018-03-03 15:38:17 +0000105 - Unless NO_PERL is provided Git will ship various perl libraries it
106 needs. Distributors of Git will usually want to set
107 NO_PERL_CPAN_FALLBACKS if NO_PERL is not provided to use their own
108 copies of the CPAN modules Git needs.
109
Linus Torvaldsc538d2d2005-06-17 11:30:04 -0700110 - Git is reasonably self-sufficient, but does depend on a few external
Brian Gernhardt5beb5772009-09-10 16:28:19 -0400111 programs and libraries. Git can be used without most of them by adding
Elijah Newren89152972019-11-05 17:07:21 +0000112 the appropriate "NO_<LIBRARY>=YesPlease" to the make command line or
Brian Gernhardt5beb5772009-09-10 16:28:19 -0400113 config.mak file.
Linus Torvaldsc538d2d2005-06-17 11:30:04 -0700114
115 - "zlib", the compression library. Git won't build without it.
116
Brian Gernhardt26d94432009-09-08 21:51:00 -0400117 - "ssh" is used to push and pull over the net.
118
Andrei Rybak932757b2019-11-14 18:33:16 +0100119 - A POSIX-compliant shell is required to run some scripts needed
120 for everyday use (e.g. "bisect", "request-pull").
Brian Gernhardt26d94432009-09-08 21:51:00 -0400121
Todd Zullingerd13a73e2023-11-16 14:30:10 -0500122 - "Perl" version 5.8.1 or later is needed to use some of the
Ævar Arnfjörð Bjarmason20b813d2023-02-06 23:58:56 +0100123 features (e.g. sending patches using "git send-email",
Ævar Arnfjörð Bjarmasond48b2842010-09-24 20:00:52 +0000124 interacting with svn repositories with "git svn"). If you can
Junio C Hamano634a5f22012-01-26 21:48:33 -0800125 live without these, use NO_PERL. Note that recent releases of
126 Redhat/Fedora are reported to ship Perl binary package with some
Josh Sorefd05b08c2023-11-24 03:35:13 +0000127 core modules stripped away (see https://lwn.net/Articles/477234/),
Junio C Hamano634a5f22012-01-26 21:48:33 -0800128 so you might need to install additional packages other than Perl
Todd Zullinger14f437f2018-03-16 18:07:48 -0400129 itself, e.g. Digest::MD5, File::Spec, File::Temp, Net::Domain,
130 Net::SMTP, and Time::HiRes.
Brian Gernhardt26d94432009-09-08 21:51:00 -0400131
Bernhard Reiter1e16b252014-11-09 15:55:53 +0100132 - git-imap-send needs the OpenSSL library to talk IMAP over SSL if
133 you are using libcurl older than 7.34.0. Otherwise you can use
134 NO_OPENSSL without losing git-imap-send.
Linus Torvaldsc538d2d2005-06-17 11:30:04 -0700135
Ævar Arnfjörð Bjarmasone54e5022021-09-11 11:34:16 +0200136 - "libcurl" library is used for fetching and pushing
137 repositories over http:// or https://, as well as by
138 git-imap-send if the curl version is >= 7.34.0. If you do
139 not need that functionality, use NO_CURL to build without
140 it.
Linus Torvaldsc538d2d2005-06-17 11:30:04 -0700141
Jeff Kingea61df92024-04-02 16:06:00 -0400142 Git requires version "7.21.3" or later of "libcurl" to build
Ævar Arnfjörð Bjarmason59a399e2021-09-13 16:51:23 +0200143 without NO_CURL. This version requirement may be bumped in
144 the future.
145
Brian Gernhardt5beb5772009-09-10 16:28:19 -0400146 - "expat" library; git-http-push uses it for remote lock
147 management over DAV. Similar to "curl" above, this is optional
148 (with NO_EXPAT).
Junio C Hamano3402f1d2005-11-05 11:12:05 -0800149
Brian Gernhardt5beb5772009-09-10 16:28:19 -0400150 - "wish", the Tcl/Tk windowing shell is used in gitk to show the
151 history graphically, and in git-gui. If you don't want gitk or
152 git-gui, you can use NO_TCLTK.
Horst von Brand663a5ed2005-09-11 20:00:49 -0400153
Ævar Arnfjörð Bjarmason5e9637c2011-11-18 00:14:42 +0100154 - A gettext library is used by default for localizing Git. The
155 primary target is GNU libintl, but the Solaris gettext
156 implementation also works.
157
158 We need a gettext.h on the system for C code, gettext.sh (or
159 Solaris gettext(1)) for shell scripts, and libintl-perl for Perl
160 programs.
161
162 Set NO_GETTEXT to disable localization support and make Git only
163 use English. Under autoconf the configure script will do this
164 automatically if it can't find libintl on the system.
165
Đoàn Trần Công Danhfcedbc12020-12-10 21:30:17 +0700166 - Python version 2.7 or later is needed to use the git-p4 interface
Junio C Hamano2e4f04f2013-01-30 11:17:59 -0800167 to Perforce.
Pete Wyckoffb6f93052012-04-08 20:18:00 -0400168
Junio C Hamano3cab3592005-11-11 11:27:03 -0800169 - Some platform specific issues are dealt with Makefile rules,
170 but depending on your specific installation, you may not
171 have all the libraries/tools needed, or you may have
172 necessary libraries at unusual locations. Please look at the
173 top of the Makefile to see what can be adjusted for your needs.
Jason Riedycd8c4582005-12-05 10:38:30 -0800174 You can place local settings in config.mak and the Makefile
175 will include them. Note that config.mak is not distributed;
176 the name is reserved for local settings.
J. Bruce Fieldseff351c2006-01-21 18:54:12 -0500177
Junio C Hamanoa90918e2007-06-18 01:43:34 -0700178 - To build and install documentation suite, you need to have
179 the asciidoc/xmlto toolchain. Because not many people are
180 inclined to install the tools, the default build target
David Kastrup98e79f62007-08-07 12:02:12 +0200181 ("make all") does _not_ build them.
182
Michael J Gruber414851a2008-09-10 10:19:34 +0200183 "make doc" builds documentation in man and html formats; there are
184 also "make man", "make html" and "make info". Note that "make html"
185 requires asciidoc, but not xmlto. "make man" (and thus make doc)
186 requires both.
187
188 "make install-doc" installs documentation in man format only; there
189 are also "make install-man", "make install-html" and "make
190 install-info".
191
David Kastrup98e79f62007-08-07 12:02:12 +0200192 Building and installing the info file additionally requires
193 makeinfo and docbook2X. Version 0.8.3 is known to work.
194
Miklos Vajnaa325a1a2008-12-10 23:44:50 +0100195 Building and installing the pdf file additionally requires
Jeff Kingb2478aa2012-05-30 06:18:29 -0400196 dblatex. Version >= 0.2.7 is known to work.
Miklos Vajnaa325a1a2008-12-10 23:44:50 +0100197
Bagas Sanjaya6534d432021-03-19 18:00:45 +0700198 All formats require at least asciidoc 8.4.1. Alternatively, you can
199 use Asciidoctor (requires Ruby) by passing USE_ASCIIDOCTOR=YesPlease
200 to make. You need at least Asciidoctor version 1.5.
Junio C Hamanoa90918e2007-06-18 01:43:34 -0700201
Markus Heidelbergb1a46b72008-11-02 18:53:03 +0100202 There are also "make quick-install-doc", "make quick-install-man"
203 and "make quick-install-html" which install preformatted man pages
Junio C Hamanofcbebfd2011-11-08 10:17:40 -0800204 and html documentation. To use these build targets, you need to
205 clone two separate git-htmldocs and git-manpages repositories next
206 to the clone of git itself.
Michael J Gruber6fe570d2008-09-09 22:44:17 +0200207
Martin Ågren5a80d852020-03-29 15:18:10 +0200208 The minimum supported version of docbook-xsl is 1.74.
Jon Seymour0edf06d2010-07-25 13:57:35 +1000209
210 Users attempting to build the documentation on Cygwin may need to ensure
211 that the /etc/xml/catalog file looks something like this:
212
213 <?xml version="1.0"?>
214 <!DOCTYPE catalog PUBLIC
215 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
216 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"
217 >
218 <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
219 <rewriteURI
220 uriStartString = "http://docbook.sourceforge.net/release/xsl/current"
221 rewritePrefix = "/usr/share/sgml/docbook/xsl-stylesheets"
222 />
223 <rewriteURI
224 uriStartString="http://www.oasis-open.org/docbook/xml/4.5"
225 rewritePrefix="/usr/share/sgml/docbook/xml-dtd-4.5"
226 />
227 </catalog>
228
229 This can be achieved with the following two xmlcatalog commands:
230
231 xmlcatalog --noout \
232 --add rewriteURI \
233 http://docbook.sourceforge.net/release/xsl/current \
234 /usr/share/sgml/docbook/xsl-stylesheets \
235 /etc/xml/catalog
236
237 xmlcatalog --noout \
238 --add rewriteURI \
239 http://www.oasis-open.org/docbook/xml/4.5/xsl/current \
240 /usr/share/sgml/docbook/xml-dtd-4.5 \
241 /etc/xml/catalog