X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;f=Documentation%2Fgit-tag.txt;h=1eafeef473bc6e3159c48290ddd168d8f1e5c1ef;hb=d1c5f2a42d7b5c0e3d3862212dea1f09809c4963;hp=1e0d4f5f46da084d7a956958f85cbff22c10de30;hpb=dbc37438687e110697574d175e4eca5f9cbeae81;p=git.git diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 1e0d4f5f..1eafeef4 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -10,19 +10,27 @@ git-tag - Create a tag object signed with GPG SYNOPSIS -------- -'git-tag' [-s | -a] [-f] +'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