{"thread":{"id":"13519","subject":"[PATCH] Rephrased git-describe description","startedAt":"2008-05-14T18:30:55Z","lastAt":"2008-05-17T00:03:00Z","messageCount":5,"participants":["Ian Hilt","Junio C Hamano","Dirk Süsserott"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"76970","messageId":"1210789855-29413-1-git-send-email-ian.hilt@gmail.com","threadId":"13519","inReplyTo":null,"subject":"[PATCH] Rephrased git-describe description","fromName":"Ian Hilt","fromEmail":"ian.hilt@gmail.com","sentAt":"2008-05-14T18:30:55Z","receivedAt":"2008-05-14T18:30:55Z","isPatch":true,"sender":{"key":"ian.hilt@gmail.com","avatar":null},"body":"git-describe: Make description more readable.\n\nSigned-off-by: Ian Hilt \n---\n Documentation/git-describe.txt | 7 ++++---\n 1 files changed, 4 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\nindex d9aa2f2..69e1ab7 100644\n--- a/Documentation/git-describe.txt\n+++ b/Documentation/git-describe.txt\n@@ -13,9 +13,10 @@ SYNOPSIS\n DESCRIPTION\n -----------\n The command finds the most recent tag that is reachable from a\n-commit, and if the commit itself is pointed at by the tag, shows\n-the tag. Otherwise, it suffixes the tag name with the number of\n-additional commits and the abbreviated object name of the commit.\n+commit. If the tag points to the commit, then only the tag is\n+shown. Otherwise, it suffixes the tag name with the number of\n+additional commits on top of the tagged object and the\n+abbreviated object name of the most recent commit.\n \n \n OPTIONS\n-- \n1.5.3.7\n"},{"id":"76975","messageId":"7v7idwoh9m.fsf@gitster.siamese.dyndns.org","threadId":"13519","inReplyTo":"1210789855-29413-1-git-send-email-ian.hilt@gmail.com","subject":"Re: [PATCH] Rephrased git-describe description","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-05-14T18:46:45Z","receivedAt":"2008-05-14T18:46:45Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ian Hilt writes:\n\n> git-describe: Make description more readable.\n\nThanks, both. I think the above is meant to be on the Subject: line, and\nthe text certainly is more readable.\n\n> Signed-off-by: Ian Hilt \n> ---\n> Documentation/git-describe.txt | 7 ++++---\n> 1 files changed, 4 insertions(+), 3 deletions(-)\n>\n> diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\n> index d9aa2f2..69e1ab7 100644\n> --- a/Documentation/git-describe.txt\n> +++ b/Documentation/git-describe.txt\n> @@ -13,9 +13,10 @@ SYNOPSIS\n> DESCRIPTION\n> -----------\n> The command finds the most recent tag that is reachable from a\n> -commit, and if the commit itself is pointed at by the tag, shows\n> -the tag. Otherwise, it suffixes the tag name with the number of\n> -additional commits and the abbreviated object name of the commit.\n> +commit. If the tag points to the commit, then only the tag is\n> +shown. Otherwise, it suffixes the tag name with the number of\n> +additional commits on top of the tagged object and the\n> +abbreviated object name of the most recent commit.\n"},{"id":"76983","messageId":"482B4526.9020905@dirk.my1.cc","threadId":"13519","inReplyTo":"7v7idwoh9m.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH] Rephrased git-describe description","fromName":"Dirk Süsserott","fromEmail":"newsletter@dirk.my1.cc","sentAt":"2008-05-14T20:01:42Z","receivedAt":"2008-05-14T20:01:42Z","isPatch":true,"sender":{"key":"newsletter@dirk.my1.cc","avatar":null},"body":"While we're talking about 'git-describe': I always wondered what the '-g'\nin front of the sha1 stands for when I issue 'git describe'. Is it for \n'generation'\nor what? Actually I'd appreciate if that '-g' would be dropped as it is of\nno use but I also recognize that git-describe is one of the plumbing tools.\nI'm just curious.\n Dirk\n\nJunio C Hamano schrieb:\n> Ian Hilt writes:\n>\n> \n>> git-describe: Make description more readable.\n>> \n>\n> Thanks, both. I think the above is meant to be on the Subject: line, and\n> the text certainly is more readable.\n>\n> \n>> Signed-off-by: Ian Hilt \n>> ---\n>> Documentation/git-describe.txt | 7 ++++---\n>> 1 files changed, 4 insertions(+), 3 deletions(-)\n>>\n>> diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\n>> index d9aa2f2..69e1ab7 100644\n>> --- a/Documentation/git-describe.txt\n>> +++ b/Documentation/git-describe.txt\n>> @@ -13,9 +13,10 @@ SYNOPSIS\n>> DESCRIPTION\n>> -----------\n>> The command finds the most recent tag that is reachable from a\n>> -commit, and if the commit itself is pointed at by the tag, shows\n>> -the tag. Otherwise, it suffixes the tag name with the number of\n>> -additional commits and the abbreviated object name of the commit.\n>> +commit. If the tag points to the commit, then only the tag is\n>> +shown. Otherwise, it suffixes the tag name with the number of\n>> +additional commits on top of the tagged object and the\n>> +abbreviated object name of the most recent commit.\n>> \n>\n> --\n> To unsubscribe from this list: send the line \"unsubscribe git\" in\n> the body of a message to majordomo@vger.kernel.org\n> More majordomo info at http://vger.kernel.org/majordomo-info.html\n>\n> \n"},{"id":"77000","messageId":"alpine.LNX.1.10.0805141856380.30187@sys-0.hiltweb.site","threadId":"13519","inReplyTo":"7v7idwoh9m.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH] Rephrased git-describe description","fromName":"Ian Hilt","fromEmail":"ian.hilt@gmail.com","sentAt":"2008-05-14T23:02:12Z","receivedAt":"2008-05-14T23:02:12Z","isPatch":true,"sender":{"key":"ian.hilt@gmail.com","avatar":null},"body":"On Wed, 14 May 2008 at 11:46am -0700, Junio C Hamano wrote:\n\n> Ian Hilt writes:\n>\n>> git-describe: Make description more readable.\n>\n> Thanks, both. I think the above is meant to be on the Subject: line, and\n> the text certainly is more readable.\n\nThis is probably a stupid question, but is that all you want for\na commit message?\n\n-- \nIan Hilt\nian.hilt (at) gmail.com\nGnuPG key: 0x4AFC1EE3\n"},{"id":"77164","messageId":"7vej81er0r.fsf@gitster.siamese.dyndns.org","threadId":"13519","inReplyTo":"alpine.LNX.1.10.0805141856380.30187@sys-0.hiltweb.site","subject":"Re: [PATCH] Rephrased git-describe description","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-05-17T00:03:00Z","receivedAt":"2008-05-17T00:03:00Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Ian Hilt writes:\n\n> On Wed, 14 May 2008 at 11:46am -0700, Junio C Hamano wrote:\n>\n>> Ian Hilt writes:\n>>\n>>> git-describe: Make description more readable.\n>>\n>> Thanks, both. I think the above is meant to be on the Subject: line, and\n>> the text certainly is more readable.\n>\n> This is probably a stupid question, but is that all you want for\n> a commit message?\n\nI think the following is clear enough to describe what your patch did.\n\n commit b7893cde53eb2834deb16820eccb709d2636b81b\n Author: Ian Hilt \n Date: Wed May 14 14:30:55 2008 -0400\n\n Documentation/git-describe.txt: make description more readable\n\n Signed-off-by: Ian Hilt \n Credit-to: Kevin Ballard \n Signed-off-by: Junio C Hamano \n\nWhen made into a line in the shortlog, this makes it clear that it affects\nthe documentation (and documentation only), and it describes what the\npatch did.\n\nIf there is a guiding principle that drove the change the patch did, and\nthat guiding principle is something other people can follow when fixing\nsimilar breakages, it often is a good idea to describe what they are in\nthe body of the commit log message. But I did not see such a clear,\nreusable guiding principle for this change.\n\nWhat I mean by a guiding principle in this case is something like...\n\n - command description should start with a clear description of what it\n does, so that the readers can decide if that is the command they want\n to solve their problem with by reading the very first part;\n\n - and then it should describe how it does it in an unambiguous and easy\n to read language.\n\nThen you can have a comparison between the text before and after the\nchange to explain why the updated text is more unambiguous. But you would\nrisk ending up with a textbook of English composition which is not what we\nnecessarily want to do here ;-)\n"}]}