From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: gitster@pobox.com, albertnetymk@gmail.com
Cc: git@vger.kernel.org, Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH] Documentation/describe: improve one-line summary
Date: Tue, 16 Jun 2015 15:16:38 +0200 [thread overview]
Message-ID: <1434460598-23201-1-git-send-email-Matthieu.Moy@imag.fr> (raw)
In-Reply-To: <CAKEGsXTY_rstoK4Gcga6XqkqKCeOkXdL-TjAWUu0Cqi6mWW7bA@mail.gmail.com>
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
next prev parent reply other threads:[~2015-06-16 13:16 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-06-16 10:45 git-describe manual page's one sentence summary is misleading Albert Netymk
2015-06-16 13:16 ` Matthieu Moy [this message]
2015-06-16 20:21 ` [PATCH] Documentation/describe: improve one-line summary Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1434460598-23201-1-git-send-email-Matthieu.Moy@imag.fr \
--to=matthieu.moy@imag.fr \
--cc=albertnetymk@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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.