[PATCH] git-tag: Document that -m/-F create tag objects, too
From: Florian Weimer <hidden>
Date: 2016-06-15 22:43:03
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
And warn about the fact that lightweight tags are not normally transferred by clone/fetch. Signed-off-by: Florian Weimer <redacted> --- Documentation/git-tag.txt | 16 +++++++++------- 1 files changed, 9 insertions(+), 7 deletions(-)
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 70235e8..fc5f4e3 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt@@ -20,13 +20,15 @@ Adds a 'tag' reference in `.git/refs/tags/` Unless `-f` is given, the tag must not yet exist in `.git/refs/tags/` directory. -If one of `-a`, `-s`, or `-u <key-id>` is passed, the command -creates a 'tag' object, and requires the tag message. Unless -`-m <msg>` is given, an editor is started for the user to type -in the tag message. - -Otherwise just the SHA1 object name of the commit object is -written (i.e. a lightweight tag). +If one of `-a`, `-m <msg>`, `-F <file>`, `-s`, or `-u <key-id>` is +passed, the command creates a 'tag' object. Unless `-m <msg>` or `-F +<file>` is given, an editor is started for the user to type in the tag +message. + +Otherwise just the SHA1 object name of the commit object is written +(i.e. a lightweight tag). Note that such tags are not automatically +copied by "git-clone" and "git-fetch", so you want to use them for +local tags only. A GnuPG signed tag object will be created when `-s` or `-u <key-id>` is used. When `-u <key-id>` is not used, the
--
1.5.1