Documentation/git-tag.txt

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