git tag documentation grammar fixes and readability updates
[git/git.git] / Documentation / git-tag.txt
CommitLineData
215a7ad1
JH
1git-tag(1)
2==========
2cf565c5
DG
3
4NAME
5----
453c1e85 6git-tag - Create, list, delete or verify a tag object signed with GPG
2cf565c5
DG
7
8
2cf565c5
DG
9SYNOPSIS
10--------
b867c7c2 11[verse]
a2d07d80 12'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]
b85e6c5f
NS
13 <tagname> [<commit> | <object>]
14'git tag' -d <tagname>...
32c35cfb 15'git tag' [-n[<num>]] -l [--contains <commit>] [<pattern>]
b85e6c5f 16'git tag' -v <tagname>...
2cf565c5
DG
17
18DESCRIPTION
19-----------
18b07930 20
cfb5e6b2
MG
21Add a tag reference in `.git/refs/tags/`, unless `-d/-l/-v` is given
22to delete, list or verify tags.
b7e438f9 23
cfb5e6b2 24Unless `-f` is given, the tag to be created must not yet exist in the
bc162e40 25`.git/refs/tags/` directory.
b7e438f9 26
bc162e40 27If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
cfb5e6b2 28creates a 'tag' object, and requires a tag message. Unless
62e09ce9 29`-m <msg>` or `-F <file>` is given, an editor is started for the user to type
bc162e40 30in the tag message.
b7e438f9 31
995e8df4
DS
32If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
33are absent, `-a` is implied.
34
cfb5e6b2
MG
35Otherwise just a tag reference for the SHA1 object name of the commit object is
36created (i.e. a lightweight tag).
bc162e40
LT
37
38A GnuPG signed tag object will be created when `-s` or `-u
39<key-id>` is used. When `-u <key-id>` is not used, the
40committer identity for the current user is used to find the
41GnuPG key for signing.
2cf565c5 42
d839091d
NW
43OPTIONS
44-------
45-a::
46 Make an unsigned, annotated tag object
47
48-s::
49 Make a GPG-signed tag, using the default e-mail address's key
50
51-u <key-id>::
52 Make a GPG-signed tag, using the given key
53
54-f::
f7aec129 55--force::
d839091d
NW
56 Replace an existing tag with the given name (instead of failing)
57
58-d::
453c1e85 59 Delete existing tags with the given names.
d839091d 60
0bc72abd 61-v::
62e09ce9 62 Verify the gpg signature of the given tag names.
0bc72abd 63
3f36cbba 64-n<num>::
980ea5c5
MM
65 <num> specifies how many lines from the annotation, if any,
66 are printed when using -l.
67 The default is not to print any annotation lines.
62e09ce9 68 If no number is given to `-n`, only the first line is printed.
abfd5fa8 69 If the tag is not annotated, the commit message is displayed instead.
980ea5c5 70
b867c7c2 71-l <pattern>::
980ea5c5 72 List tags with names that match the given pattern (or all if no pattern is given).
62e09ce9 73 Typing "git tag" without arguments, also lists all tags.
b867c7c2 74
32c35cfb
JG
75--contains <commit>::
76 Only list tags which contain the specified commit.
77
d839091d 78-m <msg>::
bd46c9a9 79 Use the given tag message (instead of prompting).
d99bf51a 80 If multiple `-m` options are given, their values are
bd46c9a9 81 concatenated as separate paragraphs.
995e8df4
DS
82 Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
83 is given.
d839091d 84
f79c73ce
JS
85-F <file>::
86 Take the tag message from the given file. Use '-' to
87 read the message from the standard input.
995e8df4
DS
88 Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
89 is given.
2cf565c5 90
b85e6c5f
NS
91<tagname>::
92 The name of the tag to create, delete, or describe.
93 The new tag name must pass all checks defined by
94 linkgit:git-check-ref-format[1]. Some of these checks
95 may restrict the characters allowed in a tag name.
96
d67778ec
AP
97CONFIGURATION
98-------------
0b444cdb 99By default, 'git tag' in sign-with-default mode (-s) will use your
d67778ec
AP
100committer identity (of the form "Your Name <your@email.address>") to
101find a key. If you want to use a different default key, you can specify
102it in the repository configuration as follows:
103
86b9e017 104-------------------------------------
d67778ec
AP
105[user]
106 signingkey = <gpg-key-id>
86b9e017 107-------------------------------------
d67778ec 108
4853534e
JH
109
110DISCUSSION
111----------
112
113On Re-tagging
114~~~~~~~~~~~~~
115
116What should you do when you tag a wrong commit and you would
117want to re-tag?
118
119If you never pushed anything out, just re-tag it. Use "-f" to
120replace the old one. And you're done.
121
122But if you have pushed things out (or others could just read
123your repository directly), then others will have already seen
124the old tag. In that case you can do one of two things:
125
126. The sane thing.
127Just admit you screwed up, and use a different name. Others have
128already seen one tag-name, and if you keep the same name, you
129may be in the situation that two people both have "version X",
130but they actually have 'different' "X"'s. So just call it "X.1"
131and be done with it.
132
133. The insane thing.
134You really want to call the new version "X" too, 'even though'
0b444cdb 135others have already seen the old one. So just use 'git tag -f'
4853534e
JH
136again, as if you hadn't already published the old one.
137
06ada152 138However, Git does *not* (and it should not) change tags behind
46e56e81 139users back. So if somebody already got the old tag, doing a
0b444cdb 140'git pull' on your tree shouldn't just make them overwrite the old
4853534e
JH
141one.
142
143If somebody got a release tag from you, you cannot just change
144the tag for them by updating your own one. This is a big
145security issue, in that people MUST be able to trust their
146tag-names. If you really want to do the insane thing, you need
147to just fess up to it, and tell people that you messed up. You
148can do that by making a very public announcement saying:
149
150------------
151Ok, I messed up, and I pushed out an earlier version tagged as X. I
152then fixed something, and retagged the *fixed* tree as X again.
153
154If you got the wrong tag, and want the new one, please delete
155the old one and fetch the new one by doing:
156
157 git tag -d X
158 git fetch origin tag X
159
160to get my updated tag.
161
162You can test which tag you have by doing
163
164 git rev-parse X
165
166which should return 0123456789abcdef.. if you have the new version.
167
f1723ee6 168Sorry for the inconvenience.
4853534e
JH
169------------
170
171Does this seem a bit complicated? It *should* be. There is no
f1723ee6
MW
172way that it would be correct to just "fix" it automatically.
173People need to know that their tags might have been changed.
4853534e
JH
174
175
176On Automatic following
177~~~~~~~~~~~~~~~~~~~~~~
178
179If you are following somebody else's tree, you are most likely
8b3f3f84 180using remote-tracking branches (`refs/heads/origin` in traditional
4853534e
JH
181layout, or `refs/remotes/origin/master` in the separate-remote
182layout). You usually want the tags from the other end.
183
184On the other hand, if you are fetching because you would want a
185one-shot merge from somebody else, you typically do not want to
186get tags from there. This happens more often for people near
187the toplevel but not limited to them. Mere mortals when pulling
188from each other do not necessarily want to automatically get
189private anchor point tags from the other person.
190
f1723ee6
MW
191Often, "please pull" messages on the mailing list just provide
192two pieces of information: a repo URL and a branch name; this
193is designed to be easily cut&pasted at the end of a 'git fetch'
194command line:
4853534e
JH
195
196------------
197Linus, please pull from
198
199 git://git..../proj.git master
200
201to get the following updates...
202------------
203
204becomes:
205
206------------
207$ git pull git://git..../proj.git master
208------------
209
f1723ee6
MW
210In such a case, you do not want to automatically follow the other
211person's tags.
4853534e 212
f1723ee6
MW
213One important aspect of git is its distributed nature, which
214largely means there is no inherent "upstream" or
4853534e
JH
215"downstream" in the system. On the face of it, the above
216example might seem to indicate that the tag namespace is owned
f1723ee6 217by the upper echelon of people and that tags only flow downwards, but
4853534e
JH
218that is not the case. It only shows that the usage pattern
219determines who are interested in whose tags.
220
221A one-shot pull is a sign that a commit history is now crossing
222the boundary between one circle of people (e.g. "people who are
d99bf51a 223primarily interested in the networking part of the kernel") who may
4853534e
JH
224have their own set of tags (e.g. "this is the third release
225candidate from the networking group to be proposed for general
226consumption with 2.6.21 release") to another circle of people
227(e.g. "people who integrate various subsystem improvements").
228The latter are usually not interested in the detailed tags used
229internally in the former group (that is what "internal" means).
230That is why it is desirable not to follow tags automatically in
231this case.
232
233It may well be that among networking people, they may want to
234exchange the tags internal to their group, but in that workflow
f1723ee6 235they are most likely tracking each other's progress by
8b3f3f84 236having remote-tracking branches. Again, the heuristic to automatically
4853534e
JH
237follow such tags is a good thing.
238
239
5040beff
MO
240On Backdating Tags
241~~~~~~~~~~~~~~~~~~
242
243If you have imported some changes from another VCS and would like
244to add tags for major releases of your work, it is useful to be able
f1723ee6 245to specify the date to embed inside of the tag object; such data in
5040beff
MO
246the tag object affects, for example, the ordering of tags in the
247gitweb interface.
248
249To set the date used in future tag objects, set the environment
f1723ee6
MW
250variable GIT_COMMITTER_DATE (see the later discussion of possible
251values; the most common form is "YYYY-MM-DD HH:MM").
5040beff 252
f1723ee6 253For example:
5040beff
MO
254
255------------
055b6615 256$ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
5040beff
MO
257------------
258
f1723ee6 259include::date-formats.txt[]
5040beff 260
b85e6c5f
NS
261SEE ALSO
262--------
263linkgit:git-check-ref-format[1].
264
2cf565c5
DG
265Author
266------
3f971fc4 267Written by Linus Torvalds <torvalds@osdl.org>,
59eb68aa 268Junio C Hamano <gitster@pobox.com> and Chris Wright <chrisw@osdl.org>.
2cf565c5
DG
269
270Documentation
271--------------
272Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
273
274GIT
275---
9e1f0a85 276Part of the linkgit:git[1] suite