From c1bdacf97e3f51ac5c239a16e300e0986a5da53d Mon Sep 17 00:00:00 2001 From: David Greaves Date: Tue, 10 May 2005 22:32:38 +0100 Subject: [PATCH] [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 --- Documentation/git-check-files.txt | 4 +- Documentation/git-commit-tree.txt | 9 ++- Documentation/git-diff-tree-helper.txt | 4 +- Documentation/git-init-db.txt | 3 + Documentation/git-ls-files.txt | 4 +- Documentation/git-mktag.txt | 23 ++++++- Documentation/git-read-tree.txt | 6 +- Documentation/git.txt | 95 +++++++++++++++++++++++--- 8 files changed, 128 insertions(+), 20 deletions(-) diff --git a/Documentation/git-check-files.txt b/Documentation/git-check-files.txt index c56f22f92..614609802 100644 --- a/Documentation/git-check-files.txt +++ b/Documentation/git-check-files.txt @@ -31,7 +31,9 @@ preparing to update file not uptodate in cache:: Exits with a status code indicating success if all files are up-to-date. -see also: link:git-update-cache.html[git-update-cache] +See Also +-------- +link:git-update-cache.html[git-update-cache] Author diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index 5552050ac..c0dc1f46c 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] +Diagnostics +----------- +You don't exist. Go away!:: + The passwd(5) gecos field couldn't be read + +See Also +-------- +link:git-write-tree.html[git-write-tree] Author diff --git a/Documentation/git-diff-tree-helper.txt b/Documentation/git-diff-tree-helper.txt index d44858df5..58f27172a 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 . -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] Author diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt index febc8c811..99f96f7d4 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 2face87ae..14ca69531 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 +-------- +link:read-cache.html[read-cache] Author diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt index 320f5a1ef..708f4ef8d 100644 --- a/Documentation/git-mktag.txt +++ b/Documentation/git-mktag.txt @@ -9,12 +9,29 @@ git-mktag - Creates a tag object SYNOPSIS -------- -'git-mktag' +'git-mktag' < signature_file DESCRIPTION ----------- -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 identifier. + +Tag Format +---------- +A tag signature file has a very simple fixed format: three lines of + + object + type + tag + +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) Author diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index df2e36775..cbde13dba 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION ----------- Reads the tree information given by 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: git-checkout-cache) 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] Author diff --git a/Documentation/git.txt b/Documentation/git.txt index 66b68b89d..a02ed6f42 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 can also use the following symbolic notation: + +HEAD:: + 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/`) +:: + a valid head 'name'+ + (ie the contents of `$GIT_DIR/refs/heads/`) +:: + a valid snapshot 'name'+ + (ie the contents of `$GIT_DIR/refs/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/ + +Higher level SCMs may provide and manage additional information in the +GIT_DIR. + Terminology ----------- Each line contains terms used interchangeably @@ -210,17 +248,52 @@ Environment Variables --------------------- Various git commands use the following environment variables: -- 'GIT_AUTHOR_NAME' -- 'GIT_AUTHOR_EMAIL' -- 'GIT_AUTHOR_DATE' -- 'GIT_COMMITTER_NAME' -- 'GIT_COMMITTER_EMAIL' -- 'GIT_DIFF_OPTS' -- 'GIT_EXTERNAL_DIFF' -- 'GIT_INDEX_FILE' -- 'GIT_OBJECT_DIRECTORY' -- 'GIT_ALTERNATE_OBJECT_DIRECTORIES' - +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 + +'GIT_INDEX_FILE':: + This environment allows the specification of an alternate + cache/index file. If not specified, the default of + `$GIT_DIR/index` is used. + +'GIT_OBJECT_DIRECTORY':: + 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. + +'GIT_ALTERNATE_OBJECT_DIRECTORIES':: + 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. + +'GIT_DIR':: + 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 +~~~~~~~~~~~ +'GIT_AUTHOR_NAME':: +'GIT_AUTHOR_EMAIL':: +'GIT_AUTHOR_DATE':: +'GIT_COMMITTER_NAME':: +'GIT_COMMITTER_EMAIL':: + see link:git-commit-tree.html[git-commit-tree] + +git Diffs +~~~~~~~~~ +GIT_DIFF_OPTS:: +GIT_EXTERNAL_DIFF:: + 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] Author ------ -- 2.26.2