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 <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>
Daniele Segato committed
Jul 26, 2013 at 15:06 UTC
29d55538b78fa8d916b99aef9a4b1e376df2dac0
1 file changed
+11
Documentation/git-tag.txt
+11
@@ -42,6 +42,17 @@ committer identity for the current user is used to find the
42
GnuPG key for signing. The configuration variable `gpg.program`
43
is used to specify custom GnuPG binary.
44
45
+Tag objects (created with `-a`, `s`, or `-u`) are called "annotated"
46
+tags; they contain a creation date, the tagger name and e-mail, a
47
+tagging message, and an optional GnuPG signature. Whereas a
48
+"lightweight" tag is simply a name for an object (usually a commit
49
+object).
50
+
51
+Annotated tags are meant for release while lightweight tags are meant
52
+for private or temporary object labels. For this reason, some git
53
+commands for naming objects (like `git describe`) will ignore
54
+lightweight tags by default.
55
+
56
57
OPTIONS
58
-------