Re: [PATCHv3] git-tag man: when to use lightweight or annotated tags

Marc Branchaud [off-list ref] writes:

On 13-07-26 03:06 PM, Jeff King wrote:

quoted

On Fri, Jul 26, 2013 at 07:33:01PM +0200, Daniele Segato wrote:

quoted

stress the difference between the two with suggestion on when the user
should use one in place of the other.

Signed-off-by: Daniele Segato <redacted>

The intent of your patch seems reasonable to me. There are a few minor
language and typographical mistakes, and the patch itself is
whitespace-damaged.

I also do not know that it is accurate to say "most git commands ignore
lightweight tags". It is really only "naming" ones like "git describe".

Here is a re-send of your patch with the fixups I would recommend.

I'm happy with Peff's version.

Reviewed-by: Marc Branchaud <redacted>

(Daniele, don't feel put off because Jonathan & I are accepting Peff's text.
 If you think it still needs improving please speak up!)

		M.

Thank you all.  Will apply.

quoted

-- >8 --
From: Daniele Segato <redacted>
Subject: [PATCH] docs/git-tag: explain lightweight versus annotated tags

Stress the difference between the two with a suggestion on
when the user should use one in place of the other.

Signed-off-by: Daniele Segato <redacted>
Signed-off-by: Jeff King <redacted>
---
 Documentation/git-tag.txt | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 22894cb..c418c44 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt

@@ -42,6 +42,17 @@ is used to specify custom GnuPG binary.
 GnuPG key for signing. 	The configuration variable `gpg.program`
 is used to specify custom GnuPG binary.
 
+Tag objects (created with `-a`, `s`, or `-u`) are called "annotated"
+tags; they contain a creation date, the tagger name and e-mail, a
+tagging message, and an optional GnuPG signature. Whereas a
+"lightweight" tag is simply a name for an object (usually a commit
+object).
+
+Annotated tags are meant for release while lightweight tags are meant
+for private or temporary object labels. For this reason, some git
+commands for naming objects (like `git describe`) will ignore
+lightweight tags by default.
+
 
 OPTIONS
 -------