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 <[email protected]> Signed-off-by: Matthieu Moy <[email protected]> --- > 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 -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
