summaryrefslogtreecommitdiff
path: root/Documentation/git-tag.txt
blob: e1c76c600df3ae5fa78770b30f1309993b3e9326 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
git-tag(1)
==========
 
NAME
----
git-tag -  Create a tag object signed with GPG
 
 
SYNOPSIS
--------
[verse]
'git-tag' [-a | -s | -u <key-id>] [-f | -d] [-m <msg>] <name> [<head>]
'git-tag' -l [<pattern>]
 
DESCRIPTION
-----------
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 <key-id>` is passed, the command
creates a 'tag' object, and requires the tag message.  Unless
`-m <msg>` is given, an editor is started for the user to type
in the tag message.
 
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
<key-id>` is used.  When `-u <key-id>` is not used, the
committer identity for the current user is used to find the
GnuPG key for signing.
 
`-d <tag>` deletes the tag.
 
`-l <pattern>` 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 <key-id>::
	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 <pattern>::
	List tags that match the given pattern (or all if no pattern is given).
 
-m <msg>::
	Use the given tag message (instead of prompting)
 
 
Author
------
Written by Linus Torvalds <torvalds@osdl.org>,
Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
 
Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
 
GIT
---
Part of the gitlink:git[7] suite