path: root/Documentation
diff options
authorDavid Greaves <>2005-05-10 21:32:38 (GMT)
committerJunio C Hamano <>2005-05-10 22:01:23 (GMT)
commitc1bdacf97e3f51ac5c239a16e300e0986a5da53d (patch)
tree86dd1a9c76ebf41a4e12c0514b99039052fe5e62 /Documentation
parent204ee6a91ba35740d6417cf64bde4d117d40b07d (diff)
[PATCH 3/4] split core-git.txt and update
Update git environment variable docs Update first section of command docs (Manipulation commands section) Signed-off-by: David Greaves <>
Diffstat (limited to 'Documentation')
8 files changed, 128 insertions, 20 deletions
diff --git a/Documentation/git-check-files.txt b/Documentation/git-check-files.txt
index c56f22f..6146098 100644
--- a/Documentation/git-check-files.txt
+++ b/Documentation/git-check-files.txt
@@ -31,7 +31,9 @@ preparing to update file <file> not uptodate in cache::
Exits with a status code indicating success if all files are
-see also: link:git-update-cache.html[git-update-cache]
+See Also
diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
index 5552050..c0dc1f4 100644
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -64,7 +64,14 @@ A commit comment is read from stdin (max 999 chars). If a changelog
entry is not provided via '<' redirection, "git-commit-tree" will just wait
for one to be entered and terminated with ^D
-see also: link:git-write-tree.html[git-write-tree]
+You don't exist. Go away!::
+ The passwd(5) gecos field couldn't be read
+See Also
diff --git a/Documentation/git-diff-tree-helper.txt b/Documentation/git-diff-tree-helper.txt
index d44858d..58f2717 100644
--- a/Documentation/git-diff-tree-helper.txt
+++ b/Documentation/git-diff-tree-helper.txt
@@ -30,7 +30,9 @@ OPTIONS
would show a diff to bring the working file back to what is in the <tree>.
-See also the section on generating patches in link:git-diff-cache.html[git-diff-cache]
+See Also
+The section on generating patches in link:git-diff-cache.html[git-diff-cache]
diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
index febc8c8..99f96f7 100644
--- a/Documentation/git-init-db.txt
+++ b/Documentation/git-init-db.txt
@@ -16,6 +16,9 @@ DESCRIPTION
This simply creates an empty git object database - basically a `.git`
directory and `.git/object/??/` directories.
+If the 'GIT_DIR' environment variable is set then it specifies a path
+to use instead of `./.git` for the base of the repository.
If the object storage directory is specified via the 'GIT_OBJECT_DIRECTORY'
environment variable then the sha1 directories are created underneath -
otherwise the default `.git/objects` directory is used.
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 2face87..14ca695 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -83,7 +83,9 @@ the dircache records up to three such pairs; one from tree O in stage
the user (or Cogito) to see what should eventually be recorded at the
path. (see read-cache for more information on state)
-see also: link:read-cache.html[read-cache]
+See Also
diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt
index 320f5a1..708f4ef 100644
--- a/Documentation/git-mktag.txt
+++ b/Documentation/git-mktag.txt
@@ -9,12 +9,29 @@ git-mktag - Creates a tag object
+'git-mktag' < signature_file
-Reads a tag contents from its standard input and creates a tag object.
-The input must be a well formed tag object.
+Reads a tag contents on standard input and creates a tag object
+that can also be used to sign other objects.
+The output is the new tag's <object> identifier.
+Tag Format
+A tag signature file has a very simple fixed format: three lines of
+ object <sha1>
+ type <typename>
+ tag <tagname>
+followed by some 'optional' free-form signature that git itself
+doesn't care about, but that can be verified with gpg or similar.
+The size of the full object is artificially limited to 8kB. (Just
+because I'm a lazy bastard, and if you can't fit a signature in that
+size, you're doing something wrong)
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index df2e367..cbde13d 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -14,7 +14,7 @@ SYNOPSIS
Reads the tree information given by <tree> into the directory cache,
-but does not actually _update_ any of the files it "caches". (see:
+but does not actually *update* any of the files it "caches". (see:
Optionally, it can merge a tree into the cache or perform a 3-way
@@ -133,7 +133,9 @@ the index file, which is a temporary thing anyway. There is no need to
worry about what is in the working directory, since it is never shown
and never used.
-see also: link:git-write-tree.html[git-write-tree], link:git-ls-files.html[git-ls-files]
+See Also
+link:git-write-tree.html[git-write-tree]; link:git-ls-files.html[git-ls-files]
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 66b68b8..a02ed6f 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -190,6 +190,44 @@ Identifier terminology
Indicates a filename - always relative to the root of
the tree structure GIT_INDEX_FILE describes.
+Symbolic Identifiers
+Any git comand accepting any <object> can also use the following symbolic notation:
+ indicates the head of the repository (ie the contents of `$GIT_DIR/HEAD`)
+ a valid tag 'name'+
+ (ie the contents of `$GIT_DIR/refs/tags/<tag>`)
+ a valid head 'name'+
+ (ie the contents of `$GIT_DIR/refs/heads/<head>`)
+ a valid snapshot 'name'+
+ (ie the contents of `$GIT_DIR/refs/snap/<snap>`)
+File/Directory Structure
+The git-core manipulates the following areas in the directory:
+ .git/ The base (overridden with $GIT_DIR)
+ objects/ The object base (overridden with $GIT_OBJECT_DIRECTORY)
+ ??/ 'First 2 chars of object' directories
+It can interrogate (but never updates) the following areas:
+ refs/ Directories containing symbolic names for objects
+ (each file contains the hex SHA1 + newline)
+ heads/ Commits which are heads of various sorts
+ tags/ Tags, by the tag name (or some local renaming of it)
+ snap/ ????
+ ... Everything else isn't shared
+ HEAD Symlink to refs/heads/<something>
+Higher level SCMs may provide and manage additional information in the
Each line contains terms used interchangeably
@@ -210,17 +248,52 @@ Environment Variables
Various git commands use the following environment variables:
+The git Repository
+These environment variables apply to 'all' core git commands. Nb: it
+is worth noting that they may be used/overridden by SCMS sitting above
+git so take care if using Cogito etc
+ This environment allows the specification of an alternate
+ cache/index file. If not specified, the default of
+ `$GIT_DIR/index` is used.
+ If the object storage directory is specified via this
+ environment variable then the sha1 directories are created
+ underneath - otherwise the default `$GIT_DIR/objects`
+ directory is used.
+ Due to the immutable nature of git objects, old objects can be
+ archived into shared, read-only directories. This variable
+ specifies a ":" seperated list of git object directories which
+ can be used to search for git objects. New objects will not be
+ written to these directories.
+ If the 'GIT_DIR' environment variable is set then it specifies
+ a path to use instead of `./.git` for the base of the
+ repository.
+git Commits
+ see link:git-commit-tree.html[git-commit-tree]
+git Diffs
+ see the "generating patches" section in :
+ link:git-diff-cache.html[git-diff-cache];
+ link:git-diff-files.html[git-diff-files];
+ link:git-diff-tree.html[git-diff-tree]