dir.h: move struct exclude declaration to top level
[git.git] / Documentation / git-tag.txt
blobb424a1bc48bba96513da17ee63bee4383453c3b4
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         <tagname> [<commit> | <object>]
14 'git tag' -d <tagname>...
15 'git tag' [-n[<num>]] -l [--contains <commit>] [--points-at <object>]
16         [--column[=<options>] | --no-column] [<pattern>...]
17         [<pattern>...]
18 'git tag' -v <tagname>...
20 DESCRIPTION
21 -----------
23 Add a tag reference in `refs/tags/`, unless `-d/-l/-v` is given
24 to delete, list or verify tags.
26 Unless `-f` is given, the named tag must not yet exist.
28 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
29 creates a 'tag' object, and requires a tag message.  Unless
30 `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
31 in the tag message.
33 If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
34 are absent, `-a` is implied.
36 Otherwise just a tag reference for the SHA-1 object name of the commit object is
37 created (i.e. a lightweight tag).
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
42 GnuPG key for signing.  The configuration variable `gpg.program`
43 is used to specify custom GnuPG binary.
45 Tag objects (created with `-a`, `s`, or `-u`) are called "annotated"
46 tags; they contain a creation date, the tagger name and e-mail, a
47 tagging message, and an optional GnuPG signature. Whereas a
48 "lightweight" tag is simply a name for an object (usually a commit
49 object).
51 Annotated tags are meant for release while lightweight tags are meant
52 for private or temporary object labels. For this reason, some git
53 commands for naming objects (like `git describe`) will ignore
54 lightweight tags by default.
57 OPTIONS
58 -------
59 -a::
60 --annotate::
61         Make an unsigned, annotated tag object
63 -s::
64 --sign::
65         Make a GPG-signed tag, using the default e-mail address's key.
67 -u <key-id>::
68 --local-user=<key-id>::
69         Make a GPG-signed tag, using the given key.
71 -f::
72 --force::
73         Replace an existing tag with the given name (instead of failing)
75 -d::
76 --delete::
77         Delete existing tags with the given names.
79 -v::
80 --verify::
81         Verify the gpg signature of the given tag names.
83 -n<num>::
84         <num> specifies how many lines from the annotation, if any,
85         are printed when using -l.
86         The default is not to print any annotation lines.
87         If no number is given to `-n`, only the first line is printed.
88         If the tag is not annotated, the commit message is displayed instead.
90 -l <pattern>::
91 --list <pattern>::
92         List tags with names that match the given pattern (or all if no
93         pattern is given).  Running "git tag" without arguments also
94         lists all tags. The pattern is a shell wildcard (i.e., matched
95         using fnmatch(3)).  Multiple patterns may be given; if any of
96         them matches, the tag is shown.
98 --sort=<type>::
99         Sort in a specific order. Supported type is "refname"
100         (lexicographic order), "version:refname" or "v:refname" (tag
101         names are treated as versions). Prepend "-" to reverse sort
102         order.
104 --column[=<options>]::
105 --no-column::
106         Display tag listing in columns. See configuration variable
107         column.tag for option syntax.`--column` and `--no-column`
108         without options are equivalent to 'always' and 'never' respectively.
110 This option is only applicable when listing tags without annotation lines.
112 --contains [<commit>]::
113         Only list tags which contain the specified commit (HEAD if not
114         specified).
116 --points-at <object>::
117         Only list tags of the given object.
119 -m <msg>::
120 --message=<msg>::
121         Use the given tag message (instead of prompting).
122         If multiple `-m` options are given, their values are
123         concatenated as separate paragraphs.
124         Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
125         is given.
127 -F <file>::
128 --file=<file>::
129         Take the tag message from the given file.  Use '-' to
130         read the message from the standard input.
131         Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
132         is given.
134 --cleanup=<mode>::
135         This option sets how the tag message is cleaned up.
136         The  '<mode>' can be one of 'verbatim', 'whitespace' and 'strip'.  The
137         'strip' mode is default. The 'verbatim' mode does not change message at
138         all, 'whitespace' removes just leading/trailing whitespace lines and
139         'strip' removes both whitespace and commentary.
141 <tagname>::
142         The name of the tag to create, delete, or describe.
143         The new tag name must pass all checks defined by
144         linkgit:git-check-ref-format[1].  Some of these checks
145         may restrict the characters allowed in a tag name.
147 <commit>::
148 <object>::
149         The object that the new tag will refer to, usually a commit.
150         Defaults to HEAD.
153 CONFIGURATION
154 -------------
155 By default, 'git tag' in sign-with-default mode (-s) will use your
156 committer identity (of the form "Your Name <\your@email.address>") to
157 find a key.  If you want to use a different default key, you can specify
158 it in the repository configuration as follows:
160 -------------------------------------
161 [user]
162     signingkey = <gpg-key-id>
163 -------------------------------------
166 DISCUSSION
167 ----------
169 On Re-tagging
170 ~~~~~~~~~~~~~
172 What should you do when you tag a wrong commit and you would
173 want to re-tag?
175 If you never pushed anything out, just re-tag it. Use "-f" to
176 replace the old one. And you're done.
178 But if you have pushed things out (or others could just read
179 your repository directly), then others will have already seen
180 the old tag. In that case you can do one of two things:
182 . The sane thing.
183 Just admit you screwed up, and use a different name. Others have
184 already seen one tag-name, and if you keep the same name, you
185 may be in the situation that two people both have "version X",
186 but they actually have 'different' "X"'s.  So just call it "X.1"
187 and be done with it.
189 . The insane thing.
190 You really want to call the new version "X" too, 'even though'
191 others have already seen the old one. So just use 'git tag -f'
192 again, as if you hadn't already published the old one.
194 However, Git does *not* (and it should not) change tags behind
195 users back. So if somebody already got the old tag, doing a
196 'git pull' on your tree shouldn't just make them overwrite the old
197 one.
199 If somebody got a release tag from you, you cannot just change
200 the tag for them by updating your own one. This is a big
201 security issue, in that people MUST be able to trust their
202 tag-names.  If you really want to do the insane thing, you need
203 to just fess up to it, and tell people that you messed up. You
204 can do that by making a very public announcement saying:
206 ------------
207 Ok, I messed up, and I pushed out an earlier version tagged as X. I
208 then fixed something, and retagged the *fixed* tree as X again.
210 If you got the wrong tag, and want the new one, please delete
211 the old one and fetch the new one by doing:
213         git tag -d X
214         git fetch origin tag X
216 to get my updated tag.
218 You can test which tag you have by doing
220         git rev-parse X
222 which should return 0123456789abcdef.. if you have the new version.
224 Sorry for the inconvenience.
225 ------------
227 Does this seem a bit complicated?  It *should* be. There is no
228 way that it would be correct to just "fix" it automatically.
229 People need to know that their tags might have been changed.
232 On Automatic following
233 ~~~~~~~~~~~~~~~~~~~~~~
235 If you are following somebody else's tree, you are most likely
236 using remote-tracking branches (`refs/heads/origin` in traditional
237 layout, or `refs/remotes/origin/master` in the separate-remote
238 layout).  You usually want the tags from the other end.
240 On the other hand, if you are fetching because you would want a
241 one-shot merge from somebody else, you typically do not want to
242 get tags from there.  This happens more often for people near
243 the toplevel but not limited to them.  Mere mortals when pulling
244 from each other do not necessarily want to automatically get
245 private anchor point tags from the other person.
247 Often, "please pull" messages on the mailing list just provide
248 two pieces of information: a repo URL and a branch name; this
249 is designed to be easily cut&pasted at the end of a 'git fetch'
250 command line:
252 ------------
253 Linus, please pull from
255         git://git..../proj.git master
257 to get the following updates...
258 ------------
260 becomes:
262 ------------
263 $ git pull git://git..../proj.git master
264 ------------
266 In such a case, you do not want to automatically follow the other
267 person's tags.
269 One important aspect of Git is its distributed nature, which
270 largely means there is no inherent "upstream" or
271 "downstream" in the system.  On the face of it, the above
272 example might seem to indicate that the tag namespace is owned
273 by the upper echelon of people and that tags only flow downwards, but
274 that is not the case.  It only shows that the usage pattern
275 determines who are interested in whose tags.
277 A one-shot pull is a sign that a commit history is now crossing
278 the boundary between one circle of people (e.g. "people who are
279 primarily interested in the networking part of the kernel") who may
280 have their own set of tags (e.g. "this is the third release
281 candidate from the networking group to be proposed for general
282 consumption with 2.6.21 release") to another circle of people
283 (e.g. "people who integrate various subsystem improvements").
284 The latter are usually not interested in the detailed tags used
285 internally in the former group (that is what "internal" means).
286 That is why it is desirable not to follow tags automatically in
287 this case.
289 It may well be that among networking people, they may want to
290 exchange the tags internal to their group, but in that workflow
291 they are most likely tracking each other's progress by
292 having remote-tracking branches.  Again, the heuristic to automatically
293 follow such tags is a good thing.
296 On Backdating Tags
297 ~~~~~~~~~~~~~~~~~~
299 If you have imported some changes from another VCS and would like
300 to add tags for major releases of your work, it is useful to be able
301 to specify the date to embed inside of the tag object; such data in
302 the tag object affects, for example, the ordering of tags in the
303 gitweb interface.
305 To set the date used in future tag objects, set the environment
306 variable GIT_COMMITTER_DATE (see the later discussion of possible
307 values; the most common form is "YYYY-MM-DD HH:MM").
309 For example:
311 ------------
312 $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
313 ------------
315 include::date-formats.txt[]
317 SEE ALSO
318 --------
319 linkgit:git-check-ref-format[1].
323 Part of the linkgit:git[1] suite