summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2013-07-31 12:38:21 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2013-07-31 12:38:21 -0700
commit652d2bfa83e92d871eb034e13fd811fbd402c3f1 (patch)
tree8677166b55947468619583f76b20f085e55b0306
parentMerge branch 'rr/maint-tilde-markup-in-doc' (diff)
parentdocs/git-tag: explain lightweight versus annotated tags (diff)
downloadtgif-652d2bfa83e92d871eb034e13fd811fbd402c3f1.tar.xz
Merge branch 'ds/doc-two-kinds-of-tags'
* ds/doc-two-kinds-of-tags: docs/git-tag: explain lightweight versus annotated tags
-rw-r--r--Documentation/git-tag.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 22894cbee6..c418c44d40 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
-------