{"thread":{"id":"1430","subject":"[PATCH] Assorted documentation patches","startedAt":"2005-08-05T15:05:02Z","lastAt":"2005-08-05T15:05:02Z","messageCount":1,"participants":["Johannes Schindelin"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"6853","messageId":"Pine.LNX.4.63.0508051702580.8507@wgmdd8.biozentrum.uni-wuerzburg.de","threadId":"1430","inReplyTo":null,"subject":"[PATCH] Assorted documentation patches","fromName":"Johannes Schindelin","fromEmail":"johannes.schindelin@gmx.de","sentAt":"2005-08-05T15:05:02Z","receivedAt":"2005-08-05T15:05:02Z","isPatch":true,"sender":{"key":"johannes.schindelin@gmx.de","avatar":"https://avatars.githubusercontent.com/u/127790?v=4"},"body":"Hi,\n\nwhile sifting through the documentation to find different namings for the \nsame concepts, I saw a few things here and there, which I fixed. Since the \nsifting was quite numbing, there might be some wrong \"fixes\".\n\nSorry, patch is attached, because I still can't convince my pine (version \n4.63) to send single space lines :-(\n\nCiao,\nDscho\n\n\ndiff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt\n--- a/Documentation/diff-format.txt\n+++ b/Documentation/diff-format.txt\n@@ -62,7 +62,7 @@ customization also applies to \"git-diff-\n 1. When the environment variable 'GIT_EXTERNAL_DIFF' is not set,\n    these commands internally invoke \"diff\" like this:\n \n-      diff -L a/<path> -L a/<path> -pu <old> <new>\n+      diff -L a/<path> -L b/<path> -pu <old> <new>\n +\n For added files, `/dev/null` is used for <old>.  For removed\n files, `/dev/null` is used for <new>\n@@ -101,7 +101,7 @@ For a path that is unmerged, 'GIT_EXTERN\n parameter, <path>.\n \n \n-Git specific extention to diff format\n+Git specific extension to diff format\n -------------------------------------\n \n What -p option produces is slightly different from the\ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -5,9 +5,9 @@\n \tSynonym for \"-p\".\n \n -r::\n-\tLook recursivelly in subdirectories; this flag does not\n+\tLook recursively in subdirectories; this flag does not\n \tmean anything to commands other than \"git-diff-tree\";\n-\tother commands always looks at all the subdirectories.\n+\tother diff commands always look at all the subdirectories.\n \n -z::\n \t\\0 line termination on output\ndiff --git a/Documentation/git-diff-cache.txt b/Documentation/git-diff-cache.txt\n--- a/Documentation/git-diff-cache.txt\n+++ b/Documentation/git-diff-cache.txt\n@@ -50,13 +50,13 @@ Cached Mode\n -----------\n If '--cached' is specified, it allows you to ask:\n \n-\tshow me the differences between HEAD and the current index\n+\tshow me the differences between HEAD and the current cache\n \tcontents (the ones I'd write with a \"git-write-tree\")\n \n-For example, let's say that you have worked on your index file, and are\n-ready to commit. You want to see eactly *what* you are going to commit is\n-without having to write a new tree object and compare it that way, and to\n-do that, you just do\n+For example, let's say that you have worked on your working directory, updated\n+some files in the cache and are ready to commit. You want to see eactly\n+*what* you are going to commit is without having to write a new tree\n+object and compare it that way, and to do that, you just do\n \n \tgit-diff-cache --cached $(cat .git/HEAD)\n \ndiff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt\n--- a/Documentation/git-diff-tree.txt\n+++ b/Documentation/git-diff-tree.txt\n@@ -86,7 +86,7 @@ Or if you are searching for what changed\n and it will ignore all differences to other files.\n \n The pattern is always the prefix, and is matched exactly.  There are no\n-wildcards.  Even stricter, it has to match complete path comonent.\n+wildcards.  Even stricter, it has to match a complete path component.\n I.e. \"foo\" does not pick up `foobar.h`.  \"foo\" does match `foo/bar.h`\n so it can be used to name subdirectories.\n \ndiff --git a/Documentation/git-fsck-cache.txt b/Documentation/git-fsck-cache.txt\n--- a/Documentation/git-fsck-cache.txt\n+++ b/Documentation/git-fsck-cache.txt\n@@ -39,17 +39,17 @@ OPTIONS\n \n --standalone::\n \tLimit checks to the contents of GIT_OBJECT_DIRECTORY\n-\t(.git/objects), making sure that it is consistent and\n+\t($GIT_DIR/objects), making sure that it is consistent and\n \tcomplete without referring to objects found in alternate\n \tobject pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES,\n-\tnor packed GIT archives found in .git/objects/pack;\n+\tnor packed GIT archives found in $GIT_DIR/objects/pack;\n \tcannot be used with --full.\n \n --full::\n \tCheck not just objects in GIT_OBJECT_DIRECTORY\n-\t(.git/objects), but also the ones found in alternate\n+\t($GIT_DIR/objects), but also the ones found in alternate\n \tobject pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES,\n-\tand in packed GIT archives found in .git/objects/pack\n+\tand in packed GIT archives found in $GIT_DIR/objects/pack\n \tand corresponding pack subdirectories in alternate\n \tobject pools; cannot be used with --standalone.\n \n@@ -69,11 +69,7 @@ that aren't readable from any of the spe\n \n So for example\n \n-\tgit-fsck-cache --unreachable $(cat .git/HEAD)\n-\n-or, for Cogito users:\n-\n-\tgit-fsck-cache --unreachable $(cat .git/refs/heads/*)\n+\tgit-fsck-cache --unreachable $(cat .git/HEAD .git/refs/heads/*)\n \n will do quite a _lot_ of verification on the tree. There are a few\n extra validity tests to be added (make sure that tree objects are\n@@ -122,18 +118,18 @@ sha1 mismatch <object>::\n \tThe database has an object who's sha1 doesn't match the\n \tdatabase value.\n \tThis indicates a serious data integrity problem.\n-\t(note: this error occured during early git development when\n-\tthe database format changed.)\n \n Environment Variables\n ---------------------\n \n GIT_OBJECT_DIRECTORY::\n-\tused to specify the object database root (usually .git/objects)\n+\tused to specify the object database root (usually $GIT_DIR/objects)\n \n GIT_INDEX_FILE::\n-\tused to specify the cache\n+\tused to specify the index file of the cache\n \n+GIT_ALTERNATE_OBJECT_DIRECTORIES:\n+\tused to specify additional object database roots (usually unset)\n \n Author\n ------\ndiff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt\n--- a/Documentation/git-hash-object.txt\n+++ b/Documentation/git-hash-object.txt\n@@ -21,6 +21,14 @@ This is used by \"git-cvsimport-script\" t\n without modifying files in the work tree.  When <type> is not\n specified, it defaults to \"blob\". \n \n+OPTIONS\n+-------\n+\n+-t <type>::\n+\tSpecify the type (default: \"blob\").\n+\n+-w::\n+\tActually write the object into the object database.\n \n Author\n ------\ndiff --git a/Documentation/git-http-pull.txt b/Documentation/git-http-pull.txt\n--- a/Documentation/git-http-pull.txt\n+++ b/Documentation/git-http-pull.txt\n@@ -23,8 +23,9 @@ Downloads a remote GIT repository via HT\n \tGet all the objects.\n -v::\n \tReport what is downloaded.\n--w::\n-        Writes the commit-id into the filename under $GIT_DIR/refs/ on\n+\n+-w <filename>::\n+        Writes the commit-id into the filename under $GIT_DIR/refs/<filename> on\n         the local end after the transfer is complete.\n \n Author\ndiff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt\n--- a/Documentation/git-init-db.txt\n+++ b/Documentation/git-init-db.txt\n@@ -4,7 +4,7 @@ v0.1, May 2005\n \n NAME\n ----\n-git-init-db - Creates an empty git object database\n+git-init-db - Creates an empty git repository\n \n \n SYNOPSIS\n@@ -13,15 +13,16 @@ SYNOPSIS\n \n DESCRIPTION\n -----------\n-This simply creates an empty git object database - basically a `.git`\n-directory and `.git/object/??/` directories.\n+This simply creates an empty git repository - basically a `.git` directory\n+and `.git/object/??/`, `.git/refs/heads` and `.git/refs/tags` directories,\n+and links `.git/HEAD` symbolically to `.git/refs/heads/master`.\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.\n+otherwise the default `$GIT_DIR/objects` directory is used.\n \n \"git-init-db\" won't hurt an existing repository.\n \ndiff --git a/Documentation/git-local-pull.txt b/Documentation/git-local-pull.txt\n--- a/Documentation/git-local-pull.txt\n+++ b/Documentation/git-local-pull.txt\n@@ -25,8 +25,9 @@ OPTIONS\n \tGet all the objects.\n -v::\n \tReport what is downloaded.\n--w::\n-        Writes the commit-id into the filename under $GIT_DIR/refs/ on\n+\n+-w <filename>::\n+        Writes the commit-id into the filename under $GIT_DIR/refs/<filename> on\n         the local end after the transfer is complete.\n \n Author\ndiff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt\n--- a/Documentation/git-ls-files.txt\n+++ b/Documentation/git-ls-files.txt\n@@ -87,7 +87,7 @@ detailed information on unmerged paths.\n For an unmerged path, instead of recording a single mode/SHA1 pair,\n the dircache records up to three such pairs; one from tree O in stage\n 1, A in stage 2, and B in stage 3.  This information can be used by\n-the user (or Cogito) to see what should eventually be recorded at the\n+the user (or the porcelain) to see what should eventually be recorded at the\n path. (see read-cache for more information on state)\n \n \n@@ -130,7 +130,7 @@ time.  They are built and ordered in the\n    are popped off when leaving the directory.\n \n Each pattern in the pattern list specifies \"a match pattern\" and\n-optionally the fate;n either a file that matches the pattern is\n+optionally the fate; either a file that matches the pattern is\n considered excluded or included.  A filename is matched against\n the patterns in the three lists; the --exclude-from list is\n checked first, then the --exclude-per-directory list, and then\ndiff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt\n--- a/Documentation/git-ls-tree.txt\n+++ b/Documentation/git-ls-tree.txt\n@@ -19,7 +19,7 @@ in the current working directory.\n OPTIONS\n -------\n <tree-ish>::\n-\tId of a tree.\n+\tId of a tree-ish.\n \n -d::\n \tshow only the named tree entry itself, not its children\n@@ -31,7 +31,7 @@ OPTIONS\n \t\\0 line termination on output\n \n paths::\n-\tWhen paths are given, shows them.  Otherwise implicitly\n+\tWhen paths are given, show them.  Otherwise implicitly\n \tuses the root level of the tree as the sole path argument.\n \n \ndiff --git a/Documentation/git-merge-cache.txt b/Documentation/git-merge-cache.txt\n--- a/Documentation/git-merge-cache.txt\n+++ b/Documentation/git-merge-cache.txt\n@@ -21,7 +21,7 @@ files are passed as arguments 5, 6 and 7\n OPTIONS\n -------\n --::\n-\tInterpret all future arguments as filenames.\n+\tInterpret all following arguments as filenames.\n \n -a::\n \tRun merge against all files in the cache that need merging.\ndiff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt\n--- a/Documentation/git-pack-objects.txt\n+++ b/Documentation/git-pack-objects.txt\n@@ -29,7 +29,7 @@ one-object\" format; this is typically do\n commands when a pack is created on-the-fly for efficient network\n transport by their peers.\n \n-Placing both in pack subdirectory of $GIT_OBJECT_DIRECTORY (or\n+Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or\n any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)\n enables GIT to read from such an archive.\n \ndiff --git a/Documentation/git-peek-remote.txt b/Documentation/git-peek-remote.txt\n--- a/Documentation/git-peek-remote.txt\n+++ b/Documentation/git-peek-remote.txt\n@@ -4,7 +4,7 @@ v0.1, July 2005\n \n NAME\n ----\n-git-peek-remote - Lists the references on a remote repository.\n+git-peek-remote - Lists the references in a remote repository.\n \n \n SYNOPSIS\n@@ -20,14 +20,14 @@ OPTIONS\n -------\n --exec=<git-upload-pack>::\n \tUse this to specify the path to 'git-upload-pack' on the\n-\tremote side, if is not found on your $PATH.\n-\tInstallations of sshd ignores the user's environment\n+\tremote side, if it is not found on your $PATH. Some\n+\tinstallations of sshd ignores the user's environment\n \tsetup scripts for login shells (e.g. .bash_profile) and\n \tyour privately installed GIT may not be found on the system\n \tdefault $PATH.  Another workaround suggested is to set\n \tup your $PATH in \".bashrc\", but this flag is for people\n \twho do not want to pay the overhead for non-interactive\n-\tshells by having a lean .bashrc file (they set most of\n+\tshells, but prefer having a lean .bashrc file (they set most of\n \tthe things up in .bash_profile).\n \n <host>::\ndiff --git a/Documentation/git-prune-script.txt b/Documentation/git-prune-script.txt\n--- a/Documentation/git-prune-script.txt\n+++ b/Documentation/git-prune-script.txt\n@@ -14,8 +14,9 @@ SYNOPSIS\n DESCRIPTION\n -----------\n This runs \"git-fsck-cache --unreachable\" program using the heads specified\n-on the command line (or `.git/refs/heads/\\*` and `.git/refs/tags/\\*` if none is\n-specified), and prunes all unreachable objects from the object database.\n+on the command line (or `$GIT_DIR/refs/heads/\\*` and `$GIT_DIR/refs/tags/\\*`\n+if none is specified), and prunes all unreachable objects from the object\n+database.\n \n \n Author\ndiff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt\n--- a/Documentation/git-read-tree.txt\n+++ b/Documentation/git-read-tree.txt\n@@ -41,7 +41,7 @@ OPTIONS\n \n Merging\n -------\n-If '-m' is specified, \"git-read-tree\" can performs 3 kinds of\n+If '-m' is specified, \"git-read-tree\" can perform 3 kinds of\n merge, a single tree merge if only 1 tree is given, a\n fast-forward merge with 2 trees, or a 3-way merge if 3 trees are\n provided.\n@@ -51,9 +51,9 @@ Single Tree Merge\n ~~~~~~~~~~~~~~~~~\n If only 1 tree is specified, git-read-tree operates as if the user did not\n specify '-m', except that if the original cache has an entry for a\n-given pathname; and the contents of the path matches with the tree\n+given pathname, and the contents of the path matches with the tree\n being read, the stat info from the cache is used. (In other words, the\n-cache's stat()s take precedence over the merged tree's)\n+cache's stat()s take precedence over the merged tree's).\n \n That means that if you do a \"git-read-tree -m <newtree>\" followed by a\n \"git-checkout-cache -f -u -a\", the \"git-checkout-cache\" only checks out\n@@ -184,7 +184,7 @@ populated.  Here is an outline of how th\n   automatically collapse to \"merged\" state by git-read-tree.\n \n - a file that has _any_ difference what-so-ever in the three trees\n-  will stay as separate entries in the index. It's up to \"script\n+  will stay as separate entries in the index. It's up to \"porcelain\n   policy\" to determine how to remove the non-0 stages, and insert a\n   merged version.\n \ndiff --git a/Documentation/git-tar-tree.txt b/Documentation/git-tar-tree.txt\n--- a/Documentation/git-tar-tree.txt\n+++ b/Documentation/git-tar-tree.txt\n@@ -14,7 +14,7 @@ SYNOPSIS\n DESCRIPTION\n -----------\n Creates a tar archive containing the tree structure for the named tree.\n-When <base> is specified it is added as a leading path as the files in the\n+When <base> is specified it is added as a leading path to the files in the\n generated tar archive.\n \n git-tar-tree behaves differently when given a tree ID versus when given\ndiff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt\n--- a/Documentation/git-update-server-info.txt\n+++ b/Documentation/git-update-server-info.txt\n@@ -16,7 +16,7 @@ DESCRIPTION\n A dumb server that does not do on-the-fly pack generations can\n have some auxiliary information files in $GIT_DIR/info and\n $GIT_OBJECT_DIRECTORY/info directories to help clients discover\n-what references and packs the server has and make an optimized\n+what references and packs the server has and make optimized\n pull decisions.  This command generates such auxiliary files.\n \n \ndiff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt\n--- a/Documentation/git-write-tree.txt\n+++ b/Documentation/git-write-tree.txt\n@@ -4,7 +4,7 @@ v0.1, May 2005\n \n NAME\n ----\n-git-write-tree - Creates a tree from the current cache\n+git-write-tree - Creates a tree object from the current cache\n \n \n SYNOPSIS\n\n"}]}