X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-tag.txt;h=841c9dcf97e3464753818b7e2b49b5e6594c2364;hb=8bf14d6ef9245f3b81d24cb7725a868f62343277;hp=1e0d4f5f46da084d7a956958f85cbff22c10de30;hpb=c1067050ce58b5b39f528fe634732da858664603;p=git.git diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 1e0d4f5f..841c9dcf 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -1,28 +1,56 @@ git-tag(1) ========== -v0.99.4, Aug 2005 NAME ---- git-tag - Create a tag object signed with GPG - SYNOPSIS -------- -'git-tag' [-s | -a] [-f] +'git-tag' [-a | -s | -u ] [-f | -d] [-m ] [] + +OPTIONS +------- +-a:: + Make an unsigned, annotated tag object + +-s:: + Make a GPG-signed tag, using the default e-mail address's key + +-u :: + Make a GPG-signed tag, using the given key + +-f:: + Replace an existing tag with the given name (instead of failing) + +-d:: + Delete an existing tag with the given name + +-m :: + Use the given tag message (instead of prompting) 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/` directory. + +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. -Unless "-f" is given, the tag must not yet exist in ".git/refs/tags" +Otherwise just the SHA1 object name of the commit object is +written (i.e. a lightweight tag). -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. +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. -A GnuPG signed tag object will be created when "-s" is used. +`-d ` deletes the tag. Author