Commit cfb5e6b2 authored by Michael J Gruber's avatar Michael J Gruber Committed by Junio C Hamano

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: default avatarMichael J Gruber <[email protected]>
Signed-off-by: default avatarJunio C Hamano <[email protected]>
parent 8547090c
......@@ -18,21 +18,22 @@ SYNOPSIS
DESCRIPTION
-----------
Adds a tag reference in `.git/refs/tags/`.
Add a tag reference in `.git/refs/tags/`, unless `-d/-l/-v` is given
to delete, list or verify tags.
Unless `-f` is given, the tag must not yet exist in
Unless `-f` is given, the tag to be created must not yet exist in the
`.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
creates a 'tag' object, 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.
If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
are absent, `-a` is implied.
Otherwise just the SHA1 object name of the commit object is
written (i.e. a lightweight tag).
Otherwise just a tag reference for the SHA1 object name of the commit object is
created (i.e. a lightweight tag).
A GnuPG signed tag object will be created when `-s` or `-u
<key-id>` is used. When `-u <key-id>` is not used, the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment