Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 210 lines (162 sloc) 8.662 kb
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
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
98e79f6 INSTALL: explain info installation and dependencies.
David Kastrup authored
8 $ make prefix=/usr all doc info ;# as yourself
414851a separate build targets for man and html documentation
Michael J Gruber authored
9 # make prefix=/usr install install-doc install-html install-info ;# as root
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
10
c44922a Update INSTALL
Junio C Hamano authored
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.
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
15
5beb577 Brian Gernhardt INSTALL: Describe dependency knobs from Makefile
Benabik authored
16 The beginning of the Makefile documents many variables that affect the way
17 git is built. You can override them either from the command line, or in a
18 config.mak file.
19
5566771 Jakub Narębski autoconf: Use autoconf to write installation directories to config.mak.a...
jnareb authored
20 Alternatively you can use autoconf generated ./configure script to
21 set up install paths (via config.mak.autogen), so you can write instead
22
3900145 Jakub Narębski autoconf: Add configure target to main Makefile
jnareb authored
23 $ make configure ;# as yourself
5566771 Jakub Narębski autoconf: Use autoconf to write installation directories to config.mak.a...
jnareb authored
24 $ ./configure --prefix=/usr ;# as yourself
25 $ make all doc ;# as yourself
414851a separate build targets for man and html documentation
Michael J Gruber authored
26 # make install install-doc install-html;# as root
5566771 Jakub Narębski autoconf: Use autoconf to write installation directories to config.mak.a...
jnareb authored
27
3900100 Add explanation of the profile feedback build to the README
Andi Kleen authored
28 If you're willing to trade off (much) longer build time for a later
29 faster git you can also do a profile feedback build with
30
f2d713f Theodore Ts'o Fix build problems related to profile-directed optimization
tytso authored
31 $ make prefix=/usr PROFILE=BUILD all
32 # make prefix=/usr PROFILE=BUILD install
3900100 Add explanation of the profile feedback build to the README
Andi Kleen authored
33
34 This will run the complete test suite as training workload and then
35 rebuild git with the generated profile feedback. This results in a git
36 which is a few percent faster on CPU intensive workloads. This
37 may be a good tradeoff for distribution packagers.
38
f2d713f Theodore Ts'o Fix build problems related to profile-directed optimization
tytso authored
39 Or if you just want to install a profile-optimized version of git into
40 your home directory, you could run:
41
42 $ make PROFILE=BUILD install
43
44 As a caveat: a profile-optimized build takes a *lot* longer since the
45 git tree must be built twice, and in order for the profiling
46 measurements to work properly, ccache must be disabled and the test
47 suite has to be run using only a single CPU. In addition, the profile
48 feedback build stage currently generates a lot of additional compiler
49 warnings.
5566771 Jakub Narębski autoconf: Use autoconf to write installation directories to config.mak.a...
jnareb authored
50
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
51 Issues of note:
52
a958d8e Junio C Hamano Tone down warning about GNU Interactive Tools
authored
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
25032cc Abhijit Menon-Sen Fix typos in INSTALL
amenonsen authored
59 NOTE: When compiled with backward compatibility option, the GNU
a958d8e Junio C Hamano Tone down warning about GNU Interactive Tools
authored
60 Interactive Tools package still can install "git", but you can build it
61 with --disable-transition option to avoid this.
62a64d1 INSTALL: add a note about GNU interactive tools has been renamed
Miklos Vajna authored
62
9045801 INSTALL: document a simpler way to run uninstalled builds
Matthew Ogilvie authored
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:
3c767a0 INSTALL: a tip for running after building but without installing.
Junio C Hamano authored
74
75 GIT_EXEC_PATH=`pwd`
76 PATH=`pwd`:$PATH
f7661ce Remove -fPIC which was only needed for Git.xs
Junio C Hamano authored
77 GITPERLLIB=`pwd`/perl/blib/lib
6fcca93 Use $GITPERLLIB instead of $RUNNING_GIT_TESTS and centralize @INC mungin...
Petr Baudis authored
78 export GIT_EXEC_PATH PATH GITPERLLIB
3c767a0 INSTALL: a tip for running after building but without installing.
Junio C Hamano authored
79
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
80 - Git is reasonably self-sufficient, but does depend on a few external
5beb577 Brian Gernhardt INSTALL: Describe dependency knobs from Makefile
Benabik authored
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.
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
84
85 - "zlib", the compression library. Git won't build without it.
86
26d9443 Brian Gernhardt INSTALL: Reorder dependencies, split shell and Perl
Benabik authored
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
d48b284 Ævar Arnfjörð Bjarmason perl: bump the required Perl version to 5.8 from 5.6.[21]
avar authored
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
634a5f2 Junio C Hamano INSTALL: warn about recent Fedora breakage
authored
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.
26d9443 Brian Gernhardt INSTALL: Reorder dependencies, split shell and Perl
Benabik authored
100
5beb577 Brian Gernhardt INSTALL: Describe dependency knobs from Makefile
Benabik authored
101 - "openssl" library is used by git-imap-send to use IMAP over SSL.
102 If you don't need it, use NO_OPENSSL.
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
103
5beb577 Brian Gernhardt INSTALL: Describe dependency knobs from Makefile
Benabik authored
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).
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
108
5beb577 Brian Gernhardt INSTALL: Describe dependency knobs from Makefile
Benabik authored
109 - "libcurl" library is used by git-http-fetch and git-fetch. You
1d53f90 Johan Herland The "curl" executable is no longer required
jherland authored
110 might also want the "curl" executable for debugging purposes.
5beb577 Brian Gernhardt INSTALL: Describe dependency knobs from Makefile
Benabik authored
111 If you do not use http:// or https:// repositories, you do not
112 have to have them (use NO_CURL).
c538d2d Add some installation notes in INSTALL
Linus Torvalds authored
113
5beb577 Brian Gernhardt INSTALL: Describe dependency knobs from Makefile
Benabik authored
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).
3402f1d Document expat dependency when using http-push.
Junio C Hamano authored
117
5beb577 Brian Gernhardt INSTALL: Describe dependency knobs from Makefile
Benabik authored
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.
663a5ed Horst H. von Brand [PATCH] There are several undocumented dependencies
vonbrand authored
121
5e9637c Ævar Arnfjörð Bjarmason i18n: add infrastructure for translating Git with gettext
avar authored
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
b6f9305 git-p4: move to toplevel
Pete Wyckoff authored
134 - Python version 2.6 or later is needed to use the git-p4
135 interface to Perforce.
136
3cab359 INSTALL: duplicate python requirements from Makefile
Junio C Hamano authored
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.
cd8c458 [PATCH] Document config.mak in INSTALL.
Jason Riedy authored
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.
eff351c J. Bruce Fields Mention install-doc in INSTALL
bfields authored
145
a90918e Junio C Hamano INSTALL: explain how to build documentation
authored
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
98e79f6 INSTALL: explain info installation and dependencies.
David Kastrup authored
149 ("make all") does _not_ build them.
150
414851a separate build targets for man and html documentation
Michael J Gruber authored
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
98e79f6 INSTALL: explain info installation and dependencies.
David Kastrup authored
160 Building and installing the info file additionally requires
161 makeinfo and docbook2X. Version 0.8.3 is known to work.
162
a325a1a Add support for a pdf version of the user manual
Miklos Vajna authored
163 Building and installing the pdf file additionally requires
b2478aa Jeff King INSTALL: update asciidoc recommendation
peff authored
164 dblatex. Version >= 0.2.7 is known to work.
a325a1a Add support for a pdf version of the user manual
Miklos Vajna authored
165
b2478aa Jeff King INSTALL: update asciidoc recommendation
peff authored
166 All formats require at least asciidoc 8.4.1.
a90918e Junio C Hamano INSTALL: explain how to build documentation
authored
167
b1a46b7 Markus Heidelberg Makefile: add install-man rules (quick and normal)
marcows authored
168 There are also "make quick-install-doc", "make quick-install-man"
169 and "make quick-install-html" which install preformatted man pages
fcbebfd Junio C Hamano docs: Update install-doc-quick
authored
170 and html documentation. To use these build targets, you need to
171 clone two separate git-htmldocs and git-manpages repositories next
172 to the clone of git itself.
6fe570d allow installation of man and html doc from the man and html branches
Michael J Gruber authored
173
2ec39ed Junio C Hamano INSTALL: add warning on docbook-xsl 1.72 and 1.73
authored
174 It has been reported that docbook-xsl version 1.72 and 1.73 are
175 buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
176 the patch in contrib/patches/docbook-xsl-manpages-charmap.patch
0edf06d Jon Seymour INSTALL: configure /etc/xml/catalog to build docs on Cygwin
jonseymour authored
177
178 Users attempting to build the documentation on Cygwin may need to ensure
179 that the /etc/xml/catalog file looks something like this:
180
181 <?xml version="1.0"?>
182 <!DOCTYPE catalog PUBLIC
183 "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
184 "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"
185 >
186 <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
187 <rewriteURI
188 uriStartString = "http://docbook.sourceforge.net/release/xsl/current"
189 rewritePrefix = "/usr/share/sgml/docbook/xsl-stylesheets"
190 />
191 <rewriteURI
192 uriStartString="http://www.oasis-open.org/docbook/xml/4.5"
193 rewritePrefix="/usr/share/sgml/docbook/xml-dtd-4.5"
194 />
195 </catalog>
196
197 This can be achieved with the following two xmlcatalog commands:
198
199 xmlcatalog --noout \
200 --add rewriteURI \
201 http://docbook.sourceforge.net/release/xsl/current \
202 /usr/share/sgml/docbook/xsl-stylesheets \
203 /etc/xml/catalog
204
205 xmlcatalog --noout \
206 --add rewriteURI \
207 http://www.oasis-open.org/docbook/xml/4.5/xsl/current \
208 /usr/share/sgml/docbook/xml-dtd-4.5 \
209 /etc/xml/catalog
Something went wrong with that request. Please try again.