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