X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=Documentation%2Fgit-tag.txt;h=3984812cecc4453b4f3fb84f017f3cd4c50751cb;hb=6ddc0964034342519a87fe013781abf31c6db6ad;hp=e11f51c266a76c6a5b09e99bc4900b64e640ea67;hpb=fb8024b414b417d85ce215eba3dd23c188500c15;p=git.git diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index e11f51c2..3984812c 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -8,19 +8,27 @@ git-tag - Create a tag object signed with GPG SYNOPSIS -------- -'git-tag' [-a | -s] [-f] [-m ] [] +'git-tag' [-a | -s | -u ] [-f] [-m ] [] 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" +Unless `-f` is given, the tag must not yet exist in +`.git/refs/tags/` directory. -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. +If one of `-a`, `-s`, or `-u ` is passed, the command +creates a 'tag' object, and requires the tag message. Unless +`-m ` is given, an editor is started for the user to type +in the tag message. -A GnuPG signed tag object will be created when "-s" is used. +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` or `-u +` is used. When `-u ` is not used, the +committer identity for the current user is used to find the +GnuPG key for signing. Author