1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.5.2" />
7 <title>git-tag(
1)
</title>
8 <style type=
"text/css">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.5em;
116 margin-bottom: 1.5em;
118 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
119 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
120 div
.admonitionblock
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.0em;
131 div
.content
{ /* Block element content. */
135 /* Block element titles. */
136 div
.title
, caption
.title
{
138 font-family: sans-serif
;
142 margin-bottom: 0.5em;
148 td div
.title:first-child
{
151 div
.content div
.title:first-child
{
154 div
.content
+ div
.title
{
158 div
.sidebarblock
> div
.content
{
160 border: 1px solid silver
;
164 div
.listingblock
> div
.content
{
165 border: 1px solid silver
;
170 div
.quoteblock
, div
.verseblock
{
174 border-left: 5px solid
#dddddd;
178 div
.quoteblock
> div
.attribution
{
183 div
.verseblock
> div
.content
{
186 div
.verseblock
> div
.attribution
{
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div
.verseblock
+ div
.attribution
{
195 div
.admonitionblock
.icon
{
199 text-decoration: underline
;
201 padding-right: 0.5em;
203 div
.admonitionblock td
.content
{
205 border-left: 3px solid
#dddddd;
208 div
.exampleblock
> div
.content
{
209 border-left: 3px solid
#dddddd;
213 div
.imageblock div
.content
{ padding-left: 0; }
214 span
.image img
{ border-style: none
; }
215 a
.image:visited
{ color: white
; }
219 margin-bottom: 0.8em;
232 list-style-position: outside
;
235 list-style-type: decimal
;
238 list-style-type: lower-alpha
;
241 list-style-type: upper-alpha
;
244 list-style-type: lower-roman
;
247 list-style-type: upper-roman
;
250 div
.compact ul
, div
.compact ol
,
251 div
.compact p
, div
.compact p
,
252 div
.compact div
, div
.compact div
{
254 margin-bottom: 0.1em;
257 div
.tableblock
> table
{
258 border: 3px solid
#527bbd;
260 thead
, p
.table
.header
{
261 font-family: sans-serif
;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div
.tableblock
> table
[frame
="void"] {
277 div
.tableblock
> table
[frame
="hsides"] {
278 border-left-style: none
;
279 border-right-style: none
;
281 div
.tableblock
> table
[frame
="vsides"] {
282 border-top-style: none
;
283 border-bottom-style: none
;
289 margin-bottom: 0.8em;
292 padding-bottom: 15px;
294 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
300 padding-right: 0.8em;
306 div
.hdlist
.compact tr
{
315 .footnote, .footnoteref {
319 span
.footnote
, span
.footnoteref
{
320 vertical-align: super
;
324 margin: 20px 0 20px 0;
328 #footnotes div
.footnote
{
334 border-top: 1px solid silver
;
344 div#footer-badges
{ display: none
; }
348 margin-bottom: 2.5em;
353 font-family: sans-serif
;
357 margin-bottom: 0.1em;
360 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
376 /* Overrides for manpage documents */
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver
;
381 border-bottom: 2px solid silver
;
391 div#toc
{ display: none
; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div
.sidebar-content
{
398 border: 1px solid silver
;
401 div
.sidebar-title
, div
.image-title
{
403 font-family: sans-serif
;
406 margin-bottom: 0.5em;
409 div
.listingblock div
.content
{
410 border: 1px solid silver
;
415 div
.quoteblock-attribution
{
420 div
.verseblock-content
{
423 div
.verseblock-attribution
{
428 div
.exampleblock-content
{
429 border-left: 3px solid
#dddddd;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc
a:visited
{ color: blue
; }
436 <script type=
"text/javascript">
438 window
.onload = function(){asciidoc
.footnotes();}
439 var asciidoc
= { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
459 toc: function (toclevels
) {
461 function getText(el
) {
463 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
464 if (i
.nodeType
== 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
466 else if (i
.firstChild
!= null)
472 function TocEntry(el
, text
, toclevel
) {
475 this.toclevel
= toclevel
;
478 function tocEntries(el
, toclevels
) {
479 var result
= new Array
;
480 var re
= new RegExp('[hH]([2-'+(toclevels
+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
484 var iterate = function (el
) {
485 for (var i
= el
.firstChild
; i
!= null; i
= i
.nextSibling
) {
486 if (i
.nodeType
== 1 /* Node.ELEMENT_NODE */) {
487 var mo
= re
.exec(i
.tagName
);
488 if (mo
&& (i
.getAttribute("class") || i
.getAttribute("className")) != "float") {
489 result
[result
.length
] = new TocEntry(i
, getText(i
), mo
[1]-1);
499 var toc
= document
.getElementById("toc");
500 var entries
= tocEntries(document
.getElementById("content"), toclevels
);
501 for (var i
= 0; i
< entries
.length
; ++i
) {
502 var entry
= entries
[i
];
503 if (entry
.element
.id
== "")
504 entry
.element
.id
= "_toc_" + i
;
505 var a
= document
.createElement("a");
506 a
.href
= "#" + entry
.element
.id
;
507 a
.appendChild(document
.createTextNode(entry
.text
));
508 var div
= document
.createElement("div");
510 div
.className
= "toclevel" + entry
.toclevel
;
511 toc
.appendChild(div
);
513 if (entries
.length
== 0)
514 toc
.parentNode
.removeChild(toc
);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont
= document
.getElementById("content");
528 var noteholder
= document
.getElementById("footnotes");
529 var spans
= cont
.getElementsByTagName("span");
532 for (i
=0; i
<spans
.length
; i
++) {
533 if (spans
[i
].className
== "footnote") {
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note
= spans
[i
].innerHTML
.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder
.innerHTML
+=
539 "<div class='footnote' id='_footnote_" + n
+ "'>" +
540 "<a href='#_footnoteref_" + n
+ "' title='Return to text'>" +
541 n
+ "</a>. " + note
+ "</div>";
543 "[<a id='_footnoteref_" + n
+ "' href='#_footnote_" + n
+
544 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
545 var id
=spans
[i
].getAttribute("id");
546 if (id
!= null) refs
["#"+id
] = n
;
550 noteholder
.parentNode
.removeChild(noteholder
);
552 // Process footnoterefs.
553 for (i
=0; i
<spans
.length
; i
++) {
554 if (spans
[i
].className
== "footnoteref") {
555 var href
= spans
[i
].getElementsByTagName("a")[0].getAttribute("href");
556 href
= href
.match(/#.*/)[0]; // Because IE return full URL.
559 "[<a href='#_footnote_" + n
+
560 "' title='View footnote' class='footnote'>" + n
+ "</a>]";
573 git-tag(
1) Manual Page
576 <div class=
"sectionbody">
578 Create, list, delete or verify a tag object signed with GPG
583 <h2 id=
"_synopsis">SYNOPSIS
</h2>
584 <div class=
"sectionbody">
585 <div class=
"verseblock">
586 <div class=
"verseblock-content"><em>git tag
</em> [-a | -s | -u
<key-id
>] [-f] [-m
<msg
> | -F
<file
>]
587 <tagname
> [
<commit
> |
<object
>]
588 <em>git tag
</em> -d
<tagname
>…
589 <em>git tag
</em> [-n[
<num
>]] -l [--contains
<commit
>] [
<pattern
>…]
590 <em>git tag
</em> -v
<tagname
>…</div>
591 <div class=
"verseblock-attribution">
594 <h2 id=
"_description">DESCRIPTION
</h2>
595 <div class=
"sectionbody">
596 <div class=
"paragraph"><p>Add a tag reference in
<tt>.git/refs/tags/
</tt>, unless
<tt>-d/-l/-v
</tt> is given
597 to delete, list or verify tags.
</p></div>
598 <div class=
"paragraph"><p>Unless
<tt>-f
</tt> is given, the tag to be created must not yet exist in the
599 <tt>.git/refs/tags/
</tt> directory.
</p></div>
600 <div class=
"paragraph"><p>If one of
<tt>-a
</tt>,
<tt>-s
</tt>, or
<tt>-u
<key-id
></tt> is passed, the command
601 creates a
<em>tag
</em> object, and requires a tag message. Unless
602 <tt>-m
<msg
></tt> or
<tt>-F
<file
></tt> is given, an editor is started for the user to type
603 in the tag message.
</p></div>
604 <div class=
"paragraph"><p>If
<tt>-m
<msg
></tt> or
<tt>-F
<file
></tt> is given and
<tt>-a
</tt>,
<tt>-s
</tt>, and
<tt>-u
<key-id
></tt>
605 are absent,
<tt>-a
</tt> is implied.
</p></div>
606 <div class=
"paragraph"><p>Otherwise just a tag reference for the SHA1 object name of the commit object is
607 created (i.e. a lightweight tag).
</p></div>
608 <div class=
"paragraph"><p>A GnuPG signed tag object will be created when
<tt>-s
</tt> or
<tt>-u
609 <key-id
></tt> is used. When
<tt>-u
<key-id
></tt> is not used, the
610 committer identity for the current user is used to find the
611 GnuPG key for signing.
</p></div>
613 <h2 id=
"_options">OPTIONS
</h2>
614 <div class=
"sectionbody">
615 <div class=
"dlist"><dl>
624 Make an unsigned, annotated tag object
635 Make a GPG-signed tag, using the default e-mail address
’s key
642 --local-user=
<key-id
>
646 Make a GPG-signed tag, using the given key
657 Replace an existing tag with the given name (instead of failing)
668 Delete existing tags with the given names.
679 Verify the gpg signature of the given tag names.
687 <num
> specifies how many lines from the annotation, if any,
688 are printed when using -l.
689 The default is not to print any annotation lines.
690 If no number is given to
<tt>-n
</tt>, only the first line is printed.
691 If the tag is not annotated, the commit message is displayed instead.
698 --list
<pattern
>
702 List tags with names that match the given pattern (or all if no
703 pattern is given). Running
"git tag" without arguments also
704 lists all tags. The pattern is a shell wildcard (i.e., matched
705 using fnmatch(
3)). Multiple patterns may be given; if any of
706 them matches, the tag is shown.
710 --contains
<commit
>
714 Only list tags which contain the specified commit.
721 --message=
<msg
>
725 Use the given tag message (instead of prompting).
726 If multiple
<tt>-m
</tt> options are given, their values are
727 concatenated as separate paragraphs.
728 Implies
<tt>-a
</tt> if none of
<tt>-a
</tt>,
<tt>-s
</tt>, or
<tt>-u
<key-id
></tt>
740 Take the tag message from the given file. Use
<em>-
</em> to
741 read the message from the standard input.
742 Implies
<tt>-a
</tt> if none of
<tt>-a
</tt>,
<tt>-s
</tt>, or
<tt>-u
<key-id
></tt>
751 The name of the tag to create, delete, or describe.
752 The new tag name must pass all checks defined by
753 <a href=
"git-check-ref-format.html">git-check-ref-format(
1)
</a>. Some of these checks
754 may restrict the characters allowed in a tag name.
759 <h2 id=
"_configuration">CONFIGURATION
</h2>
760 <div class=
"sectionbody">
761 <div class=
"paragraph"><p>By default,
<em>git tag
</em> in sign-with-default mode (-s) will use your
762 committer identity (of the form
"Your Name <<a href="mailto:your@email.address
">your@email.address</a>>") to
763 find a key. If you want to use a different default key, you can specify
764 it in the repository configuration as follows:
</p></div>
765 <div class=
"listingblock">
766 <div class=
"content">
768 signingkey =
<gpg-key-id
></tt></pre>
771 <h2 id=
"_discussion">DISCUSSION
</h2>
772 <div class=
"sectionbody">
773 <h3 id=
"_on_re_tagging">On Re-tagging
</h3><div style=
"clear:left"></div>
774 <div class=
"paragraph"><p>What should you do when you tag a wrong commit and you would
775 want to re-tag?
</p></div>
776 <div class=
"paragraph"><p>If you never pushed anything out, just re-tag it. Use
"-f" to
777 replace the old one. And you
’re done.
</p></div>
778 <div class=
"paragraph"><p>But if you have pushed things out (or others could just read
779 your repository directly), then others will have already seen
780 the old tag. In that case you can do one of two things:
</p></div>
781 <div class=
"olist arabic"><ol class=
"arabic">
785 Just admit you screwed up, and use a different name. Others have
786 already seen one tag-name, and if you keep the same name, you
787 may be in the situation that two people both have
"version X",
788 but they actually have
<em>different
</em> "X"'s. So just call it
"X.1"
795 You really want to call the new version
"X" too,
<em>even though
</em>
796 others have already seen the old one. So just use
<em>git tag -f
</em>
797 again, as if you hadn
’t already published the old one.
801 <div class=
"paragraph"><p>However, Git does
<strong>not
</strong> (and it should not) change tags behind
802 users back. So if somebody already got the old tag, doing a
803 <em>git pull
</em> on your tree shouldn
’t just make them overwrite the old
805 <div class=
"paragraph"><p>If somebody got a release tag from you, you cannot just change
806 the tag for them by updating your own one. This is a big
807 security issue, in that people MUST be able to trust their
808 tag-names. If you really want to do the insane thing, you need
809 to just fess up to it, and tell people that you messed up. You
810 can do that by making a very public announcement saying:
</p></div>
811 <div class=
"listingblock">
812 <div class=
"content">
813 <pre><tt>Ok, I messed up, and I pushed out an earlier version tagged as X. I
814 then fixed something, and retagged the *fixed* tree as X again.
816 If you got the wrong tag, and want the new one, please delete
817 the old one and fetch the new one by doing:
820 git fetch origin tag X
822 to get my updated tag.
824 You can test which tag you have by doing
828 which should return
0123456789abcdef.. if you have the new version.
830 Sorry for the inconvenience.
</tt></pre>
832 <div class=
"paragraph"><p>Does this seem a bit complicated? It
<strong>should
</strong> be. There is no
833 way that it would be correct to just
"fix" it automatically.
834 People need to know that their tags might have been changed.
</p></div>
835 <h3 id=
"_on_automatic_following">On Automatic following
</h3><div style=
"clear:left"></div>
836 <div class=
"paragraph"><p>If you are following somebody else
’s tree, you are most likely
837 using remote-tracking branches (
<tt>refs/heads/origin
</tt> in traditional
838 layout, or
<tt>refs/remotes/origin/master
</tt> in the separate-remote
839 layout). You usually want the tags from the other end.
</p></div>
840 <div class=
"paragraph"><p>On the other hand, if you are fetching because you would want a
841 one-shot merge from somebody else, you typically do not want to
842 get tags from there. This happens more often for people near
843 the toplevel but not limited to them. Mere mortals when pulling
844 from each other do not necessarily want to automatically get
845 private anchor point tags from the other person.
</p></div>
846 <div class=
"paragraph"><p>Often,
"please pull" messages on the mailing list just provide
847 two pieces of information: a repo URL and a branch name; this
848 is designed to be easily cut
&pasted at the end of a
<em>git fetch
</em>
849 command line:
</p></div>
850 <div class=
"listingblock">
851 <div class=
"content">
852 <pre><tt>Linus, please pull from
854 git://git..../proj.git master
856 to get the following updates...
</tt></pre>
858 <div class=
"paragraph"><p>becomes:
</p></div>
859 <div class=
"listingblock">
860 <div class=
"content">
861 <pre><tt>$ git pull git://git..../proj.git master
</tt></pre>
863 <div class=
"paragraph"><p>In such a case, you do not want to automatically follow the other
864 person
’s tags.
</p></div>
865 <div class=
"paragraph"><p>One important aspect of git is its distributed nature, which
866 largely means there is no inherent
"upstream" or
867 "downstream" in the system. On the face of it, the above
868 example might seem to indicate that the tag namespace is owned
869 by the upper echelon of people and that tags only flow downwards, but
870 that is not the case. It only shows that the usage pattern
871 determines who are interested in whose tags.
</p></div>
872 <div class=
"paragraph"><p>A one-shot pull is a sign that a commit history is now crossing
873 the boundary between one circle of people (e.g.
"people who are
874 primarily interested in the networking part of the kernel") who may
875 have their own set of tags (e.g.
"this is the third release
876 candidate from the networking group to be proposed for general
877 consumption with 2.6.21 release") to another circle of people
878 (e.g.
"people who integrate various subsystem improvements").
879 The latter are usually not interested in the detailed tags used
880 internally in the former group (that is what
"internal" means).
881 That is why it is desirable not to follow tags automatically in
883 <div class=
"paragraph"><p>It may well be that among networking people, they may want to
884 exchange the tags internal to their group, but in that workflow
885 they are most likely tracking each other
’s progress by
886 having remote-tracking branches. Again, the heuristic to automatically
887 follow such tags is a good thing.
</p></div>
888 <h3 id=
"_on_backdating_tags">On Backdating Tags
</h3><div style=
"clear:left"></div>
889 <div class=
"paragraph"><p>If you have imported some changes from another VCS and would like
890 to add tags for major releases of your work, it is useful to be able
891 to specify the date to embed inside of the tag object; such data in
892 the tag object affects, for example, the ordering of tags in the
893 gitweb interface.
</p></div>
894 <div class=
"paragraph"><p>To set the date used in future tag objects, set the environment
895 variable GIT_COMMITTER_DATE (see the later discussion of possible
896 values; the most common form is
"YYYY-MM-DD HH:MM").
</p></div>
897 <div class=
"paragraph"><p>For example:
</p></div>
898 <div class=
"listingblock">
899 <div class=
"content">
900 <pre><tt>$
GIT_COMMITTER_DATE=
"2006-10-02 10:31" git tag -s v1.0
.1</tt></pre>
903 <h2 id=
"_date_formats">DATE FORMATS
</h2>
904 <div class=
"sectionbody">
905 <div class=
"paragraph"><p>The GIT_AUTHOR_DATE, GIT_COMMITTER_DATE environment variables
906 support the following date formats:
</p></div>
907 <div class=
"dlist"><dl>
913 It is
<tt><unix timestamp
> <timezone offset
></tt>, where
<tt><unix
914 timestamp
></tt> is the number of seconds since the UNIX epoch.
915 <tt><timezone offset
></tt> is a positive or negative offset from UTC.
916 For example CET (which is
2 hours ahead UTC) is
<tt>+
0200</tt>.
924 The standard email format as described by RFC
2822, for example
925 <tt>Thu,
07 Apr
2005 22:
13:
13 +
0200</tt>.
933 Time and date specified by the ISO
8601 standard, for example
934 <tt>2005-
04-
07T22:
13:
13</tt>. The parser accepts a space instead of the
935 <tt>T
</tt> character as well.
937 <div class=
"admonitionblock">
940 <div class=
"title">Note
</div>
942 <td class=
"content">In addition, the date part is accepted in the following formats:
943 <tt>YYYY.MM.DD
</tt>,
<tt>MM/DD/YYYY
</tt> and
<tt>DD.MM.YYYY
</tt>.
</td>
949 <h2 id=
"_see_also">SEE ALSO
</h2>
950 <div class=
"sectionbody">
951 <div class=
"paragraph"><p><a href=
"git-check-ref-format.html">git-check-ref-format(
1)
</a>.
</p></div>
953 <h2 id=
"_git">GIT
</h2>
954 <div class=
"sectionbody">
955 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
958 <div id=
"footnotes"><hr /></div>
960 <div id=
"footer-text">
961 Last updated
2011-
10-
05 13:
59:
16 PDT