{"thread":{"id":"9341","subject":"[PATCH] Try to be consistent with capitalization in the documentation","startedAt":"2007-08-01T15:43:06Z","lastAt":"2007-08-02T06:11:20Z","messageCount":4,"participants":["Steve Hoelzer","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"49316","messageId":"514D28CB-25F8-49B2-921E-8EFA60BE864C@gmail.com","threadId":"9341","inReplyTo":null,"subject":"[PATCH] Try to be consistent with capitalization in the documentation","fromName":"Steve Hoelzer","fromEmail":"shoelzer@gmail.com","sentAt":"2007-08-01T15:43:06Z","receivedAt":"2007-08-01T15:43:06Z","isPatch":true,"sender":{"key":"shoelzer@gmail.com","avatar":"https://avatars.githubusercontent.com/u/4623209?v=4"},"body":"Signed-off-by: Steve Hoelzer \n---\n\nTry to be consistent with capitalization in the documentation.\n\ndiff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt\nindex bc6aa88..198ab47 100644\n--- a/Documentation/git-branch.txt\n+++ b/Documentation/git-branch.txt\n@@ -134,8 +134,8 @@ $ git branch -d -r origin/todo origin/html origin/ \nman <1>\n$ git branch -D test <2>\n------------\n+\n-<1> delete remote-tracking branches \"todo\", \"html\", \"man\"\n-<2> delete \"test\" branch even if the \"master\" branch does not have all\n+<1> Delete remote-tracking branches \"todo\", \"html\", \"man\".\n+<2> Delete \"test\" branch even if the \"master\" branch does not have all\ncommits from test branch.\ndiff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt\nindex b1f5e7f..b36e705 100644\n--- a/Documentation/git-diff.txt\n+++ b/Documentation/git-diff.txt\n@@ -76,10 +76,10 @@ $ git diff --cached <2>\n$ git diff HEAD <3>\n------------\n+\n-<1> changes in the working tree not yet staged for the next commit.\n-<2> changes between the index and your last commit; what you\n+<1> Changes in the working tree not yet staged for the next commit.\n+<2> Changes between the index and your last commit; what you\nwould be committing if you run \"git commit\" without \"-a\" option.\n-<3> changes in the working tree since your last commit; what you\n+<3> Changes in the working tree since your last commit; what you\nwould be committing if you run \"git commit -a\"\nComparing with arbitrary commits::\n@@ -90,12 +90,12 @@ $ git diff HEAD -- ./test <2>\n$ git diff HEAD^ HEAD <3>\n------------\n+\n-<1> instead of using the tip of the current branch, compare with the\n+<1> Instead of using the tip of the current branch, compare with the\ntip of \"test\" branch.\n-<2> instead of comparing with the tip of \"test\" branch, compare with\n+<2> Instead of comparing with the tip of \"test\" branch, compare with\nthe tip of the current branch, but limit the comparison to the\nfile \"test\".\n-<3> compare the version before the last commit and the last commit.\n+<3> Compare the version before the last commit and the last commit.\nLimiting the diff output::\n@@ -106,11 +106,11 @@ $ git diff --name-status <2>\n$ git diff arch/i386 include/asm-i386 <3>\n------------\n+\n-<1> show only modification, rename and copy, but not addition\n+<1> Show only modification, rename and copy, but not addition\nnor deletion.\n-<2> show only names and the nature of change, but not actual\n+<2> Show only names and the nature of change, but not actual\ndiff output.\n-<3> limit diff output to named subtrees.\n+<3> Limit diff output to named subtrees.\nMunging the diff output::\n+\n@@ -119,9 +119,9 @@ $ git diff --find-copies-harder -B -C <1>\n$ git diff -R <2>\n------------\n+\n-<1> spend extra cycles to find renames, copies and complete\n+<1> Spend extra cycles to find renames, copies and complete\nrewrites (very expensive).\n-<2> output diff in reverse.\n+<2> Output diff in reverse.\nAuthor\ndiff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt\nindex 2c9db98..2e1b7b6 100644\n--- a/Documentation/git-merge.txt\n+++ b/Documentation/git-merge.txt\n@@ -107,11 +107,11 @@ pull after you are done and ready.\nWhen things cleanly merge, these things happen:\n-1. the results are updated both in the index file and in your\n- working tree,\n-2. index file is written out as a tree,\n-3. the tree gets committed, and\n-4. the `HEAD` pointer gets advanced.\n+1. The results are updated both in the index file and in your\n+ working tree.\n+2. Index file is written out as a tree.\n+3. The tree gets committed.\n+4. The `HEAD` pointer gets advanced.\nBecause of 2., we require that the original state of the index\nfile to match exactly the current `HEAD` commit; otherwise we\ndiff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt\nindex 19c5b9b..15e3aca 100644\n--- a/Documentation/git-reset.txt\n+++ b/Documentation/git-reset.txt\n@@ -63,7 +63,7 @@ $ git commit -a -c ORIG_HEAD <3>\n<1> This is most often done when you remembered what you\njust committed is incomplete, or you misspelled your commit\nmessage, or both. Leaves working tree as it was before \"reset\".\n-<2> make corrections to working tree files.\n+<2> Make corrections to working tree files.\n<3> \"reset\" copies the old head to .git/ORIG_HEAD; redo the\ncommit by starting with its log message. If you do not need to\nedit the message further, you can give -C option instead.\n@@ -106,17 +106,17 @@ $ git reset <3>\n$ git pull git://info.example.com/ nitfol <4>\n------------\n+\n-<1> you are happily working on something, and find the changes\n+<1> You are happily working on something, and find the changes\nin these files are in good order. You do not want to see them\nwhen you run \"git diff\", because you plan to work on other files\nand changes with these files are distracting.\n-<2> somebody asks you to pull, and the changes sounds worthy of \nmerging.\n-<3> however, you already dirtied the index (i.e. your index does\n+<2> Somebody asks you to pull, and the changes sounds worthy of \nmerging.\n+<3> However, you already dirtied the index (i.e. your index does\nnot match the HEAD commit). But you know the pull you are going\nto make does not affect frotz.c nor filfre.c, so you revert the\nindex changes for these two files. Your changes in working tree\nremain there.\n-<4> then you can pull and merge, leaving frotz.c and filfre.c\n+<4> Then you can pull and merge, leaving frotz.c and filfre.c\nchanges still in the working tree.\nUndo a merge or pull::\n@@ -133,15 +133,15 @@ Fast forward\n$ git reset --hard ORIG_HEAD <4>\n------------\n+\n-<1> try to update from the upstream resulted in a lot of\n+<1> Try to update from the upstream resulted in a lot of\nconflicts; you were not ready to spend a lot of time merging\nright now, so you decide to do that later.\n<2> \"pull\" has not made merge commit, so \"git reset --hard\"\nwhich is a synonym for \"git reset --hard HEAD\" clears the mess\nfrom the index file and the working tree.\n-<3> merge a topic branch into the current branch, which resulted\n+<3> Merge a topic branch into the current branch, which resulted\nin a fast forward.\n-<4> but you decided that the topic branch is not ready for public\n+<4> But you decided that the topic branch is not ready for public\nconsumption yet. \"pull\" or \"merge\" always leaves the original\ntip of the current branch in ORIG_HEAD, so resetting hard to it\nbrings your index file and the working tree back to that state,\n"},{"id":"49324","messageId":"7vir7z5gx7.fsf@assigned-by-dhcp.cox.net","threadId":"9341","inReplyTo":"514D28CB-25F8-49B2-921E-8EFA60BE864C@gmail.com","subject":"Re: [PATCH] Try to be consistent with capitalization in the documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2007-08-01T17:00:04Z","receivedAt":"2007-08-01T17:00:04Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Steve Hoelzer writes:\n\n> Signed-off-by: Steve Hoelzer \n> ---\n>\n> Try to be consistent with capitalization in the documentation.\n\nIt looks like that all the originals are trying to consistently\nstart with lowercase in an explanatory list. Is this really\nneeded?\n"},{"id":"49327","messageId":"588192970708011017q12c7a6d9s532c8aed086d3032@mail.gmail.com","threadId":"9341","inReplyTo":"7vir7z5gx7.fsf@assigned-by-dhcp.cox.net","subject":"Re: [PATCH] Try to be consistent with capitalization in the documentation","fromName":"Steve Hoelzer","fromEmail":"shoelzer@gmail.com","sentAt":"2007-08-01T17:17:52Z","receivedAt":"2007-08-01T17:17:52Z","isPatch":true,"sender":{"key":"shoelzer@gmail.com","avatar":"https://avatars.githubusercontent.com/u/4623209?v=4"},"body":"On 8/1/07, Junio C Hamano wrote:\n> Steve Hoelzer writes:\n>\n> > Signed-off-by: Steve Hoelzer \n> > ---\n> >\n> > Try to be consistent with capitalization in the documentation.\n>\n> It looks like that all the originals are trying to consistently\n> start with lowercase in an explanatory list. Is this really\n> needed?\n\nThe lists I changed were indeed all lowercase, but other lists in\nthose files are all uppercase. I was aiming for consistency across all\nlist items and all lists.\n\nSteve\n"},{"id":"49391","messageId":"7v7ioe1n5j.fsf@assigned-by-dhcp.cox.net","threadId":"9341","inReplyTo":"588192970708011017q12c7a6d9s532c8aed086d3032@mail.gmail.com","subject":"Re: [PATCH] Try to be consistent with capitalization in the documentation","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2007-08-02T06:11:20Z","receivedAt":"2007-08-02T06:11:20Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Steve Hoelzer\" writes:\n\n> On 8/1/07, Junio C Hamano wrote:\n>> Steve Hoelzer writes:\n>>\n>> > Signed-off-by: Steve Hoelzer \n>> > ---\n>> >\n>> > Try to be consistent with capitalization in the documentation.\n>>\n>> It looks like that all the originals are trying to consistently\n>> start with lowercase in an explanatory list. Is this really\n>> needed?\n>\n> The lists I changed were indeed all lowercase, but other lists in\n> those files are all uppercase. I was aiming for consistency across all\n> list items and all lists.\n\nFair enough. However, your patch was seriously whitespace\nmangled so I made matching edits by hand and committed the\nresult. After I push out the result sometime tonight, please\ndouble check the result.\n"}]}