{"thread":{"id":"22244","subject":"[PATCH] Update documentation: git-commit is not a shell command","startedAt":"2010-01-16T09:35:40Z","lastAt":"2010-01-16T18:07:54Z","messageCount":3,"participants":["Ramkumar Ramachandra","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"131865","messageId":"f3271551001160135k569e2692i5e2ab893701e1738@mail.gmail.com","threadId":"22244","inReplyTo":null,"subject":"[PATCH] Update documentation: git-commit is not a shell command","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-01-16T09:35:40Z","receivedAt":"2010-01-16T09:35:40Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Reported by Osamu Aoki through http://bugs.debian.org/560795\n\nSigned-off-by: Ramkumar Ramachandra <artagnon@gmail.com>\n---\n Documentation/gitcore-tutorial.txt |    9 +--------\n 1 files changed, 1 insertions(+), 8 deletions(-)\n\ndiff --git a/Documentation/gitcore-tutorial.txt\nb/Documentation/gitcore-tutorial.txt\nindex f762dca..ebc5d0b 100644\n--- a/Documentation/gitcore-tutorial.txt\n+++ b/Documentation/gitcore-tutorial.txt\n@@ -454,14 +454,7 @@ will be pruned out, and the rest will be used as\nthe commit message for\n the change. If you decide you don't want to commit anything after all at\n this point (you can continue to edit things and update the index), you\n can just leave an empty message. Otherwise `git commit` will commit\n-the change for you.\n-\n-You've now made your first real git commit. And if you're interested in\n-looking at what `git commit` really does, feel free to investigate:\n-it's a few very simple shell scripts to generate the helpful (?) commit\n-message headers, and a few one-liners that actually do the\n-commit itself ('git-commit').\n-\n+the change for you. You've now made your first real git commit.\n\n Inspecting Changes\n ------------------\n-- \n1.6.5\n"},{"id":"131886","messageId":"7v8wbyc5yb.fsf@alter.siamese.dyndns.org","threadId":"22244","inReplyTo":"f3271551001160135k569e2692i5e2ab893701e1738@mail.gmail.com","subject":"Re: [PATCH] Update documentation: git-commit is not a shell command","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2010-01-16T17:31:08Z","receivedAt":"2010-01-16T17:31:08Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ramkumar Ramachandra <artagnon@gmail.com> writes:\n\n> diff --git a/Documentation/gitcore-tutorial.txt\n> b/Documentation/gitcore-tutorial.txt\n> index f762dca..ebc5d0b 100644\n> --- a/Documentation/gitcore-tutorial.txt\n> +++ b/Documentation/gitcore-tutorial.txt\n> @@ -454,14 +454,7 @@ will be pruned out, and the rest will be used as\n> the commit message for\n>  the change. If you decide you don't want to commit anything after all at\n>  this point (you can continue to edit things and update the index), you\n>  can just leave an empty message. Otherwise `git commit` will commit\n> -the change for you.\n> -\n> -You've now made your first real git commit. And if you're interested in\n> -looking at what `git commit` really does, feel free to investigate:\n> -it's a few very simple shell scripts to generate the helpful (?) commit\n> -message headers, and a few one-liners that actually do the\n> -commit itself ('git-commit').\n> -\n> +the change for you. You've now made your first real git commit.\n\nWhile the issue you are addressing may be a valid one, removing the whole\nparagraph and not doing anything else is not an improvement.  Read the\nchanged text in a larger context and you will notice that the tutorial\nsequence around there does not make much sense anymore.\n\nThe point of the core tutorial is to introduce the reader to the low level\nstructure and plumbing, and a major reason for running \"git commit\" at\nthat point in the tutorial is to mention that what even a relatively high\nlevel command \"git commit\" does can be scripted.  Up to that point, the\ntutorial showed a much lower level tools to create a commit, and said\n\"... but you've done that once already, so let's just use the helpful\nscript this time:\" (by the way, you forgot to change this \"script\").\n\nSo after \"You've now made your first real git commit\" (which is not true,\nby the way---the reader has already done so with commit-tree), you would\nneed to mention that what git-commit does can be scripted, that it indeed\nwas a script before Git v1.5.4, that if you want to write a command that\nmakes a commit but in a different way then you can script it using the\nsame ingredients the scripted \"git commit\" used to use, and perhaps that\nthe scripted version is available as a reference in the git source tree in\ncontrib/examples.\n\nActually, I changed my mind.  There are many other Porcelain commands in\nthe core tutorial that are no longer scripted.  It is better to leave the\nmain text of the tutorial as-is.  In the initial part of the document,\nmention that many Porcelain commands were scripts back when the document\nwas written, that the document uses them as examples of how plumbing are\nfit together to form them, that some scripted Porcelain implementations\nare found in contrib/examples/ directory of the source tree for reference\npurposes, and that the description of what the plumbing layer commands do\nin the document is still valid even though the Porcelain commands mentined\nin the document are not implemented in terms of the plumbing commands in\nshell scripts anymore.\n"},{"id":"131892","messageId":"f3271551001161007u33aa6bbfu7ad85ed8241695bc@mail.gmail.com","threadId":"22244","inReplyTo":"7v8wbyc5yb.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH] Update documentation: git-commit is not a shell command","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2010-01-16T18:07:54Z","receivedAt":"2010-01-16T18:07:54Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"> Actually, I changed my mind.  There are many other Porcelain commands in\n> the core tutorial that are no longer scripted.  It is better to leave the\n> main text of the tutorial as-is.  In the initial part of the document,\n> mention that many Porcelain commands were scripts back when the document\n> was written, that the document uses them as examples of how plumbing are\n> fit together to form them, that some scripted Porcelain implementations\n> are found in contrib/examples/ directory of the source tree for reference\n> purposes, and that the description of what the plumbing layer commands do\n> in the document is still valid even though the Porcelain commands mentined\n> in the document are not implemented in terms of the plumbing commands in\n> shell scripts anymore.\n\nRight. Thanks for pointing that out. Here's the patch fixing it:\nhttp://permalink.gmane.org/gmane.comp.version-control.git/137242\n\n-- Ram\n"}]}