git-tar-tree: no more void pointer arithmetic

[git.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 6e336d7..63af8ec 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,10 +5,13 @@ 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
 
 will install the git programs in your own ~/bin/ directory.  If you want
 to do a global install, you can do
 

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

 
 

-(or prefix=/usr/local, of course).  Some day somebody may send me a RPM
-spec file or something, and you can do "make rpm" or whatever.
+(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.

 
 Issues of note:
 
 
 Issues of note:
 


@@ -37,15 +40,16 @@ Issues of note:
 
          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
 
          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-optimized one too - see the Makefile), and you
-         can avoid the bignum support by excising git-rev-list support
-         for "--merge-order" (by hand).
+         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 probabaly OK if you do not have
          them.
 
 
        - "libcurl" and "curl" executable.  git-http-fetch and
          git-fetch use them.  If you do not use http
          transfer, you are probabaly 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.
+

        - "GNU diff" to generate patches.  Of course, you don't _have_ to
          generate patches if you don't want to, but let's face it, you'll
          be wanting to. Or why did you get git in the first place?
        - "GNU diff" to generate patches.  Of course, you don't _have_ to
          generate patches if you don't want to, but let's face it, you'll
          be wanting to. Or why did you get git in the first place?


@@ -69,3 +73,42 @@ Issues of note:
           history graphically
 
        - "ssh" is used to push and pull over the net
           history graphically
 
        - "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.
+
+       - "python" 2.3 or more recent; if you have 2.3, you may need
+          to build with "make WITH_OWN_SUBPROCESS_PY=YesPlease".
+
+ - 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.  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-db
+       $ git clone-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/
+