{"thread":{"id":"560","subject":"[PATCH 3/4] split core-git.txt and update","startedAt":"2005-05-10T21:32:38Z","lastAt":"2005-05-10T21:32:38Z","messageCount":1,"participants":["David Greaves"],"isPatch":true,"patchVersion":1,"patchTotal":4},"messages":[{"id":"2993","messageId":"E1DVcLG-0004g5-Ax@ash.dgreaves.com","threadId":"560","inReplyTo":null,"subject":"[PATCH 3/4] split core-git.txt and update","fromName":"David Greaves","fromEmail":"david@dgreaves.com","sentAt":"2005-05-10T21:32:38Z","receivedAt":"2005-05-10T21:32:38Z","isPatch":true,"sender":{"key":"david@dgreaves.com","avatar":"https://gravatar.com/avatar/ca67bad50999edcdd137c9a65da2381557d175bea99ae956afdabc5785e42b79?d=mp&s=160"},"body":"Update git environment variable docs\nUpdate first section of command docs (Manipulation commands section)\n\nSigned-off-by: David Greaves <david@dgreaves.com>\n\n---\ncommit 6cec96ce19223f1852a12632ad44007822e2a3de\ntree 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c\nparent ce5e04ff2f337c625ab070315b4f4f9d309f635e\nauthor David Greaves <david@dgreaves.com> Tue, 10 May 2005 22:19:50 +0100\ncommitter David Greaves <david@dgreaves.com> Tue, 10 May 2005 22:19:50 +0100\n\n Documentation/git-check-files.txt      |    4 +\n Documentation/git-commit-tree.txt      |    9 ++-\n Documentation/git-diff-tree-helper.txt |    4 +\n Documentation/git-init-db.txt          |    3 +\n Documentation/git-ls-files.txt         |    4 +\n Documentation/git-mktag.txt            |   23 ++++++-\n Documentation/git-read-tree.txt        |    6 +-\n Documentation/git.txt                  |   95 +++++++++++++++++++++++++++++----\n 8 files changed, 128 insertions(+), 20 deletions(-)\n\nIndex: Documentation/git-check-files.txt\n===================================================================\n--- 879e10daf0b047f9457cf6ba1d4183bbe1ba370c/Documentation/git-check-files.txt  (mode:100644)\n+++ 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c/Documentation/git-check-files.txt  (mode:100644)\n@@ -31,7 +31,9 @@\n Exits with a status code indicating success if all files are\n up-to-date.\n \n-see also: link:git-update-cache.html[git-update-cache]\n+See Also\n+--------\n+link:git-update-cache.html[git-update-cache]\n \n \n Author\nIndex: Documentation/git-commit-tree.txt\n===================================================================\n--- 879e10daf0b047f9457cf6ba1d4183bbe1ba370c/Documentation/git-commit-tree.txt  (mode:100644)\n+++ 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c/Documentation/git-commit-tree.txt  (mode:100644)\n@@ -64,7 +64,14 @@\n entry is not provided via '<' redirection, \"git-commit-tree\" will just wait\n for one to be entered and terminated with ^D\n \n-see also: link:git-write-tree.html[git-write-tree]\n+Diagnostics\n+-----------\n+You don't exist. Go away!::\n+    The passwd(5) gecos field couldn't be read\n+\n+See Also\n+--------\n+link:git-write-tree.html[git-write-tree]\n \n \n Author\nIndex: Documentation/git-diff-tree-helper.txt\n===================================================================\n--- 879e10daf0b047f9457cf6ba1d4183bbe1ba370c/Documentation/git-diff-tree-helper.txt  (mode:100644)\n+++ 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c/Documentation/git-diff-tree-helper.txt  (mode:100644)\n@@ -30,7 +30,9 @@\n +\n would show a diff to bring the working file back to what is in the <tree>.\n \n-See also the section on generating patches in link:git-diff-cache.html[git-diff-cache]\n+See Also\n+--------\n+The section on generating patches in link:git-diff-cache.html[git-diff-cache]\n \n \n Author\nIndex: Documentation/git-init-db.txt\n===================================================================\n--- 879e10daf0b047f9457cf6ba1d4183bbe1ba370c/Documentation/git-init-db.txt  (mode:100644)\n+++ 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c/Documentation/git-init-db.txt  (mode:100644)\n@@ -16,6 +16,9 @@\n This simply creates an empty git object database - basically a `.git`\n directory and `.git/object/??/` directories.\n \n+If the 'GIT_DIR' environment variable is set then it specifies a path\n+to use instead of `./.git` for the base of the repository.\n+\n If the object storage directory is specified via the 'GIT_OBJECT_DIRECTORY'\n environment variable then the sha1 directories are created underneath -\n otherwise the default `.git/objects` directory is used.\nIndex: Documentation/git-ls-files.txt\n===================================================================\n--- 879e10daf0b047f9457cf6ba1d4183bbe1ba370c/Documentation/git-ls-files.txt  (mode:100644)\n+++ 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c/Documentation/git-ls-files.txt  (mode:100644)\n@@ -83,7 +83,9 @@\n the user (or Cogito) to see what should eventually be recorded at the\n path. (see read-cache for more information on state)\n \n-see also: link:read-cache.html[read-cache]\n+See Also\n+--------\n+link:read-cache.html[read-cache]\n \n \n Author\nIndex: Documentation/git-mktag.txt\n===================================================================\n--- 879e10daf0b047f9457cf6ba1d4183bbe1ba370c/Documentation/git-mktag.txt  (mode:100644)\n+++ 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c/Documentation/git-mktag.txt  (mode:100644)\n@@ -9,12 +9,29 @@\n \n SYNOPSIS\n --------\n-'git-mktag'\n+'git-mktag' < signature_file\n \n DESCRIPTION\n -----------\n-Reads a tag contents from its standard input and creates a tag object.\n-The input must be a well formed tag object.\n+Reads a tag contents on standard input and creates a tag object\n+that can also be used to sign other objects.\n+\n+The output is the new tag's <object> identifier.\n+\n+Tag Format\n+----------\n+A tag signature file has a very simple fixed format: three lines of\n+\n+  object <sha1>\n+  type <typename>\n+  tag <tagname>\n+\n+followed by some 'optional' free-form signature that git itself\n+doesn't care about, but that can be verified with gpg or similar.\n+\n+The size of the full object is artificially limited to 8kB.  (Just\n+because I'm a lazy bastard, and if you can't fit a signature in that\n+size, you're doing something wrong)\n \n \n Author\nIndex: Documentation/git-read-tree.txt\n===================================================================\n--- 879e10daf0b047f9457cf6ba1d4183bbe1ba370c/Documentation/git-read-tree.txt  (mode:100644)\n+++ 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c/Documentation/git-read-tree.txt  (mode:100644)\n@@ -14,7 +14,7 @@\n DESCRIPTION\n -----------\n Reads the tree information given by <tree> into the directory cache,\n-but does not actually _update_ any of the files it \"caches\". (see:\n+but does not actually *update* any of the files it \"caches\". (see:\n git-checkout-cache)\n \n Optionally, it can merge a tree into the cache or perform a 3-way\n@@ -133,7 +133,9 @@\n worry about what is in the working directory, since it is never shown\n and never used.\n \n-see also: link:git-write-tree.html[git-write-tree], link:git-ls-files.html[git-ls-files]\n+See Also\n+--------\n+link:git-write-tree.html[git-write-tree]; link:git-ls-files.html[git-ls-files]\n \n \n Author\nIndex: Documentation/git.txt\n===================================================================\n--- 879e10daf0b047f9457cf6ba1d4183bbe1ba370c/Documentation/git.txt  (mode:100644)\n+++ 0b343ac5a1a6f8d6a4cb796c523ef84bf7e7254c/Documentation/git.txt  (mode:100644)\n@@ -190,6 +190,44 @@\n \tIndicates a filename - always relative to the root of\n \tthe tree structure GIT_INDEX_FILE describes.\n \n+Symbolic Identifiers\n+--------------------\n+Any git comand accepting any <object> can also use the following symbolic notation:\n+\n+HEAD::\n+\tindicates the head of the repository (ie the contents of `$GIT_DIR/HEAD`)\n+<tag>::\n+\ta valid tag 'name'+\n+\t(ie the contents of `$GIT_DIR/refs/tags/<tag>`)\n+<head>::\n+\ta valid head 'name'+\n+\t(ie the contents of `$GIT_DIR/refs/heads/<head>`)\n+<snap>::\n+\ta valid snapshot 'name'+\n+\t(ie the contents of `$GIT_DIR/refs/snap/<snap>`)\n+\n+\n+File/Directory Structure\n+------------------------\n+The git-core manipulates the following areas in the directory:\n+\n+ .git/\t       The base (overridden with $GIT_DIR)\n+   objects/    The object base (overridden with $GIT_OBJECT_DIRECTORY)\n+     ??/       'First 2 chars of object' directories\n+\n+It can interrogate (but never updates) the following areas:\n+\n+   refs/       Directories containing symbolic names for objects\n+\t       (each file contains the hex SHA1 + newline)\n+     heads/    Commits which are heads of various sorts\n+     tags/     Tags, by the tag name (or some local renaming of it)\n+     snap/     ????\n+   ...         Everything else isn't shared\n+   HEAD        Symlink to refs/heads/<something>\n+\n+Higher level SCMs may provide and manage additional information in the\n+GIT_DIR.\n+\n Terminology\n -----------\n Each line contains terms used interchangeably\n@@ -210,17 +248,52 @@\n ---------------------\n Various git commands use the following environment variables:\n \n-- 'GIT_AUTHOR_NAME'\n-- 'GIT_AUTHOR_EMAIL'\n-- 'GIT_AUTHOR_DATE'\n-- 'GIT_COMMITTER_NAME'\n-- 'GIT_COMMITTER_EMAIL'\n-- 'GIT_DIFF_OPTS'\n-- 'GIT_EXTERNAL_DIFF'\n-- 'GIT_INDEX_FILE'\n-- 'GIT_OBJECT_DIRECTORY'\n-- 'GIT_ALTERNATE_OBJECT_DIRECTORIES'\n-\n+The git Repository\n+~~~~~~~~~~~~~~~~~~\n+These environment variables apply to 'all' core git commands. Nb: it\n+is worth noting that they may be used/overridden by SCMS sitting above\n+git so take care if using Cogito etc\n+\n+'GIT_INDEX_FILE'::\n+\tThis environment allows the specification of an alternate\n+\tcache/index file. If not specified, the default of\n+\t`$GIT_DIR/index` is used.\n+\n+'GIT_OBJECT_DIRECTORY'::\n+\tIf the object storage directory is specified via this\n+\tenvironment variable then the sha1 directories are created\n+\tunderneath - otherwise the default `$GIT_DIR/objects`\n+\tdirectory is used.\n+\n+'GIT_ALTERNATE_OBJECT_DIRECTORIES'::\n+\tDue to the immutable nature of git objects, old objects can be\n+\tarchived into shared, read-only directories. This variable\n+\tspecifies a \":\" seperated list of git object directories which\n+\tcan be used to search for git objects. New objects will not be\n+\twritten to these directories.\n+\n+'GIT_DIR'::\n+\tIf the 'GIT_DIR' environment variable is set then it specifies\n+\ta path to use instead of `./.git` for the base of the\n+\trepository.\n+\n+git Commits\n+~~~~~~~~~~~\n+'GIT_AUTHOR_NAME'::\n+'GIT_AUTHOR_EMAIL'::\n+'GIT_AUTHOR_DATE'::\n+'GIT_COMMITTER_NAME'::\n+'GIT_COMMITTER_EMAIL'::\n+\tsee link:git-commit-tree.html[git-commit-tree]\n+\n+git Diffs\n+~~~~~~~~~\n+GIT_DIFF_OPTS::\n+GIT_EXTERNAL_DIFF::\n+\tsee the \"generating patches\" section in :\n+\tlink:git-diff-cache.html[git-diff-cache];\n+\tlink:git-diff-files.html[git-diff-files];\n+\tlink:git-diff-tree.html[git-diff-tree]\n \n Author\n ------\n\n\n\f\n!-------------------------------------------------------------flip-\n\n\n"}]}