From 34fdcb56e5784699ffa327ebfcd2c5cd99b61d2d Mon Sep 17 00:00:00 2001
From: Daniele Segato <daniele.segato@xxxxxxxxx>
Date: Thu, 25 Jul 2013 15:33:18 +0200
Subject: [PATCH] git-tag man: when to use lightweight or annotated tags
stress the difference between the two with suggestion on when the user
should use one in place of the other.
Signed-off-by: Daniele Segato <daniele.segato@xxxxxxxxx>
---
Documentation/git-tag.txt | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 22894cb..5c6284e 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -26,7 +26,7 @@ to delete, list or verify tags.
Unless `-f` is given, the named tag must not yet exist.
If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
-creates a 'tag' object, and requires a tag message. Unless
+creates a 'tag' object called 'Annotated tag', and requires a tag
message. Unless
`-m <msg>` or `-F <file>` is given, an editor is started for the user
to type
in the tag message.
@@ -36,6 +36,11 @@ are absent, `-a` is implied.
Otherwise just a tag reference for the SHA-1 object name of the commit
object is
created (i.e. a lightweight tag).
+'Annotated' and 'Lightweight' tags are not the same thing for git and
you shouldn't
+mix them up. Annotated tags are meant for release while lightweight
tags are
+meant for private or temporary object labels. Most git commands only
consider
+Annotated tags by default.
+
A GnuPG signed tag object will be created when `-s` or `-u
<key-id>` is used. When `-u <key-id>` is not used, the
committer identity for the current user is used to find the
--
1.7.10.4
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html