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