Re: [PATCHv3] git-tag man: when to use lightweight or annotated tags
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- Jul 26, 2013, 19:36 UTC
- Message-ID
- <20130726193643.GH14690@google.com>
- In-Reply-To
- <20130726190602.GC29799@sigill.intra.peff.net>
Jeff King wrote:
Show 16 quoted lines
> --- 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.
Very readable, and I think this is a good start.
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Eventually the description section should probably be tweaked to start by explaining what the command is actually for. ;-)