summaryrefslogtreecommitdiff
path: root/Documentation/git-tag.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-tag.txt')
-rw-r--r--Documentation/git-tag.txt24
1 files changed, 15 insertions, 9 deletions
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 1e0d4f5..3984812 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -1,28 +1,34 @@
git-tag(1)
==========
-v0.99.4, Aug 2005
NAME
----
git-tag - Create a tag object signed with GPG
-
SYNOPSIS
--------
-'git-tag' [-s | -a] [-f] <name>
+'git-tag' [-a | -s | -u <key-id>] [-f] [-m <msg>] <name> [<head>]
DESCRIPTION
-----------
-Adds a "tag" reference in .git/refs/tags/
+Adds a 'tag' reference in .git/refs/tags/
+
+Unless `-f` is given, the tag must not yet exist in
+`.git/refs/tags/` directory.
-Unless "-f" is given, the tag must not yet exist in ".git/refs/tags"
+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.
-If "-s" or "-a" is passed, the user will be prompted for a tag message.
-and a tag object is created. Otherwise just the SHA1 object
-name of the commit object is written.
+Otherwise just the SHA1 object name of the commit object is
+written (i.e. an lightweight tag).
-A GnuPG signed tag object will be created when "-s" is used.
+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
+GnuPG key for signing.
Author