Use a hashtable for objects instead of a sorted list

[git.git] / Documentation / git.txt

diff --git a/Documentation/git.txt b/Documentation/git.txt
index fc11516..2d0ca9d 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -33,32 +33,41 @@ OPTIONS
        environment variable. If no path is given 'git' will print
        the current setting and then exit.
 
        environment variable. If no path is given 'git' will print
        the current setting and then exit.
 

-CORE GIT COMMANDS
------------------
-Before reading this cover to cover, you may want to take a look
-at the link:tutorial.html[tutorial] document.

 
 

-The <<Discussion>> section below contains much useful definition
-and clarification info - read that first.  After that, if you
-are interested in using git to manage (version control)
-projects, read on commands listed in Porcelain-ish commands
-section next.  On the other hand, if you are writing your own
-Porcelain, I suggest reading gitlink:git-update-index[1] and
-gitlink:git-read-tree[1] first.
+NOT LEARNING CORE GIT COMMANDS
+------------------------------
+
+This manual is intended to give complete background information
+and internal workings of git, which may be too much for most
+people.  The <<Discussion>> section below contains much useful
+definition and clarification - read that first.
+
+If you are interested in using git to manage (version control)
+projects, use link:tutorial.html[The Tutorial] to get you started,
+and then link:everyday.html[Everyday GIT] as a guide to the
+minimum set of commands you need to know for day-to-day work.
+Most likely, that will get you started, and you can go a long
+way without knowing the low level details too much.

 
 

-If you are migrating from CVS, link:cvs-migration.html[cvs migration]
-document may be helpful after you finish the tutorial.
+The link:core-tutorial.html[Core tutorial] document covers how things
+internally work.
+
+If you are migrating from CVS, link:cvs-migration.html[cvs
+migration] document may be helpful after you finish the
+tutorial.

 
 After you get the general feel from the tutorial and this
 overview page, you may want to take a look at the
 link:howto-index.html[howto] documents.
 
 
 
 After you get the general feel from the tutorial and this
 overview page, you may want to take a look at the
 link:howto-index.html[howto] documents.
 
 

-David Greaves <david@dgreaves.com>
-08/05/05
+CORE GIT COMMANDS
+-----------------
+
+If you are writing your own Porcelain, you need to be familiar
+with most of the low level commands --- I suggest starting from
+gitlink:git-update-index[1] and gitlink:git-read-tree[1].

 
 

-Updated by Junio C Hamano <junkio@cox.net> on 2005-05-05 and
-further on 2005-12-07 to reflect recent changes.

 
 Commands Overview
 -----------------
 
 Commands Overview
 -----------------


@@ -131,6 +140,9 @@ Interrogation commands
 gitlink:git-cat-file[1]::
        Provide content or type/size information for repository objects.
 
 gitlink:git-cat-file[1]::
        Provide content or type/size information for repository objects.
 

+gitlink:git-describe[1]::
+       Show the most recent tag that is reachable from a commit.
+

 gitlink:git-diff-index[1]::
        Compares content and mode of blobs between the index and repository.
 
 gitlink:git-diff-index[1]::
        Compares content and mode of blobs between the index and repository.
 


@@ -158,6 +170,9 @@ gitlink:git-merge-base[1]::
 gitlink:git-name-rev[1]::
        Find symbolic names for given revs.
 
 gitlink:git-name-rev[1]::
        Find symbolic names for given revs.
 

+gitlink:git-pack-redundant[1]::
+       Find redundant pack files.
+

 gitlink:git-rev-list[1]::
        Lists commit objects in reverse chronological order.
 
 gitlink:git-rev-list[1]::
        Lists commit objects in reverse chronological order.
 


@@ -210,6 +225,9 @@ gitlink:git-receive-pack[1]::
 gitlink:git-send-pack[1]::
        Pushes to a remote repository, intelligently.
 
 gitlink:git-send-pack[1]::
        Pushes to a remote repository, intelligently.
 

+gitlink:git-http-push[1]::
+       Push missing objects using HTTP/DAV.
+

 gitlink:git-shell[1]::
        Restricted shell for GIT-only SSH access.
 
 gitlink:git-shell[1]::
        Restricted shell for GIT-only SSH access.
 


@@ -283,9 +301,6 @@ gitlink:git-merge[1]::
 gitlink:git-mv[1]::
        Move or rename a file, a directory, or a symlink.
 
 gitlink:git-mv[1]::
        Move or rename a file, a directory, or a symlink.
 

-gitlink:git-octopus[1]::
-       Merge more than two commits.
-

 gitlink:git-pull[1]::
        Fetch from and merge with a remote repository.
 
 gitlink:git-pull[1]::
        Fetch from and merge with a remote repository.
 


@@ -298,6 +313,9 @@ gitlink:git-rebase[1]::
 gitlink:git-repack[1]::
        Pack unpacked objects in a repository.
 
 gitlink:git-repack[1]::
        Pack unpacked objects in a repository.
 

+gitlink:git-rerere[1]::
+       Reuse recorded resolution of conflicted merges.
+

 gitlink:git-reset[1]::
        Reset current HEAD to the specified state.
 
 gitlink:git-reset[1]::
        Reset current HEAD to the specified state.
 


@@ -339,6 +357,9 @@ gitlink:git-convert-objects[1]::
 gitlink:git-cvsimport[1]::
        Salvage your data out of another SCM people love to hate.
 
 gitlink:git-cvsimport[1]::
        Salvage your data out of another SCM people love to hate.
 

+gitlink:git-cvsexportcommit[1]::
+       Export a single commit to a CVS checkout.
+

 gitlink:git-lost-found[1]::
        Recover lost refs that luckily have not yet been pruned.
 
 gitlink:git-lost-found[1]::
        Recover lost refs that luckily have not yet been pruned.
 


@@ -408,7 +429,7 @@ gitlink:git-rev-parse[1]::
 gitlink:git-send-email[1]::
        Send patch e-mails out of "format-patch --mbox" output.
 
 gitlink:git-send-email[1]::
        Send patch e-mails out of "format-patch --mbox" output.
 

-gitlink:git-symbolic-refs[1]::
+gitlink:git-symbolic-ref[1]::

        Read and modify symbolic refs.
 
 gitlink:git-stripspace[1]::
        Read and modify symbolic refs.
 
 gitlink:git-stripspace[1]::


@@ -568,18 +589,20 @@ git Diffs
 
 Discussion[[Discussion]]
 ------------------------
 
 Discussion[[Discussion]]
 ------------------------

-include::../README[]
+include::README[]

 
 Authors
 -------
 
 Authors
 -------

-       git's founding father is Linus Torvalds <torvalds@osdl.org>.
-       The current git nurse is Junio C Hamano <junkio@cox.net>.
-       The git potty was written by Andres Ericsson <ae@op5.se>.
-       General upbringing is handled by the git-list <git@vger.kernel.org>.
+* git's founding father is Linus Torvalds <torvalds@osdl.org>.
+* The current git nurse is Junio C Hamano <junkio@cox.net>.
+* The git potty was written by Andres Ericsson <ae@op5.se>.
+* General upbringing is handled by the git-list <git@vger.kernel.org>.

 
 Documentation
 --------------
 
 Documentation
 --------------

-Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+The documentation for git suite was started by David Greaves
+<david@dgreaves.com>, and later enhanced greatly by the
+contributors on the git-list <git@vger.kernel.org>.

 
 GIT
 ---
 
 GIT
 ---