* git-describe manual page's one sentence summary is misleading
@ 2015-06-16 10:45 Albert Netymk
2015-06-16 13:16 ` [PATCH] Documentation/describe: improve one-line summary Matthieu Moy
0 siblings, 1 reply; 3+ messages in thread
From: Albert Netymk @ 2015-06-16 10:45 UTC (permalink / raw)
To: git
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH] Documentation/describe: improve one-line summary
2015-06-16 10:45 git-describe manual page's one sentence summary is misleading Albert Netymk
@ 2015-06-16 13:16 ` Matthieu Moy
2015-06-16 20:21 ` Junio C Hamano
0 siblings, 1 reply; 3+ messages in thread
From: Matthieu Moy @ 2015-06-16 13:16 UTC (permalink / raw)
To: gitster, albertnetymk; +Cc: git, Matthieu Moy
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 <albertnetymk@gmail.com>
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr>
---
> 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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] Documentation/describe: improve one-line summary
2015-06-16 13:16 ` [PATCH] Documentation/describe: improve one-line summary Matthieu Moy
@ 2015-06-16 20:21 ` Junio C Hamano
0 siblings, 0 replies; 3+ messages in thread
From: Junio C Hamano @ 2015-06-16 20:21 UTC (permalink / raw)
To: Matthieu Moy; +Cc: albertnetymk, git
Matthieu Moy <Matthieu.Moy@imag.fr> 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.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2015-06-16 20:21 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-06-16 10:45 git-describe manual page's one sentence summary is misleading Albert Netymk
2015-06-16 13:16 ` [PATCH] Documentation/describe: improve one-line summary Matthieu Moy
2015-06-16 20:21 ` Junio C Hamano
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.