# git-describe manual page's one sentence summary is misleading 3 messages from 2015-06-16 to 2015-06-16. Participants: Albert Netymk, Matthieu Moy, Junio C Hamano. Thread: https://gitlist.dev/t/39643 ## Albert Netymk, 2015-06-16 10:45 Subject: git-describe manual page's one sentence summary is misleading Message-ID: URL: https://gitlist.dev/e/CAKEGsXTY_rstoK4Gcga6XqkqKCeOkXdL-TjAWUu0Cqi6mWW7bA%40mail.gmail.com ``` According to the man of git-describe, http://git-scm.com/docs/git-describe git-describe - Show the most recent tag that is reachable from a commit It means that this command shows the name of the most recent tag. However, actually, it construct a new tag name if the current commit is not tagged. I think, "git-describe - Describe a commit using the most recent tag reachable from it" is a better summary. -- Best Regards Yours faithfully Albert Netymk ``` ## Matthieu Moy, 2015-06-16 13:16 Subject: [PATCH] Documentation/describe: improve one-line summary Message-ID: <1434460598-23201-1-git-send-email-Matthieu.Moy@imag.fr> URL: https://gitlist.dev/e/1434460598-23201-1-git-send-email-Matthieu.Moy%40imag.fr In-Reply-To: ``` git describe does not show 'the most recent tag that is reachable from a commit', but a descriptive name based on this tag. Fix the description to reflect that. Suggested-by: Albert Netymk Signed-off-by: Matthieu Moy --- > According to the man of git-describe, http://git-scm.com/docs/git-describe > > git-describe - Show the most recent tag that is reachable from a commit > > It means that this command shows the name of the most recent tag. > > However, actually, it construct a new tag name if the current commit > is not tagged. > > I think, "git-describe - Describe a commit using the most recent tag > reachable from it" is a better summary. Indeed. Here's a patch fixing this. Documentation/git-describe.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index d20ca40..e045fc7 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -3,7 +3,7 @@ git-describe(1) NAME ---- -git-describe - Show the most recent tag that is reachable from a commit +git-describe - Describe a commit using the most recent tag reachable from it SYNOPSIS -- 2.4.1.171.g060e6ae.dirty ``` ## Junio C Hamano, 2015-06-16 20:21 Subject: Re: [PATCH] Documentation/describe: improve one-line summary Message-ID: URL: https://gitlist.dev/e/xmqqk2v35rr7.fsf%40gitster.dls.corp.google.com In-Reply-To: <1434460598-23201-1-git-send-email-Matthieu.Moy@imag.fr> ``` Matthieu Moy writes: > diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt > index d20ca40..e045fc7 100644 > --- a/Documentation/git-describe.txt > +++ b/Documentation/git-describe.txt > @@ -3,7 +3,7 @@ git-describe(1) > > NAME > ---- > -git-describe - Show the most recent tag that is reachable from a commit > +git-describe - Describe a commit using the most recent tag reachable from it While it feels a bit funny to describe a "describe" command as "that which describes", this definitely is an improvement. Thanks, will queue. ```