diff options
| author | Daniele Segato <daniele.segato@gmail.com> | 2013-07-26 15:06:02 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-07-29 08:03:33 -0700 |
| commit | 29d55538b78fa8d916b99aef9a4b1e376df2dac0 (patch) | |
| tree | 03bc1ced5a7d92577984ba2aa50a62d0509d90fb /Documentation | |
| parent | 15999998fbda60552742275570947431b57108ae (diff) | |
| download | git-29d55538b78fa8d916b99aef9a4b1e376df2dac0.tar.gz | |
docs/git-tag: explain lightweight versus annotated tagsds/doc-two-kinds-of-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 <daniele.segato@gmail.com>
Signed-off-by: Jeff King <peff@peff.net>
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-tag.txt | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 6470cffd32..6d01e6f77b 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -42,6 +42,17 @@ committer identity for the current user is used to find the 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 ------- |