]>
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 | |
55667714 JN |
16 | Alternatively you can use autoconf generated ./configure script to |
17 | set up install paths (via config.mak.autogen), so you can write instead | |
18 | ||
3900145e | 19 | $ make configure ;# as yourself |
55667714 JN |
20 | $ ./configure --prefix=/usr ;# as yourself |
21 | $ make all doc ;# as yourself | |
414851a4 | 22 | # make install install-doc install-html;# as root |
55667714 JN |
23 | |
24 | ||
c538d2d3 LT |
25 | Issues of note: |
26 | ||
a958d8ed JH |
27 | - Ancient versions of GNU Interactive Tools (pre-4.9.2) installed a |
28 | program "git", whose name conflicts with this program. But with | |
29 | version 4.9.2, after long hiatus without active maintenance (since | |
30 | around 1997), it changed its name to gnuit and the name conflict is no | |
31 | longer a problem. | |
32 | ||
25032ccd | 33 | NOTE: When compiled with backward compatibility option, the GNU |
a958d8ed JH |
34 | Interactive Tools package still can install "git", but you can build it |
35 | with --disable-transition option to avoid this. | |
62a64d1a | 36 | |
3c767a08 JH |
37 | - You can use git after building but without installing if you |
38 | wanted to. Various git commands need to find other git | |
39 | commands and scripts to do their work, so you would need to | |
40 | arrange a few environment variables to tell them that their | |
41 | friends will be found in your built source area instead of at | |
42 | their standard installation area. Something like this works | |
43 | for me: | |
44 | ||
45 | GIT_EXEC_PATH=`pwd` | |
46 | PATH=`pwd`:$PATH | |
f7661ce0 | 47 | GITPERLLIB=`pwd`/perl/blib/lib |
6fcca938 | 48 | export GIT_EXEC_PATH PATH GITPERLLIB |
3c767a08 | 49 | |
c538d2d3 LT |
50 | - Git is reasonably self-sufficient, but does depend on a few external |
51 | programs and libraries: | |
52 | ||
53 | - "zlib", the compression library. Git won't build without it. | |
54 | ||
26d94439 BG |
55 | - "ssh" is used to push and pull over the net. |
56 | ||
57 | - A POSIX-compliant shell is required to run many scripts needed | |
58 | for everyday use (e.g. "bisect", "pull"). | |
59 | ||
60 | - "Perl" is needed to use some of the features (e.g. preparing a | |
61 | partial commit using "git add -i/-p", interacting with svn | |
62 | repositories with "git svn"). | |
63 | ||
726f9bce JH |
64 | - "openssl". Unless you specify otherwise, you'll get the SHA1 |
65 | library from here. | |
c538d2d3 LT |
66 | |
67 | If you don't have openssl, you can use one of the SHA1 libraries | |
3de8ba02 BG |
68 | that come with git (git includes one inspired by Mozilla's and a |
69 | PowerPC optimized one too - see the Makefile). | |
c538d2d3 | 70 | |
1d53f90e JH |
71 | - libcurl library; git-http-fetch and git-fetch use them. You |
72 | might also want the "curl" executable for debugging purposes. | |
73 | If you do not use http transfer, you are probably OK if you | |
74 | do not have them. | |
c538d2d3 | 75 | |
3402f1d6 JH |
76 | - expat library; git-http-push uses it for remote lock |
77 | management over DAV. Similar to "curl" above, this is optional. | |
78 | ||
addf88e4 | 79 | - "wish", the Tcl/Tk windowing shell is used in gitk to show the |
726f9bce | 80 | history graphically, and in git-gui. |
663a5ed5 | 81 | |
3cab3594 JH |
82 | - Some platform specific issues are dealt with Makefile rules, |
83 | but depending on your specific installation, you may not | |
84 | have all the libraries/tools needed, or you may have | |
85 | necessary libraries at unusual locations. Please look at the | |
86 | top of the Makefile to see what can be adjusted for your needs. | |
cd8c4589 JR |
87 | You can place local settings in config.mak and the Makefile |
88 | will include them. Note that config.mak is not distributed; | |
89 | the name is reserved for local settings. | |
eff351c9 | 90 | |
a90918e8 JH |
91 | - To build and install documentation suite, you need to have |
92 | the asciidoc/xmlto toolchain. Because not many people are | |
93 | inclined to install the tools, the default build target | |
98e79f63 DK |
94 | ("make all") does _not_ build them. |
95 | ||
414851a4 MG |
96 | "make doc" builds documentation in man and html formats; there are |
97 | also "make man", "make html" and "make info". Note that "make html" | |
98 | requires asciidoc, but not xmlto. "make man" (and thus make doc) | |
99 | requires both. | |
100 | ||
101 | "make install-doc" installs documentation in man format only; there | |
102 | are also "make install-man", "make install-html" and "make | |
103 | install-info". | |
104 | ||
98e79f63 DK |
105 | Building and installing the info file additionally requires |
106 | makeinfo and docbook2X. Version 0.8.3 is known to work. | |
107 | ||
a325a1a7 MV |
108 | Building and installing the pdf file additionally requires |
109 | dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work. | |
110 | ||
98e79f63 DK |
111 | The documentation is written for AsciiDoc 7, but "make |
112 | ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8. | |
a90918e8 | 113 | |
414851a4 | 114 | Alternatively, pre-formatted documentation is available in |
a90918e8 JH |
115 | "html" and "man" branches of the git repository itself. For |
116 | example, you could: | |
eff351c9 BF |
117 | |
118 | $ mkdir manual && cd manual | |
5c94f87e | 119 | $ git init |
efc7fa53 | 120 | $ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html | |
eff351c9 BF |
121 | while read a b |
122 | do | |
123 | echo $a >.git/$b | |
124 | done | |
125 | $ cp .git/refs/heads/man .git/refs/heads/master | |
126 | $ git checkout | |
127 | ||
128 | to checkout the pre-built man pages. Also in this repository: | |
129 | ||
130 | $ git checkout html | |
131 | ||
132 | would instead give you a copy of what you see at: | |
133 | ||
134 | http://www.kernel.org/pub/software/scm/git/docs/ | |
2ec39eda | 135 | |
b1a46b70 MH |
136 | There are also "make quick-install-doc", "make quick-install-man" |
137 | and "make quick-install-html" which install preformatted man pages | |
138 | and html documentation. | |
6fe570de MG |
139 | This does not require asciidoc/xmlto, but it only works from within |
140 | a cloned checkout of git.git with these two extra branches, and will | |
141 | not work for the maintainer for obvious chicken-and-egg reasons. | |
142 | ||
2ec39eda JH |
143 | It has been reported that docbook-xsl version 1.72 and 1.73 are |
144 | buggy; 1.72 misformats manual pages for callouts, and 1.73 needs | |
145 | the patch in contrib/patches/docbook-xsl-manpages-charmap.patch |