Merge branch 'kn/gitweb-extra-branch-refs'
[gitweb.git] / Documentation / git-tag.txt
index 22894cbee6794fd738cf45aefefff0679dcb940d..c418c44d40d1494d2f87d6ed45c229a56064f0b3 100644 (file)
@@ -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
 -------