{"thread":{"id":"39643","subject":"git-describe manual page's one sentence summary is misleading","startedAt":"2015-06-16T10:45:35Z","lastAt":"2015-06-16T20:21:16Z","messageCount":3,"participants":["Albert Netymk","Matthieu Moy","Junio C Hamano"],"isPatch":false,"patchVersion":null,"patchTotal":null},"messages":[{"id":"263923","messageId":"CAKEGsXTY_rstoK4Gcga6XqkqKCeOkXdL-TjAWUu0Cqi6mWW7bA@mail.gmail.com","threadId":"39643","inReplyTo":null,"subject":"git-describe manual page's one sentence summary is misleading","fromName":"Albert Netymk","fromEmail":"albertnetymk@gmail.com","sentAt":"2015-06-16T10:45:35Z","receivedAt":"2015-06-16T10:45:35Z","isPatch":false,"sender":{"key":"albertnetymk@gmail.com","avatar":null},"body":"According to the man of git-describe, http://git-scm.com/docs/git-describe\n\ngit-describe - Show the most recent tag that is reachable from a commit\n\nIt means that this command shows the name of the most recent tag.\n\nHowever, actually, it construct a new tag name if the current commit\nis not tagged.\n\nI think, \"git-describe - Describe a commit using the most recent tag\nreachable from it\" is a better summary.\n\n-- \nBest Regards\n\nYours faithfully\nAlbert Netymk\n"},{"id":"263927","messageId":"1434460598-23201-1-git-send-email-Matthieu.Moy@imag.fr","threadId":"39643","inReplyTo":"CAKEGsXTY_rstoK4Gcga6XqkqKCeOkXdL-TjAWUu0Cqi6mWW7bA@mail.gmail.com","subject":"[PATCH] Documentation/describe: improve one-line summary","fromName":"Matthieu Moy","fromEmail":"matthieu.moy@imag.fr","sentAt":"2015-06-16T13:16:38Z","receivedAt":"2015-06-16T13:16:38Z","isPatch":true,"sender":{"key":"git@matthieu-moy.fr","avatar":"https://avatars.githubusercontent.com/u/14709?v=4"},"body":"git describe does not show 'the most recent tag that is reachable from a\ncommit', but a descriptive name based on this tag. Fix the description to\nreflect that.\n\nSuggested-by: Albert Netymk <albertnetymk@gmail.com>\nSigned-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>\n---\n> According to the man of git-describe, http://git-scm.com/docs/git-describe\n> \n> git-describe - Show the most recent tag that is reachable from a commit\n> \n> It means that this command shows the name of the most recent tag.\n> \n> However, actually, it construct a new tag name if the current commit\n> is not tagged.\n> \n> I think, \"git-describe - Describe a commit using the most recent tag\n> reachable from it\" is a better summary.\n\nIndeed. Here's a patch fixing this.\n\n Documentation/git-describe.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\nindex d20ca40..e045fc7 100644\n--- a/Documentation/git-describe.txt\n+++ b/Documentation/git-describe.txt\n@@ -3,7 +3,7 @@ git-describe(1)\n \n NAME\n ----\n-git-describe - Show the most recent tag that is reachable from a commit\n+git-describe - Describe a commit using the most recent tag reachable from it\n \n \n SYNOPSIS\n-- \n2.4.1.171.g060e6ae.dirty\n"},{"id":"263971","messageId":"xmqqk2v35rr7.fsf@gitster.dls.corp.google.com","threadId":"39643","inReplyTo":"1434460598-23201-1-git-send-email-Matthieu.Moy@imag.fr","subject":"Re: [PATCH] Documentation/describe: improve one-line summary","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2015-06-16T20:21:16Z","receivedAt":"2015-06-16T20:21:16Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Matthieu Moy <Matthieu.Moy@imag.fr> writes:\n\n> diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\n> index d20ca40..e045fc7 100644\n> --- a/Documentation/git-describe.txt\n> +++ b/Documentation/git-describe.txt\n> @@ -3,7 +3,7 @@ git-describe(1)\n>  \n>  NAME\n>  ----\n> -git-describe - Show the most recent tag that is reachable from a commit\n> +git-describe - Describe a commit using the most recent tag reachable from it\n\nWhile it feels a bit funny to describe a \"describe\" command as \"that\nwhich describes\", this definitely is an improvement.\n\nThanks, will queue.\n"}]}