Skip to content

Commit cfb5e6b

Browse files
Michael J Grubergitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 8547090 commit cfb5e6b

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Documentation/git-tag.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,22 @@ SYNOPSIS
1818
DESCRIPTION
1919
-----------
2020

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.
2223

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
2425
`.git/refs/tags/` directory.
2526

2627
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
2829
`-m <msg>` or `-F <file>` is given, an editor is started for the user to type
2930
in the tag message.
3031

3132
If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
3233
are absent, `-a` is implied.
3334

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).
3637

3738
A GnuPG signed tag object will be created when `-s` or `-u
3839
<key-id>` is used. When `-u <key-id>` is not used, the

0 commit comments

Comments
 (0)