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