{"thread":{"id":"14289","subject":"[PATCH]: fix typos in docs","startedAt":"2008-07-04T17:39:52Z","lastAt":"2008-07-04T19:37:49Z","messageCount":2,"participants":["Eric Hanchrow","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"82244","messageId":"877ic1sg47.fsf@offby1.atm01.sea.blarg.net","threadId":"14289","inReplyTo":null,"subject":"[PATCH]: fix typos in docs","fromName":"Eric Hanchrow","fromEmail":"offby1@blarg.net","sentAt":"2008-07-04T17:39:52Z","receivedAt":"2008-07-04T17:39:52Z","isPatch":true,"sender":{"key":"eric.hanchrow@gmail.com","avatar":"https://avatars.githubusercontent.com/u/3145?v=4"},"body":">From 098e3ec480254069d944e494a42afcf2013d08d7 Mon Sep 17 00:00:00 2001\nFrom: Eric Hanchrow <offby1@blarg.net>\nDate: Mon, 30 Jun 2008 23:34:08 -0700\nSubject: [PATCH] Fix typos\n\n---\n Documentation/.gitignore           |   10 ++++++----\n Documentation/config.txt           |    2 +-\n Documentation/git.txt              |    2 +-\n Documentation/gitcore-tutorial.txt |    2 +-\n Documentation/gitglossary.txt      |    2 +-\n Documentation/user-manual.txt      |   18 +++++++++---------\n 6 files changed, 19 insertions(+), 17 deletions(-)\n\ndiff --git a/Documentation/.gitignore b/Documentation/.gitignore\nindex d8edd90..ce24e4a 100644\n--- a/Documentation/.gitignore\n+++ b/Documentation/.gitignore\n@@ -1,10 +1,12 @@\n-*.xml\n-*.html\n *.[1-8]\n+*.html\n *.made\n *.texi\n+*.xml\n+cmds-*.txt\n+doc.dep\n+fancytooltips.js\n+favicon.ico\n git.info\n gitman.info\n howto-index.txt\n-doc.dep\n-cmds-*.txt\ndiff --git a/Documentation/config.txt b/Documentation/config.txt\nindex 561ff64..e891745 100644\n--- a/Documentation/config.txt\n+++ b/Documentation/config.txt\n@@ -680,7 +680,7 @@ gitcvs.usecrlfattr\n \ttreat it as text. If `crlf` is explicitly unset, the file\n \twill be set with '-kb' mode, which supresses any newline munging\n \tthe client might otherwise do. If `crlf` is not specified,\n-\tthen 'gitcvs.allbinary' is used. See linkgit:gitattribute[5].\n+\tthen 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].\n \n gitcvs.allbinary::\n \tThis is used if 'gitcvs.usecrlfattr' does not resolve\ndiff --git a/Documentation/git.txt b/Documentation/git.txt\nindex 22702c2..fa67383 100644\n--- a/Documentation/git.txt\n+++ b/Documentation/git.txt\n@@ -591,7 +591,7 @@ contributors on the git-list <git@vger.kernel.org>.\n SEE ALSO\n --------\n linkgit:gittutorial[7], linkgit:gittutorial-2[7],\n-linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n+linkgit:everyday[7], linkgit:gitcvs-migration[7],\n linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],\n linkgit:gitcli[7], link:user-manual.html[The Git User's Manual]\n \ndiff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\nindex 7d721c5..9195997 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -1690,7 +1690,7 @@ to follow, not easier.\n SEE ALSO\n --------\n linkgit:gittutorial[7], linkgit:gittutorial-2[7],\n-linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n+linkgit:everyday[7], linkgit:gitcvs-migration[7],\n link:user-manual.html[The Git User's Manual]\n \n GIT\ndiff --git a/Documentation/gitglossary.txt b/Documentation/gitglossary.txt\nindex 5c5c31d..565719e 100644\n--- a/Documentation/gitglossary.txt\n+++ b/Documentation/gitglossary.txt\n@@ -17,7 +17,7 @@ include::glossary-content.txt[]\n SEE ALSO\n --------\n linkgit:gittutorial[7], linkgit:gittutorial-2[7],\n-linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n+linkgit:everyday[7], linkgit:gitcvs-migration[7],\n link:user-manual.html[The Git User's Manual]\n \n GIT\ndiff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt\nindex ca13266..ae6525a 100644\n--- a/Documentation/user-manual.txt\n+++ b/Documentation/user-manual.txt\n@@ -518,7 +518,7 @@ $ git bisect visualize\n -------------------------------------------------\n \n which will run gitk and label the commit it chose with a marker that\n-says \"bisect\".  Chose a safe-looking commit nearby, note its commit\n+says \"bisect\".  Choose a safe-looking commit nearby, note its commit\n id, and check it out with:\n \n -------------------------------------------------\n@@ -1988,8 +1988,8 @@ intend to manage the branch.\n \n It's also possible for a push to fail in this way when other people have\n the right to push to the same repository.  In that case, the correct\n-solution is to retry the push after first updating your work by either a\n-pull or a fetch followed by a rebase; see the\n+solution is to retry the push after first updating your work: either by a\n+pull, or by a fetch followed by a rebase; see the\n <<setting-up-a-shared-repository,next section>> and\n linkgit:gitcvs-migration[7] for more.\n \n@@ -2861,7 +2861,7 @@ There are four different types of objects: \"blob\", \"tree\", \"commit\", and\n \"tag\".\n \n - A <<def_blob_object,\"blob\" object>> is used to store file data.\n-- A <<def_tree_object,\"tree\" object>> is an object that ties one or more\n+- A <<def_tree_object,\"tree\" object>> ties one or more\n   \"blob\" objects into a directory structure. In addition, a tree object\n   can refer to other tree objects, thus creating a directory hierarchy.\n - A <<def_commit_object,\"commit\" object>> ties such directory hierarchies\n@@ -3036,7 +3036,7 @@ Tag Object\n \n A tag object contains an object, object type, tag name, the name of the\n person (\"tagger\") who created the tag, and a message, which may contain\n-a signature, as can be seen using the linkgit:git-cat-file[1]:\n+a signature, as can be seen using linkgit:git-cat-file[1]:\n \n ------------------------------------------------\n $ git cat-file tag v1.5.0\n@@ -3986,13 +3986,13 @@ $ mv -f hello.c~2 hello.c\n $ git update-index hello.c\n -------------------------------------------------\n \n-When a path is in unmerged state, running `git-update-index` for\n+When a path is in the \"unmerged\" state, running `git-update-index` for\n that path tells git to mark the path resolved.\n \n The above is the description of a git merge at the lowest level,\n to help you understand what conceptually happens under the hood.\n-In practice, nobody, not even git itself, uses three `git-cat-file`\n-for this.  There is `git-merge-index` program that extracts the\n+In practice, nobody, not even git itself, runs `git-cat-file` three times\n+for this.  There is a `git-merge-index` program that extracts the\n stages to temporary files and calls a \"merge\" script on it:\n \n -------------------------------------------------\n@@ -4061,7 +4061,7 @@ Note that terminology has changed since that revision.  For example, the\n README in that revision uses the word \"changeset\" to describe what we\n now call a <<def_commit_object,commit>>.\n \n-Also, we do not call it \"cache\" any more, but \"index\", however, the\n+Also, we do not call it \"cache\" any more, but rather \"index\"; however, the\n file is still called `cache.h`.  Remark: Not much reason to change it now,\n especially since there is no good single name for it anyway, because it is\n basically _the_ header file which is included by _all_ of Git's C sources.\n-- \n1.5.4.3\n\n\n-- \nPeople studying literature rarely say anything that would be of the\nslightest use to those producing it.\n        -- Paul Graham\n"},{"id":"82252","messageId":"7v63rlv3si.fsf@gitster.siamese.dyndns.org","threadId":"14289","inReplyTo":"877ic1sg47.fsf@offby1.atm01.sea.blarg.net","subject":"Re: [PATCH]: fix typos in docs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-07-04T19:37:49Z","receivedAt":"2008-07-04T19:37:49Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Eric Hanchrow <offby1@blarg.net> writes:\n\n> From 098e3ec480254069d944e494a42afcf2013d08d7 Mon Sep 17 00:00:00 2001\n> From: Eric Hanchrow <offby1@blarg.net>\n> Date: Mon, 30 Jun 2008 23:34:08 -0700\n> Subject: [PATCH] Fix typos\n\nUnnecessarily duplicated headers.  Please drop them, especially the first\none (the latter three are fine if the difference between them and what\nappears in your e-mail header matters).\n\n> diff --git a/Documentation/.gitignore b/Documentation/.gitignore\n> index d8edd90..ce24e4a 100644\n> --- a/Documentation/.gitignore\n> +++ b/Documentation/.gitignore\n\nThis part does not look like \"fix typos\" at all, and is an unrelated\nchange.  Explain in the commit log message please.\n\n> diff --git a/Documentation/config.txt b/Documentation/config.txt\n> -\tthen 'gitcvs.allbinary' is used. See linkgit:gitattribute[5].\n> +\tthen 'gitcvs.allbinary' is used. See linkgit:gitattributes[5].\n> diff --git a/Documentation/git.txt b/Documentation/git.txt\n> -linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n> +linkgit:everyday[7], linkgit:gitcvs-migration[7],\n> diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt\n> -linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n> +linkgit:everyday[7], linkgit:gitcvs-migration[7],\n> diff --git a/Documentation/gitglossary.txt b/Documentation/gitglossary.txt\n> -linkgit:giteveryday[7], linkgit:gitcvs-migration[7],\n> +linkgit:everyday[7], linkgit:gitcvs-migration[7],\n\nThese are \"fix broken links\" aren't they?  Please make them into a\nseparate patch that has only \"fix broken links\" and nothing else.\n\nThe remaining are rewording, \"fix grammar\", with one typofix; it is good\nto include them in a single patch but please give a bit better label.\n\nPlease split this into at least two, possibly three patches:\n\n (0) A change to Documentation/.gitignore with justification.  As far as I\n     can see, the two files you added are not built products nor cruft\n     left by our build procedure.\n\n (1) \"Documentation: fix broken links\".\n\n (2) \"Documentation: fix grammar and typo, and reword for readability\".\n"}]}