git-describe manual page's one sentence summary is misleading

2 messages, 2 authors, 2016-06-15 · open the first message on its own page

git-describe manual page's one sentence summary is misleading

From: Albert Netymk <hidden>
Date: 2016-06-15 23:05:20

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

[PATCH] Documentation/describe: improve one-line summary

From: Matthieu Moy <hidden>
Date: 2016-06-15 23:05:20

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 <redacted>
Signed-off-by: Matthieu Moy <redacted>
---
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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help