Clarify commit-tree documentation
[git/dscho.git] / Documentation / git-tag.txt
blob119117f0bdc689a4da1c1ba4b8ae9a41fd8f05fd
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>]  <name> [<head>]
13 'git-tag' -d <name>...
14 'git-tag' [-n [<num>]] -l [<pattern>]
15 'git-tag' -v <name>...
17 DESCRIPTION
18 -----------
19 Adds a 'tag' reference in `.git/refs/tags/`
21 Unless `-f` is given, the tag must not yet exist in
22 `.git/refs/tags/` directory.
24 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
25 creates a 'tag' object, and requires the tag message.  Unless
26 `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
27 in the tag message.
29 Otherwise just the SHA1 object name of the commit object is
30 written (i.e. a lightweight tag).
32 A GnuPG signed tag object will be created when `-s` or `-u
33 <key-id>` is used.  When `-u <key-id>` is not used, the
34 committer identity for the current user is used to find the
35 GnuPG key for signing.
37 `-d <tag>` deletes the tag.
39 `-v <tag>` verifies the gpg signature of the tag.
41 `-l <pattern>` lists tags with names that match the given pattern
42 (or all if no pattern is given).
44 OPTIONS
45 -------
46 -a::
47         Make an unsigned, annotated tag object
49 -s::
50         Make a GPG-signed tag, using the default e-mail address's key
52 -u <key-id>::
53         Make a GPG-signed tag, using the given key
55 -f::
56         Replace an existing tag with the given name (instead of failing)
58 -d::
59         Delete existing tags with the given names.
61 -v::
62         Verify the gpg signature of the given tag names.
64 -n <num>::
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.
68         If no number is given to `-n`, only the first line is printed.
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 -m <msg>::
75         Use the given tag message (instead of prompting)
77 -F <file>::
78         Take the tag message from the given file.  Use '-' to
79         read the message from the standard input.
81 CONFIGURATION
82 -------------
83 By default, git-tag in sign-with-default mode (-s) will use your
84 committer identity (of the form "Your Name <your@email.address>") to
85 find a key.  If you want to use a different default key, you can specify
86 it in the repository configuration as follows:
88 -------------------------------------
89 [user]
90     signingkey = <gpg-key-id>
91 -------------------------------------
94 DISCUSSION
95 ----------
97 On Re-tagging
98 ~~~~~~~~~~~~~
100 What should you do when you tag a wrong commit and you would
101 want to re-tag?
103 If you never pushed anything out, just re-tag it. Use "-f" to
104 replace the old one. And you're done.
106 But if you have pushed things out (or others could just read
107 your repository directly), then others will have already seen
108 the old tag. In that case you can do one of two things:
110 . The sane thing.
111 Just admit you screwed up, and use a different name. Others have
112 already seen one tag-name, and if you keep the same name, you
113 may be in the situation that two people both have "version X",
114 but they actually have 'different' "X"'s.  So just call it "X.1"
115 and be done with it.
117 . The insane thing.
118 You really want to call the new version "X" too, 'even though'
119 others have already seen the old one. So just use "git tag -f"
120 again, as if you hadn't already published the old one.
122 However, Git does *not* (and it should not)change tags behind
123 users back. So if somebody already got the old tag, doing a "git
124 pull" on your tree shouldn't just make them overwrite the old
125 one.
127 If somebody got a release tag from you, you cannot just change
128 the tag for them by updating your own one. This is a big
129 security issue, in that people MUST be able to trust their
130 tag-names.  If you really want to do the insane thing, you need
131 to just fess up to it, and tell people that you messed up. You
132 can do that by making a very public announcement saying:
134 ------------
135 Ok, I messed up, and I pushed out an earlier version tagged as X. I
136 then fixed something, and retagged the *fixed* tree as X again.
138 If you got the wrong tag, and want the new one, please delete
139 the old one and fetch the new one by doing:
141         git tag -d X
142         git fetch origin tag X
144 to get my updated tag.
146 You can test which tag you have by doing
148         git rev-parse X
150 which should return 0123456789abcdef.. if you have the new version.
152 Sorry for inconvenience.
153 ------------
155 Does this seem a bit complicated?  It *should* be. There is no
156 way that it would be correct to just "fix" it behind peoples
157 backs. People need to know that their tags might have been
158 changed.
161 On Automatic following
162 ~~~~~~~~~~~~~~~~~~~~~~
164 If you are following somebody else's tree, you are most likely
165 using tracking branches (`refs/heads/origin` in traditional
166 layout, or `refs/remotes/origin/master` in the separate-remote
167 layout).  You usually want the tags from the other end.
169 On the other hand, if you are fetching because you would want a
170 one-shot merge from somebody else, you typically do not want to
171 get tags from there.  This happens more often for people near
172 the toplevel but not limited to them.  Mere mortals when pulling
173 from each other do not necessarily want to automatically get
174 private anchor point tags from the other person.
176 You would notice "please pull" messages on the mailing list says
177 repo URL and branch name alone.  This is designed to be easily
178 cut&pasted to "git fetch" command line:
180 ------------
181 Linus, please pull from
183         git://git..../proj.git master
185 to get the following updates...
186 ------------
188 becomes:
190 ------------
191 $ git pull git://git..../proj.git master
192 ------------
194 In such a case, you do not want to automatically follow other's
195 tags.
197 One important aspect of git is it is distributed, and being
198 distributed largely means there is no inherent "upstream" or
199 "downstream" in the system.  On the face of it, the above
200 example might seem to indicate that the tag namespace is owned
201 by upper echelon of people and tags only flow downwards, but
202 that is not the case.  It only shows that the usage pattern
203 determines who are interested in whose tags.
205 A one-shot pull is a sign that a commit history is now crossing
206 the boundary between one circle of people (e.g. "people who are
207 primarily interested in networking part of the kernel") who may
208 have their own set of tags (e.g. "this is the third release
209 candidate from the networking group to be proposed for general
210 consumption with 2.6.21 release") to another circle of people
211 (e.g. "people who integrate various subsystem improvements").
212 The latter are usually not interested in the detailed tags used
213 internally in the former group (that is what "internal" means).
214 That is why it is desirable not to follow tags automatically in
215 this case.
217 It may well be that among networking people, they may want to
218 exchange the tags internal to their group, but in that workflow
219 they are most likely tracking with each other's progress by
220 having tracking branches.  Again, the heuristic to automatically
221 follow such tags is a good thing.
224 Author
225 ------
226 Written by Linus Torvalds <torvalds@osdl.org>,
227 Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
229 Documentation
230 --------------
231 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
235 Part of the gitlink:git[7] suite