[thirdparty/git.git] / INSTALL


		Git installation

Normally you can just do "make" followed by "make install", and that
will install the git programs in your own ~/bin/ directory.  If you want
to do a global install, you can do

	$ make prefix=/usr all doc ;# as yourself
	# make prefix=/usr install install-doc ;# as root

(or prefix=/usr/local, of course).  Just like any program suite
that uses $prefix, the built results have some paths encoded,
which are derived from $prefix, so "make all; make prefix=/usr
install" would not work.

Alternatively you can use autoconf generated ./configure script to
set up install paths (via config.mak.autogen), so you can write instead

	$ make configure ;# as yourself
	$ ./configure --prefix=/usr ;# as yourself
	$ make all doc ;# as yourself
	# make install install-doc ;# as root


Issues of note:

 - git normally installs a helper script wrapper called "git", which
   conflicts with a similarly named "GNU interactive tools" program.

   Tough.  Either don't use the wrapper script, or delete the old GNU
   interactive tools.  None of the core git stuff needs the wrapper,
   it's just a convenient shorthand and while it is documented in some
   places, you can always replace "git commit" with "git-commit"
   instead.

   But let's face it, most of us don't have GNU interactive tools, and
   even if we had it, we wouldn't know what it does.  I don't think it
   has been actively developed since 1997, and people have moved over to
   graphical file managers.

 - You can use git after building but without installing if you
   wanted to.  Various git commands need to find other git
   commands and scripts to do their work, so you would need to
   arrange a few environment variables to tell them that their
   friends will be found in your built source area instead of at
   their standard installation area.  Something like this works
   for me:

	GIT_EXEC_PATH=`pwd`
	PATH=`pwd`:$PATH
	GITPERLLIB=`pwd`/perl/blib/lib
	export GIT_EXEC_PATH PATH GITPERLLIB

 - Git is reasonably self-sufficient, but does depend on a few external
   programs and libraries:

	- "zlib", the compression library. Git won't build without it.

	- "openssl".  Unless you specify otherwise, you'll get the SHA1
	  library from here.

	  If you don't have openssl, you can use one of the SHA1 libraries
	  that come with git (git includes the one from Mozilla, and has
	  its own PowerPC and ARM optimized ones too - see the Makefile).

	- "libcurl" and "curl" executable.  git-http-fetch and
	  git-fetch use them.  If you do not use http
	  transfer, you are probably OK if you do not have
	  them.

	- expat library; git-http-push uses it for remote lock
	  management over DAV.  Similar to "curl" above, this is optional.

        - "wish", the Tcl/Tk windowing shell is used in gitk to show the
          history graphically, and in git-gui.

	- "ssh" is used to push and pull over the net

	- "perl" and POSIX-compliant shells are needed to use most of
	  the barebone Porcelainish scripts.

 - Some platform specific issues are dealt with Makefile rules,
   but depending on your specific installation, you may not
   have all the libraries/tools needed, or you may have
   necessary libraries at unusual locations.  Please look at the
   top of the Makefile to see what can be adjusted for your needs.
   You can place local settings in config.mak and the Makefile
   will include them.  Note that config.mak is not distributed;
   the name is reserved for local settings.

 - To build and install documentation suite, you need to have
   the asciidoc/xmlto toolchain.  Because not many people are
   inclined to install the tools, the default build target
   ("make all") does _not_ build them.  The documentation is
   written for AsciiDoc 7, but "make ASCIIDOC8=YesPlease doc"
   will let you format with AsciiDoc 8.

   Alternatively, pre-formatted documentation are available in
   "html" and "man" branches of the git repository itself.  For
   example, you could:

	$ mkdir manual && cd manual
	$ git init
	$ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html |
	  while read a b
	  do
	    echo $a >.git/$b
	  done
	$ cp .git/refs/heads/man .git/refs/heads/master
	$ git checkout

   to checkout the pre-built man pages.  Also in this repository:

	$ git checkout html

   would instead give you a copy of what you see at:

	http://www.kernel.org/pub/software/scm/git/docs/
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
eff351c9 BF	8	$ make prefix=/usr all doc ;# as yourself
eff351c9 BF	9	# make prefix=/usr install install-doc ;# 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
	22	# make install install-doc ;# as root
	23
	24
