Merge commit 'refs/top-bases/girocco' into girocco
[git/repo.git] / Documentation / git-tag.txt
blob046ab3542bab4048fe07c8a6718d63f9cd9e3791
1 git-tag(1)
2 ==========
4 NAME
5 ----
6 git-tag - Create, list, delete or verify a tag object signed with GPG
9 SYNOPSIS
10 --------
11 [verse]
12 'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]
13         <name> [<commit> | <object>]
14 'git tag' -d <name>...
15 'git tag' [-n[<num>]] -l [<pattern>]
16 'git tag' -v <name>...
18 DESCRIPTION
19 -----------
20 Adds a 'tag' reference in `.git/refs/tags/`
22 Unless `-f` is given, the tag must not yet exist in
23 `.git/refs/tags/` directory.
25 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
26 creates a 'tag' object, and requires the tag message.  Unless
27 `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
28 in the tag message.
30 If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
31 are absent, `-a` is implied.
33 Otherwise just the SHA1 object name of the commit object is
34 written (i.e. a lightweight tag).
36 A GnuPG signed tag object will be created when `-s` or `-u
37 <key-id>` is used.  When `-u <key-id>` is not used, the
38 committer identity for the current user is used to find the
39 GnuPG key for signing.
41 OPTIONS
42 -------
43 -a::
44         Make an unsigned, annotated tag object
46 -s::
47         Make a GPG-signed tag, using the default e-mail address's key
49 -u <key-id>::
50         Make a GPG-signed tag, using the given key
52 -f::
53         Replace an existing tag with the given name (instead of failing)
55 -d::
56         Delete existing tags with the given names.
58 -v::
59         Verify the gpg signature of the given tag names.
61 -n<num>::
62         <num> specifies how many lines from the annotation, if any,
63         are printed when using -l.
64         The default is not to print any annotation lines.
65         If no number is given to `-n`, only the first line is printed.
67 -l <pattern>::
68         List tags with names that match the given pattern (or all if no pattern is given).
69         Typing "git tag" without arguments, also lists all tags.
71 -m <msg>::
72         Use the given tag message (instead of prompting).
73         If multiple `-m` options are given, there values are
74         concatenated as separate paragraphs.
75         Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
76         is given.
78 -F <file>::
79         Take the tag message from the given file.  Use '-' to
80         read the message from the standard input.
81         Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
82         is given.
84 CONFIGURATION
85 -------------
86 By default, 'git-tag' in sign-with-default mode (-s) will use your
87 committer identity (of the form "Your Name <your@email.address>") to
88 find a key.  If you want to use a different default key, you can specify
89 it in the repository configuration as follows:
91 -------------------------------------
92 [user]
93     signingkey = <gpg-key-id>
94 -------------------------------------
97 DISCUSSION
98 ----------
100 On Re-tagging
101 ~~~~~~~~~~~~~
103 What should you do when you tag a wrong commit and you would
104 want to re-tag?
106 If you never pushed anything out, just re-tag it. Use "-f" to
107 replace the old one. And you're done.
109 But if you have pushed things out (or others could just read
110 your repository directly), then others will have already seen
111 the old tag. In that case you can do one of two things:
113 . The sane thing.
114 Just admit you screwed up, and use a different name. Others have
115 already seen one tag-name, and if you keep the same name, you
116 may be in the situation that two people both have "version X",
117 but they actually have 'different' "X"'s.  So just call it "X.1"
118 and be done with it.
120 . The insane thing.
121 You really want to call the new version "X" too, 'even though'
122 others have already seen the old one. So just use 'git-tag -f'
123 again, as if you hadn't already published the old one.
125 However, Git does *not* (and it should not) change tags behind
126 users back. So if somebody already got the old tag, doing a
127 'git-pull' on your tree shouldn't just make them overwrite the old
128 one.
130 If somebody got a release tag from you, you cannot just change
131 the tag for them by updating your own one. This is a big
132 security issue, in that people MUST be able to trust their
133 tag-names.  If you really want to do the insane thing, you need
134 to just fess up to it, and tell people that you messed up. You
135 can do that by making a very public announcement saying:
137 ------------
138 Ok, I messed up, and I pushed out an earlier version tagged as X. I
139 then fixed something, and retagged the *fixed* tree as X again.
141 If you got the wrong tag, and want the new one, please delete
142 the old one and fetch the new one by doing:
144         git tag -d X
145         git fetch origin tag X
147 to get my updated tag.
149 You can test which tag you have by doing
151         git rev-parse X
153 which should return 0123456789abcdef.. if you have the new version.
155 Sorry for inconvenience.
156 ------------
158 Does this seem a bit complicated?  It *should* be. There is no
159 way that it would be correct to just "fix" it behind peoples
160 backs. People need to know that their tags might have been
161 changed.
164 On Automatic following
165 ~~~~~~~~~~~~~~~~~~~~~~
167 If you are following somebody else's tree, you are most likely
168 using tracking branches (`refs/heads/origin` in traditional
169 layout, or `refs/remotes/origin/master` in the separate-remote
170 layout).  You usually want the tags from the other end.
172 On the other hand, if you are fetching because you would want a
173 one-shot merge from somebody else, you typically do not want to
174 get tags from there.  This happens more often for people near
175 the toplevel but not limited to them.  Mere mortals when pulling
176 from each other do not necessarily want to automatically get
177 private anchor point tags from the other person.
179 You would notice "please pull" messages on the mailing list says
180 repo URL and branch name alone.  This is designed to be easily
181 cut&pasted to a 'git-fetch' command line:
183 ------------
184 Linus, please pull from
186         git://git..../proj.git master
188 to get the following updates...
189 ------------
191 becomes:
193 ------------
194 $ git pull git://git..../proj.git master
195 ------------
197 In such a case, you do not want to automatically follow other's
198 tags.
200 One important aspect of git is it is distributed, and being
201 distributed largely means there is no inherent "upstream" or
202 "downstream" in the system.  On the face of it, the above
203 example might seem to indicate that the tag namespace is owned
204 by upper echelon of people and tags only flow downwards, but
205 that is not the case.  It only shows that the usage pattern
206 determines who are interested in whose tags.
208 A one-shot pull is a sign that a commit history is now crossing
209 the boundary between one circle of people (e.g. "people who are
210 primarily interested in networking part of the kernel") who may
211 have their own set of tags (e.g. "this is the third release
212 candidate from the networking group to be proposed for general
213 consumption with 2.6.21 release") to another circle of people
214 (e.g. "people who integrate various subsystem improvements").
215 The latter are usually not interested in the detailed tags used
216 internally in the former group (that is what "internal" means).
217 That is why it is desirable not to follow tags automatically in
218 this case.
220 It may well be that among networking people, they may want to
221 exchange the tags internal to their group, but in that workflow
222 they are most likely tracking with each other's progress by
223 having tracking branches.  Again, the heuristic to automatically
224 follow such tags is a good thing.
227 On Backdating Tags
228 ~~~~~~~~~~~~~~~~~~
230 If you have imported some changes from another VCS and would like
231 to add tags for major releases of your work, it is useful to be able
232 to specify the date to embed inside of the tag object.  The data in
233 the tag object affects, for example, the ordering of tags in the
234 gitweb interface.
236 To set the date used in future tag objects, set the environment
237 variable GIT_COMMITTER_DATE to one or more of the date and time.  The
238 date and time can be specified in a number of ways; the most common
239 is "YYYY-MM-DD HH:MM".
241 An example follows.
243 ------------
244 $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
245 ------------
248 Author
249 ------
250 Written by Linus Torvalds <torvalds@osdl.org>,
251 Junio C Hamano <gitster@pobox.com> and Chris Wright <chrisw@osdl.org>.
253 Documentation
254 --------------
255 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
259 Part of the linkgit:git[1] suite