]>
Commit | Line | Data |
---|---|---|
c538d2d3 LT |
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 | ||
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 |
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. | |
c538d2d3 | 15 | |
5beb577d BG |
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 | ||
55667714 JN |
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 | ||
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 JN |
27 | |
28 | ||
c538d2d3 LT |
29 | Issues of note: |
30 | ||
a958d8ed JH |
31 | - Ancient versions of GNU Interactive Tools (pre-4.9.2) installed a |
32 | program "git", whose name conflicts with this program. But with | |
33 | version 4.9.2, after long hiatus without active maintenance (since | |
34 | around 1997), it changed its name to gnuit and the name conflict is no | |
35 | longer a problem. | |
36 | ||
25032ccd | 37 | NOTE: When compiled with backward compatibility option, the GNU |
a958d8ed JH |
38 | Interactive Tools package still can install "git", but you can build it |
39 | with --disable-transition option to avoid this. | |
62a64d1a | 40 | |
90458012 MO |
41 | - You can use git after building but without installing if you want |
42 | to test drive it. Simply run git found in bin-wrappers directory | |
43 | in the build directory, or prepend that directory to your $PATH. | |
44 | This however is less efficient than running an installed git, as | |
45 | you always need an extra fork+exec to run any git subcommand. | |
46 | ||
47 | It is still possible to use git without installing by setting a few | |
48 | environment variables, which was the way this was done | |
49 | traditionally. But using git found in bin-wrappers directory in | |
50 | the build directory is far simpler. As a historical reference, the | |
51 | old way went like this: | |
3c767a08 JH |
52 | |
53 | GIT_EXEC_PATH=`pwd` | |
54 | PATH=`pwd`:$PATH | |
f7661ce0 | 55 | GITPERLLIB=`pwd`/perl/blib/lib |
6fcca938 | 56 | export GIT_EXEC_PATH PATH GITPERLLIB |
3c767a08 | 57 | |
c538d2d3 | 58 | - Git is reasonably self-sufficient, but does depend on a few external |
5beb577d BG |
59 | programs and libraries. Git can be used without most of them by adding |
60 | the approriate "NO_<LIBRARY>=YesPlease" to the make command line or | |
61 | config.mak file. | |
c538d2d3 LT |
62 | |
63 | - "zlib", the compression library. Git won't build without it. | |
64 | ||
26d94439 BG |
65 | - "ssh" is used to push and pull over the net. |
66 | ||
67 | - A POSIX-compliant shell is required to run many scripts needed | |
68 | for everyday use (e.g. "bisect", "pull"). | |
69 | ||
d48b2841 ÆAB |
70 | - "Perl" version 5.8 or later is needed to use some of the |
71 | features (e.g. preparing a partial commit using "git add -i/-p", | |
72 | interacting with svn repositories with "git svn"). If you can | |
73 | live without these, use NO_PERL. | |
26d94439 | 74 | |
5beb577d BG |
75 | - "openssl" library is used by git-imap-send to use IMAP over SSL. |
76 | If you don't need it, use NO_OPENSSL. | |
c538d2d3 | 77 | |
5beb577d BG |
78 | By default, git uses OpenSSL for SHA1 but it will use it's own |
79 | library (inspired by Mozilla's) with either NO_OPENSSL or | |
80 | BLK_SHA1. Also included is a version optimized for PowerPC | |
81 | (PPC_SHA1). | |
c538d2d3 | 82 | |
5beb577d | 83 | - "libcurl" library is used by git-http-fetch and git-fetch. You |
1d53f90e | 84 | might also want the "curl" executable for debugging purposes. |
5beb577d BG |
85 | If you do not use http:// or https:// repositories, you do not |
86 | have to have them (use NO_CURL). | |
c538d2d3 | 87 | |
5beb577d BG |
88 | - "expat" library; git-http-push uses it for remote lock |
89 | management over DAV. Similar to "curl" above, this is optional | |
90 | (with NO_EXPAT). | |
3402f1d6 | 91 | |
5beb577d BG |
92 | - "wish", the Tcl/Tk windowing shell is used in gitk to show the |
93 | history graphically, and in git-gui. If you don't want gitk or | |
94 | git-gui, you can use NO_TCLTK. | |
663a5ed5 | 95 | |
3cab3594 JH |
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. | |
cd8c4589 JR |
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. | |
eff351c9 | 104 | |
a90918e8 JH |
105 | - To build and install documentation suite, you need to have |
106 | the asciidoc/xmlto toolchain. Because not many people are | |
107 | inclined to install the tools, the default build target | |
98e79f63 DK |
108 | ("make all") does _not_ build them. |
109 | ||
414851a4 MG |
110 | "make doc" builds documentation in man and html formats; there are |
111 | also "make man", "make html" and "make info". Note that "make html" | |
112 | requires asciidoc, but not xmlto. "make man" (and thus make doc) | |
113 | requires both. | |
114 | ||
115 | "make install-doc" installs documentation in man format only; there | |
116 | are also "make install-man", "make install-html" and "make | |
117 | install-info". | |
118 | ||
98e79f63 DK |
119 | Building and installing the info file additionally requires |
120 | makeinfo and docbook2X. Version 0.8.3 is known to work. | |
121 | ||
a325a1a7 MV |
122 | Building and installing the pdf file additionally requires |
123 | dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work. | |
124 | ||
79c461d5 JK |
125 | The documentation is written for AsciiDoc 7, but by default |
126 | uses some compatibility wrappers to work on AsciiDoc 8. If you have | |
127 | AsciiDoc 7, try "make ASCIIDOC7=YesPlease". | |
a90918e8 | 128 | |
414851a4 | 129 | Alternatively, pre-formatted documentation is available in |
a90918e8 JH |
130 | "html" and "man" branches of the git repository itself. For |
131 | example, you could: | |
eff351c9 BF |
132 | |
133 | $ mkdir manual && cd manual | |
5c94f87e | 134 | $ git init |
efc7fa53 | 135 | $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html | |
eff351c9 BF |
136 | while read a b |
137 | do | |
138 | echo $a >.git/$b | |
139 | done | |
140 | $ cp .git/refs/heads/man .git/refs/heads/master | |
141 | $ git checkout | |
142 | ||
143 | to checkout the pre-built man pages. Also in this repository: | |
144 | ||
145 | $ git checkout html | |
146 | ||
147 | would instead give you a copy of what you see at: | |
148 | ||
149 | http://www.kernel.org/pub/software/scm/git/docs/ | |
2ec39eda | 150 | |
b1a46b70 MH |
151 | There are also "make quick-install-doc", "make quick-install-man" |
152 | and "make quick-install-html" which install preformatted man pages | |
153 | and html documentation. | |
6fe570de MG |
154 | This does not require asciidoc/xmlto, but it only works from within |
155 | a cloned checkout of git.git with these two extra branches, and will | |
156 | not work for the maintainer for obvious chicken-and-egg reasons. | |
157 | ||
2ec39eda JH |
158 | It has been reported that docbook-xsl version 1.72 and 1.73 are |
159 | buggy; 1.72 misformats manual pages for callouts, and 1.73 needs | |
160 | the patch in contrib/patches/docbook-xsl-manpages-charmap.patch | |
0edf06dc JS |
161 | |
162 | Users attempting to build the documentation on Cygwin may need to ensure | |
163 | that the /etc/xml/catalog file looks something like this: | |
164 | ||
165 | <?xml version="1.0"?> | |
166 | <!DOCTYPE catalog PUBLIC | |
167 | "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" | |
168 | "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd" | |
169 | > | |
170 | <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> | |
171 | <rewriteURI | |
172 | uriStartString = "http://docbook.sourceforge.net/release/xsl/current" | |
173 | rewritePrefix = "/usr/share/sgml/docbook/xsl-stylesheets" | |
174 | /> | |
175 | <rewriteURI | |
176 | uriStartString="http://www.oasis-open.org/docbook/xml/4.5" | |
177 | rewritePrefix="/usr/share/sgml/docbook/xml-dtd-4.5" | |
178 | /> | |
179 | </catalog> | |
180 | ||
181 | This can be achieved with the following two xmlcatalog commands: | |
182 | ||
183 | xmlcatalog --noout \ | |
184 | --add rewriteURI \ | |
185 | http://docbook.sourceforge.net/release/xsl/current \ | |
186 | /usr/share/sgml/docbook/xsl-stylesheets \ | |
187 | /etc/xml/catalog | |
188 | ||
189 | xmlcatalog --noout \ | |
190 | --add rewriteURI \ | |
191 | http://www.oasis-open.org/docbook/xml/4.5/xsl/current \ | |
192 | /usr/share/sgml/docbook/xml-dtd-4.5 \ | |
193 | /etc/xml/catalog |