c538d2d3 LT	25	Issues of note:
	26
	27	- git normally installs a helper script wrapper called "git", which
	28	conflicts with a similarly named "GNU interactive tools" program.
	29
	30	Tough. Either don't use the wrapper script, or delete the old GNU
	31	interactive tools. None of the core git stuff needs the wrapper,
	32	it's just a convenient shorthand and while it is documented in some
215a7ad1	33	places, you can always replace "git commit" with "git-commit"
a6080a0a	34	instead.
c538d2d3 LT	35
	36	But let's face it, most of us don't have GNU interactive tools, and
	37	even if we had it, we wouldn't know what it does. I don't think it
	38	has been actively developed since 1997, and people have moved over to
	39	graphical file managers.
	40
3c767a08 JH	41	- You can use git after building but without installing if you
	42	wanted to. Various git commands need to find other git
	43	commands and scripts to do their work, so you would need to
	44	arrange a few environment variables to tell them that their
	45	friends will be found in your built source area instead of at
	46	their standard installation area. Something like this works
	47	for me:
	48
	49	GIT_EXEC_PATH=`pwd`
	50	PATH=`pwd`:$PATH
f7661ce0	51	GITPERLLIB=`pwd`/perl/blib/lib
6fcca938	52	export GIT_EXEC_PATH PATH GITPERLLIB
3c767a08	53
c538d2d3 LT	54	- Git is reasonably self-sufficient, but does depend on a few external
	55	programs and libraries:
	56
	57	- "zlib", the compression library. Git won't build without it.
	58
726f9bce JH	59	- "openssl". Unless you specify otherwise, you'll get the SHA1
726f9bce JH	60	library from here.
c538d2d3 LT	61
	62	If you don't have openssl, you can use one of the SHA1 libraries
	63	that come with git (git includes the one from Mozilla, and has
765ac8ec	64	its own PowerPC and ARM optimized ones too - see the Makefile).
c538d2d3	65
215a7ad1 JH	66	- "libcurl" and "curl" executable. git-http-fetch and
215a7ad1 JH	67	git-fetch use them. If you do not use http
addf88e4	68	transfer, you are probably OK if you do not have
99cff830	69	them.
c538d2d3	70
3402f1d6 JH	71	- expat library; git-http-push uses it for remote lock
	72	management over DAV. Similar to "curl" above, this is optional.
	73
addf88e4	74	- "wish", the Tcl/Tk windowing shell is used in gitk to show the
726f9bce	75	history graphically, and in git-gui.
663a5ed5 HB	76
663a5ed5 HB	77	- "ssh" is used to push and pull over the net
3cab3594 JH	78
	79	- "perl" and POSIX-compliant shells are needed to use most of
	80	the barebone Porcelainish scripts.
	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
	94	("make all") does _not_ build them. The documentation is
	95	written for AsciiDoc 7, but "make ASCIIDOC8=YesPlease doc"
	96	will let you format with AsciiDoc 8.
	97
	98	Alternatively, pre-formatted documentation are available in
	99	"html" and "man" branches of the git repository itself. For
	100	example, you could:
eff351c9 BF	101
eff351c9 BF	102	$ mkdir manual && cd manual
5c94f87e	103	$ git init
efc7fa53	104	$ git fetch-pack git://git.kernel.org/pub/scm/git/git.git man html \|
eff351c9 BF	105	while read a b
	106	do
	107	echo $a >.git/$b
	108	done
	109	$ cp .git/refs/heads/man .git/refs/heads/master
	110	$ git checkout
	111
	112	to checkout the pre-built man pages. Also in this repository:
	113
	114	$ git checkout html
	115
	116	would instead give you a copy of what you see at:
	117
	118	http://www.kernel.org/pub/software/scm/git/docs/