git-tag.txt: list all modes in the description
Currently, the description sounds as if it applied always, but most of its content is true in "create tag mode" only. Make this clearer by listing all modes upfront. Also, sneak in some linguistic improvements and make it clearer that lightweight tags are "created" because "written" may be misread as "are output". Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael J Gruber committed
Feb 15, 2011 at 14:09 UTC
cfb5e6b2da96c7803aa4a3813d27d2cbb47cda9e
1 file changed
+6
-5
Documentation/git-tag.txt
+6
-5
@@ -18,21 +18,22 @@ SYNOPSIS
18
DESCRIPTION
19
-----------
20
21
-Adds a tag reference in `.git/refs/tags/`.
21
+Add a tag reference in `.git/refs/tags/`, unless `-d/-l/-v` is given
22
+to delete, list or verify tags.
23
23
-Unless `-f` is given, the tag must not yet exist in
24
+Unless `-f` is given, the tag to be created must not yet exist in the
25
`.git/refs/tags/` directory.
26
27
If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
27
-creates a 'tag' object, and requires the tag message. Unless
28
+creates a 'tag' object, and requires a tag message. Unless
29
`-m <msg>` or `-F <file>` is given, an editor is started for the user to type
30
in the tag message.
31
32
If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
33
are absent, `-a` is implied.
34
34
-Otherwise just the SHA1 object name of the commit object is
35
-written (i.e. a lightweight tag).
35
+Otherwise just a tag reference for the SHA1 object name of the commit object is
36
+created (i.e. a lightweight tag).
37
38
A GnuPG signed tag object will be created when `-s` or `-u
39
<key-id>` is used. When `-u <key-id>` is not used, the