Code

[PATCH] apply: match documentation, usage string and code.
[git.git] / Documentation / git.txt
index 134afffe3f669f5806a03793f1d703895b022e0f..cff5f795bca6620e498b853964e864325fbf4b2b 100644 (file)
@@ -1,6 +1,6 @@
-git(1)
+git(7)
 ======
-v0.1, May 2005
+May 2005
 
 NAME
 ----
@@ -16,9 +16,10 @@ DESCRIPTION
 
 This is reference information for the core git commands.
 
-The link:README[] contains much useful definition and clarification
-info - read that first.  And of the commands, I suggest reading
-'git-update-cache' and 'git-read-tree' first - I wish I had!
+The Discussion section below contains much useful definition and
+clarification info - read that first.  And of the commands, I suggest
+reading link:git-update-cache.html[git-update-cache] and
+link:git-read-tree.html[git-read-tree] first - I wish I had!
 
 David Greaves <david@dgreaves.com>
 08/05/05
@@ -59,8 +60,8 @@ link:git-read-tree.html[git-read-tree]::
 link:git-update-cache.html[git-update-cache]::
        Modifies the index or directory cache
 
-link:git-write-blob.html[git-write-blob]::
-       Creates a blob from a file
+link:git-hash-object.html[git-hash-object]::
+       Computes the object ID from a file.
 
 link:git-write-tree.html[git-write-tree]::
        Creates a tree from the current cache
@@ -109,6 +110,9 @@ link:git-tar-tree.html[git-tar-tree]::
 link:git-unpack-file.html[git-unpack-file]::
        Creates a temporary file with a blob's contents
 
+link:git-verify-pack.html[git-verify-pack]::
+       Validates packed GIT archive files
+
 The interrogate commands may create files - and you can force them to
 touch the working file set - but in general they don't
 
@@ -123,6 +127,13 @@ link:git-apply-patch-script.html[git-apply-patch-script]::
 link:git-convert-cache.html[git-convert-cache]::
        Converts old-style GIT repository
 
+link:git-clone-script.html[git-clone-script]::
+       Clones a repository into the current repository (user interface)
+
+link:git-clone-pack.html[git-clone-pack]::
+       Clones a repository into the current repository (engine
+       for ssh and local transport)
+
 link:git-http-pull.html[git-http-pull]::
        Downloads a remote GIT repository via HTTP
 
@@ -144,7 +155,7 @@ link:git-resolve-script.html[git-resolve-script]::
 link:git-tag-script.html[git-tag-script]::
        An example script to create a tag object signed with GPG
 
-link:git-rpull.html[git-rpull]::
+link:git-ssh-pull.html[git-ssh-pull]::
        Pulls from a remote repository over ssh connection
 
 Interogators:
@@ -152,19 +163,15 @@ Interogators:
 link:git-diff-helper.html[git-diff-helper]::
        Generates patch format output for git-diff-*
 
-link:git-rpush.html[git-rpush]::
-       Helper "server-side" program used by git-rpull
+link:git-ssh-push.html[git-ssh-push]::
+       Helper "server-side" program used by git-ssh-pull
 
 
 
-Terminology
------------
-see README for description
-
-Identifier terminology
+Identifier Terminology
 ----------------------
 <object>::
-       Indicates any object sha1 identifier
+       Indicates the sha1 identifier for any type of object
 
 <blob>::
        Indicates a blob object sha1 identifier
@@ -176,11 +183,10 @@ Identifier terminology
        Indicates a commit object sha1 identifier
 
 <tree-ish>::
-       Indicates a tree, commit or tag object sha1 identifier.
-       A command that takes a <tree-ish> argument ultimately
-       wants to operate on a <tree> object but automatically
-       dereferences <commit> and <tag> that points at a
-       <tree>.
+       Indicates a tree, commit or tag object sha1 identifier.  A
+       command that takes a <tree-ish> argument ultimately wants to
+       operate on a <tree> object but automatically dereferences
+       <commit> and <tag> objects that point at a <tree>.
 
 <type>::
        Indicates that an object type is required.
@@ -192,10 +198,12 @@ Identifier terminology
 
 Symbolic Identifiers
 --------------------
-Any git comand accepting any <object> can also use the following symbolic notation:
+Any git comand accepting any <object> can also use the following
+symbolic notation:
 
 HEAD::
-       indicates the head of the repository (ie the contents of `$GIT_DIR/HEAD`)
+       indicates the head of the repository (ie the contents of
+       `$GIT_DIR/HEAD`)
 <tag>::
        a valid tag 'name'+
        (ie the contents of `$GIT_DIR/refs/tags/<tag>`)
@@ -230,18 +238,12 @@ GIT_DIR.
 
 Terminology
 -----------
-Each line contains terms used interchangeably
+Each line contains terms which you may see used interchangeably
 
  object database, .git directory
  directory cache, index
  id, sha1, sha1-id, sha1 hash
  type, tag
- blob, blob object
- tree, tree object
- commit, commit object
- parent
- root object
- changeset
 
 
 Environment Variables
@@ -295,9 +297,13 @@ git Diffs
        link:git-diff-files.html[git-diff-files];
        link:git-diff-tree.html[git-diff-tree]
 
+Discussion
+----------
+include::../README[]
+
 Author
 ------
-Written by Linus Torvalds <torvalds@osdl.org>
+Written by Linus Torvalds <torvalds@osdl.org> and the git-list <git@vger.kernel.org>.
 
 Documentation
 --------------