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