THIS IS A TEST INSTANCE ONLY! REPOSITORIES CAN BE DELETED AT ANY TIME!

Git Source Code Mirror - This is a publish-only repository and all pull requests are ignored. Please follow Documentation/SubmittingPatches procedure for any of your improvements.
git
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

245 lines
10.0KB

  1. Git installation
  2. Normally you can just do "make" followed by "make install", and that
  3. will install the git programs in your own ~/bin/ directory. If you want
  4. to do a global install, you can do
  5. $ make prefix=/usr all doc info ;# as yourself
  6. # make prefix=/usr install install-doc install-html install-info ;# as root
  7. (or prefix=/usr/local, of course). Just like any program suite
  8. that uses $prefix, the built results have some paths encoded,
  9. which are derived from $prefix, so "make all; make prefix=/usr
  10. install" would not work.
  11. The beginning of the Makefile documents many variables that affect the way
  12. git is built. You can override them either from the command line, or in a
  13. config.mak file.
  14. Alternatively you can use autoconf generated ./configure script to
  15. set up install paths (via config.mak.autogen), so you can write instead
  16. $ make configure ;# as yourself
  17. $ ./configure --prefix=/usr ;# as yourself
  18. $ make all doc ;# as yourself
  19. # make install install-doc install-html;# as root
  20. If you're willing to trade off (much) longer build time for a later
  21. faster git you can also do a profile feedback build with
  22. $ make prefix=/usr profile
  23. # make prefix=/usr PROFILE=BUILD install
  24. This will run the complete test suite as training workload and then
  25. rebuild git with the generated profile feedback. This results in a git
  26. which is a few percent faster on CPU intensive workloads. This
  27. may be a good tradeoff for distribution packagers.
  28. Alternatively you can run profile feedback only with the git benchmark
  29. suite. This runs significantly faster than the full test suite, but
  30. has less coverage:
  31. $ make prefix=/usr profile-fast
  32. # make prefix=/usr PROFILE=BUILD install
  33. Or if you just want to install a profile-optimized version of git into
  34. your home directory, you could run:
  35. $ make profile-install
  36. or
  37. $ make profile-fast-install
  38. As a caveat: a profile-optimized build takes a *lot* longer since the
  39. git tree must be built twice, and in order for the profiling
  40. measurements to work properly, ccache must be disabled and the test
  41. suite has to be run using only a single CPU. In addition, the profile
  42. feedback build stage currently generates a lot of additional compiler
  43. warnings.
  44. Issues of note:
  45. - Ancient versions of GNU Interactive Tools (pre-4.9.2) installed a
  46. program "git", whose name conflicts with this program. But with
  47. version 4.9.2, after long hiatus without active maintenance (since
  48. around 1997), it changed its name to gnuit and the name conflict is no
  49. longer a problem.
  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. - You can use git after building but without installing if you want
  54. to test drive it. Simply run git found in bin-wrappers directory
  55. in the build directory, or prepend that directory to your $PATH.
  56. This however is less efficient than running an installed git, as
  57. you always need an extra fork+exec to run any git subcommand.
  58. It is still possible to use git without installing by setting a few
  59. environment variables, which was the way this was done
  60. traditionally. But using git found in bin-wrappers directory in
  61. the build directory is far simpler. As a historical reference, the
  62. old way went like this:
  63. GIT_EXEC_PATH=`pwd`
  64. PATH=`pwd`:$PATH
  65. GITPERLLIB=`pwd`/perl/build/lib
  66. export GIT_EXEC_PATH PATH GITPERLLIB
  67. - By default (unless NO_PERL is provided) Git will ship various perl
  68. scripts. However, for simplicity it doesn't use the
  69. ExtUtils::MakeMaker toolchain to decide where to place the perl
  70. libraries. Depending on the system this can result in the perl
  71. libraries not being where you'd like them if they're expected to be
  72. used by things other than Git itself.
  73. Manually supplying a perllibdir prefix should fix this, if this is
  74. a problem you care about, e.g.:
  75. prefix=/usr perllibdir=/usr/$(/usr/bin/perl -MConfig -wle 'print substr $Config{installsitelib}, 1 + length $Config{siteprefixexp}')
  76. Will result in e.g. perllibdir=/usr/share/perl/5.26.1 on Debian,
  77. perllibdir=/usr/share/perl5 (which we'd use by default) on CentOS.
  78. - Unless NO_PERL is provided Git will ship various perl libraries it
  79. needs. Distributors of Git will usually want to set
  80. NO_PERL_CPAN_FALLBACKS if NO_PERL is not provided to use their own
  81. copies of the CPAN modules Git needs.
  82. - Git is reasonably self-sufficient, but does depend on a few external
  83. programs and libraries. Git can be used without most of them by adding
  84. the approriate "NO_<LIBRARY>=YesPlease" to the make command line or
  85. config.mak file.
  86. - "zlib", the compression library. Git won't build without it.
  87. - "ssh" is used to push and pull over the net.
  88. - A POSIX-compliant shell is required to run many scripts needed
  89. for everyday use (e.g. "bisect", "pull").
  90. - "Perl" version 5.8 or later is needed to use some of the
  91. features (e.g. preparing a partial commit using "git add -i/-p",
  92. interacting with svn repositories with "git svn"). If you can
  93. live without these, use NO_PERL. Note that recent releases of
  94. Redhat/Fedora are reported to ship Perl binary package with some
  95. core modules stripped away (see http://lwn.net/Articles/477234/),
  96. so you might need to install additional packages other than Perl
  97. itself, e.g. Digest::MD5, File::Spec, File::Temp, Net::Domain,
  98. Net::SMTP, and Time::HiRes.
  99. - git-imap-send needs the OpenSSL library to talk IMAP over SSL if
  100. you are using libcurl older than 7.34.0. Otherwise you can use
  101. NO_OPENSSL without losing git-imap-send.
  102. By default, git uses OpenSSL for SHA1 but it will use its own
  103. library (inspired by Mozilla's) with either NO_OPENSSL or
  104. BLK_SHA1. Also included is a version optimized for PowerPC
  105. (PPC_SHA1).
  106. - "libcurl" library is used by git-http-fetch, git-fetch, and, if
  107. the curl version >= 7.34.0, for git-imap-send. You might also
  108. want the "curl" executable for debugging purposes. If you do not
  109. use http:// or https:// repositories, and do not want to put
  110. patches into an IMAP mailbox, you do not have to have them
  111. (use NO_CURL).
  112. - "expat" library; git-http-push uses it for remote lock
  113. management over DAV. Similar to "curl" above, this is optional
  114. (with NO_EXPAT).
  115. - "wish", the Tcl/Tk windowing shell is used in gitk to show the
  116. history graphically, and in git-gui. If you don't want gitk or
  117. git-gui, you can use NO_TCLTK.
  118. - A gettext library is used by default for localizing Git. The
  119. primary target is GNU libintl, but the Solaris gettext
  120. implementation also works.
  121. We need a gettext.h on the system for C code, gettext.sh (or
  122. Solaris gettext(1)) for shell scripts, and libintl-perl for Perl
  123. programs.
  124. Set NO_GETTEXT to disable localization support and make Git only
  125. use English. Under autoconf the configure script will do this
  126. automatically if it can't find libintl on the system.
  127. - Python version 2.4 or later (but not 3.x, which is not
  128. supported by Perforce) is needed to use the git-p4 interface
  129. to Perforce.
  130. - Some platform specific issues are dealt with Makefile rules,
  131. but depending on your specific installation, you may not
  132. have all the libraries/tools needed, or you may have
  133. necessary libraries at unusual locations. Please look at the
  134. top of the Makefile to see what can be adjusted for your needs.
  135. You can place local settings in config.mak and the Makefile
  136. will include them. Note that config.mak is not distributed;
  137. the name is reserved for local settings.
  138. - To build and install documentation suite, you need to have
  139. the asciidoc/xmlto toolchain. Because not many people are
  140. inclined to install the tools, the default build target
  141. ("make all") does _not_ build them.
  142. "make doc" builds documentation in man and html formats; there are
  143. also "make man", "make html" and "make info". Note that "make html"
  144. requires asciidoc, but not xmlto. "make man" (and thus make doc)
  145. requires both.
  146. "make install-doc" installs documentation in man format only; there
  147. are also "make install-man", "make install-html" and "make
  148. install-info".
  149. Building and installing the info file additionally requires
  150. makeinfo and docbook2X. Version 0.8.3 is known to work.
  151. Building and installing the pdf file additionally requires
  152. dblatex. Version >= 0.2.7 is known to work.
  153. All formats require at least asciidoc 8.4.1.
  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. It has been reported that docbook-xsl version 1.72 and 1.73 are
  160. buggy; 1.72 misformats manual pages for callouts, and 1.73 needs
  161. the patch in contrib/patches/docbook-xsl-manpages-charmap.patch
  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. <?xml version="1.0"?>
  165. <!DOCTYPE catalog PUBLIC
  166. "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN"
  167. "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"
  168. >
  169. <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
  170. <rewriteURI
  171. uriStartString = "http://docbook.sourceforge.net/release/xsl/current"
  172. rewritePrefix = "/usr/share/sgml/docbook/xsl-stylesheets"
  173. />
  174. <rewriteURI
  175. uriStartString="http://www.oasis-open.org/docbook/xml/4.5"
  176. rewritePrefix="/usr/share/sgml/docbook/xml-dtd-4.5"
  177. />
  178. </catalog>
  179. This can be achieved with the following two xmlcatalog commands:
  180. xmlcatalog --noout \
  181. --add rewriteURI \
  182. http://docbook.sourceforge.net/release/xsl/current \
  183. /usr/share/sgml/docbook/xsl-stylesheets \
  184. /etc/xml/catalog
  185. xmlcatalog --noout \
  186. --add rewriteURI \
  187. http://www.oasis-open.org/docbook/xml/4.5/xsl/current \
  188. /usr/share/sgml/docbook/xml-dtd-4.5 \
  189. /etc/xml/catalog