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