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