X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-tag.txt;h=45476c2e415112347372f034276dec367f7a6a8d;hb=975bf9cf5ad5d440f98f464ae8124609a4835ce1;hp=e11f51c266a76c6a5b09e99bc4900b64e640ea67;hpb=2af60a0521a8d0514e8bb1ca371cc9d502ea1c58;p=git.git diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index e11f51c2..45476c2e 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -3,24 +3,62 @@ git-tag(1) NAME ---- -git-tag - Create a tag object signed with GPG +git-tag - Create a tag object signed with GPG SYNOPSIS -------- -'git-tag' [-a | -s] [-f] [-m ] [] +[verse] +'git-tag' [-a | -s | -u ] [-f | -d] [-m ] [] +'git-tag' -l [] 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. a 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. + +`-d ` deletes the tag. + +`-l ` lists tags that match the given pattern (or all +if no pattern is given). + +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 + +-l :: + List tags that match the given pattern (or all if no pattern is given). + +-m :: + Use the given tag message (instead of prompting) Author