Autogenerated HTML docs for v2.45.0-31-gd4cc1
[git-htmldocs.git] / gitrevisions.html
blob764b805a72f54c9792e4d60b998ab28578db0587
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>gitrevisions(7)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 gitrevisions(7) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>gitrevisions -
743 Specifying revisions and ranges for Git
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="paragraph"><p>gitrevisions</p></div>
752 </div>
753 </div>
754 <div class="sect1">
755 <h2 id="_description">DESCRIPTION</h2>
756 <div class="sectionbody">
757 <div class="paragraph"><p>Many Git commands take revision parameters as arguments. Depending on
758 the command, they denote a specific commit or, for commands which
759 walk the revision graph (such as <a href="git-log.html">git-log(1)</a>), all commits which are
760 reachable from that commit. For commands that walk the revision graph one can
761 also specify a range of revisions explicitly.</p></div>
762 <div class="paragraph"><p>In addition, some Git commands (such as <a href="git-show.html">git-show(1)</a> and
763 <a href="git-push.html">git-push(1)</a>) can also take revision parameters which denote
764 other objects than commits, e.g. blobs ("files") or trees
765 ("directories of files").</p></div>
766 </div>
767 </div>
768 <div class="sect1">
769 <h2 id="_specifying_revisions">SPECIFYING REVISIONS</h2>
770 <div class="sectionbody">
771 <div class="paragraph"><p>A revision parameter <em>&lt;rev&gt;</em> typically, but not necessarily, names a
772 commit object. It uses what is called an <em>extended SHA-1</em>
773 syntax. Here are various ways to spell object names. The
774 ones listed near the end of this list name trees and
775 blobs contained in a commit.</p></div>
776 <div class="admonitionblock">
777 <table><tr>
778 <td class="icon">
779 <div class="title">Note</div>
780 </td>
781 <td class="content">This document shows the "raw" syntax as seen by git. The shell
782 and other UIs might require additional quoting to protect special
783 characters and to avoid word splitting.</td>
784 </tr></table>
785 </div>
786 <div class="dlist"><dl>
787 <dt class="hdlist1">
788 <em>&lt;sha1&gt;</em>, e.g. <em>dae86e1950b1277e545cee180551750029cfe735</em>, <em>dae86e</em>
789 </dt>
790 <dd>
792 The full SHA-1 object name (40-byte hexadecimal string), or
793 a leading substring that is unique within the repository.
794 E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
795 name the same commit object if there is no other object in
796 your repository whose object name starts with dae86e.
797 </p>
798 </dd>
799 <dt class="hdlist1">
800 <em>&lt;describeOutput&gt;</em>, e.g. <em>v1.7.4.2-679-g3bee7fb</em>
801 </dt>
802 <dd>
804 Output from <code>git describe</code>; i.e. a closest tag, optionally
805 followed by a dash and a number of commits, followed by a dash, a
806 <em>g</em>, and an abbreviated object name.
807 </p>
808 </dd>
809 <dt class="hdlist1">
810 <em>&lt;refname&gt;</em>, e.g. <em>master</em>, <em>heads/master</em>, <em>refs/heads/master</em>
811 </dt>
812 <dd>
814 A symbolic ref name. E.g. <em>master</em> typically means the commit
815 object referenced by <em>refs/heads/master</em>. If you
816 happen to have both <em>heads/master</em> and <em>tags/master</em>, you can
817 explicitly say <em>heads/master</em> to tell Git which one you mean.
818 When ambiguous, a <em>&lt;refname&gt;</em> is disambiguated by taking the
819 first match in the following rules:
820 </p>
821 <div class="olist arabic"><ol class="arabic">
822 <li>
824 If <em>$GIT_DIR/&lt;refname&gt;</em> exists, that is what you mean (this is usually
825 useful only for <code>HEAD</code>, <code>FETCH_HEAD</code>, <code>ORIG_HEAD</code>, <code>MERGE_HEAD</code>,
826 <code>REBASE_HEAD</code>, <code>REVERT_HEAD</code>, <code>CHERRY_PICK_HEAD</code>, <code>BISECT_HEAD</code>
827 and <code>AUTO_MERGE</code>);
828 </p>
829 </li>
830 <li>
832 otherwise, <em>refs/&lt;refname&gt;</em> if it exists;
833 </p>
834 </li>
835 <li>
837 otherwise, <em>refs/tags/&lt;refname&gt;</em> if it exists;
838 </p>
839 </li>
840 <li>
842 otherwise, <em>refs/heads/&lt;refname&gt;</em> if it exists;
843 </p>
844 </li>
845 <li>
847 otherwise, <em>refs/remotes/&lt;refname&gt;</em> if it exists;
848 </p>
849 </li>
850 <li>
852 otherwise, <em>refs/remotes/&lt;refname&gt;/HEAD</em> if it exists.
853 </p>
854 </li>
855 </ol></div>
856 <div class="dlist"><dl>
857 <dt class="hdlist1">
858 <code>HEAD</code>
859 </dt>
860 <dd>
862 names the commit on which you based the changes in the working tree.
863 </p>
864 </dd>
865 <dt class="hdlist1">
866 <code>FETCH_HEAD</code>
867 </dt>
868 <dd>
870 records the branch which you fetched from a remote repository with
871 your last <code>git fetch</code> invocation.
872 </p>
873 </dd>
874 <dt class="hdlist1">
875 <code>ORIG_HEAD</code>
876 </dt>
877 <dd>
879 is created by commands that move your <code>HEAD</code> in a drastic way (<code>git
880 am</code>, <code>git merge</code>, <code>git rebase</code>, <code>git reset</code>), to record the position
881 of the <code>HEAD</code> before their operation, so that you can easily change
882 the tip of the branch back to the state before you ran them.
883 </p>
884 </dd>
885 <dt class="hdlist1">
886 <code>MERGE_HEAD</code>
887 </dt>
888 <dd>
890 records the commit(s) which you are merging into your branch when you
891 run <code>git merge</code>.
892 </p>
893 </dd>
894 <dt class="hdlist1">
895 <code>REBASE_HEAD</code>
896 </dt>
897 <dd>
899 during a rebase, records the commit at which the operation is
900 currently stopped, either because of conflicts or an <code>edit</code> command in
901 an interactive rebase.
902 </p>
903 </dd>
904 <dt class="hdlist1">
905 <code>REVERT_HEAD</code>
906 </dt>
907 <dd>
909 records the commit which you are reverting when you run <code>git revert</code>.
910 </p>
911 </dd>
912 <dt class="hdlist1">
913 <code>CHERRY_PICK_HEAD</code>
914 </dt>
915 <dd>
917 records the commit which you are cherry-picking when you run <code>git
918 cherry-pick</code>.
919 </p>
920 </dd>
921 <dt class="hdlist1">
922 <code>BISECT_HEAD</code>
923 </dt>
924 <dd>
926 records the current commit to be tested when you run <code>git bisect
927 --no-checkout</code>.
928 </p>
929 </dd>
930 <dt class="hdlist1">
931 <code>AUTO_MERGE</code>
932 </dt>
933 <dd>
935 records a tree object corresponding to the state the
936 <em>ort</em> merge strategy wrote to the working tree when a merge operation
937 resulted in conflicts.
938 </p>
939 </dd>
940 </dl></div>
941 <div class="paragraph"><p>Note that any of the <em>refs/*</em> cases above may come either from
942 the <code>$GIT_DIR/refs</code> directory or from the <code>$GIT_DIR/packed-refs</code> file.
943 While the ref name encoding is unspecified, UTF-8 is preferred as
944 some output processing may assume ref names in UTF-8.</p></div>
945 </dd>
946 <dt class="hdlist1">
947 <em>@</em>
948 </dt>
949 <dd>
951 <em>@</em> alone is a shortcut for <code>HEAD</code>.
952 </p>
953 </dd>
954 <dt class="hdlist1">
955 <em>[&lt;refname&gt;]@{&lt;date&gt;}</em>, e.g. <em>master@{yesterday}</em>, <em>HEAD@{5 minutes ago}</em>
956 </dt>
957 <dd>
959 A ref followed by the suffix <em>@</em> with a date specification
960 enclosed in a brace
961 pair (e.g. <em>{yesterday}</em>, <em>{1 month 2 weeks 3 days 1 hour 1
962 second ago}</em> or <em>{1979-02-26 18:30:00}</em>) specifies the value
963 of the ref at a prior point in time. This suffix may only be
964 used immediately following a ref name and the ref must have an
965 existing log (<em>$GIT_DIR/logs/&lt;ref&gt;</em>). Note that this looks up the state
966 of your <strong>local</strong> ref at a given time; e.g., what was in your local
967 <em>master</em> branch last week. If you want to look at commits made during
968 certain times, see <code>--since</code> and <code>--until</code>.
969 </p>
970 </dd>
971 <dt class="hdlist1">
972 <em>&lt;refname&gt;@{&lt;n&gt;}</em>, e.g. <em>master@{1}</em>
973 </dt>
974 <dd>
976 A ref followed by the suffix <em>@</em> with an ordinal specification
977 enclosed in a brace pair (e.g. <em>{1}</em>, <em>{15}</em>) specifies
978 the n-th prior value of that ref. For example <em>master@{1}</em>
979 is the immediate prior value of <em>master</em> while <em>master@{5}</em>
980 is the 5th prior value of <em>master</em>. This suffix may only be used
981 immediately following a ref name and the ref must have an existing
982 log (<em>$GIT_DIR/logs/&lt;refname&gt;</em>).
983 </p>
984 </dd>
985 <dt class="hdlist1">
986 <em>@{&lt;n&gt;}</em>, e.g. <em>@{1}</em>
987 </dt>
988 <dd>
990 You can use the <em>@</em> construct with an empty ref part to get at a
991 reflog entry of the current branch. For example, if you are on
992 branch <em>blabla</em> then <em>@{1}</em> means the same as <em>blabla@{1}</em>.
993 </p>
994 </dd>
995 <dt class="hdlist1">
996 <em>@{-&lt;n&gt;}</em>, e.g. <em>@{-1}</em>
997 </dt>
998 <dd>
1000 The construct <em>@{-&lt;n&gt;}</em> means the &lt;n&gt;th branch/commit checked out
1001 before the current one.
1002 </p>
1003 </dd>
1004 <dt class="hdlist1">
1005 <em>[&lt;branchname&gt;]@{upstream}</em>, e.g. <em>master@{upstream}</em>, <em>@{u}</em>
1006 </dt>
1007 <dd>
1009 A branch B may be set up to build on top of a branch X (configured with
1010 <code>branch.&lt;name&gt;.merge</code>) at a remote R (configured with
1011 the branch X taken from remote R, typically found at <code>refs/remotes/R/X</code>.
1012 </p>
1013 </dd>
1014 <dt class="hdlist1">
1015 <em>[&lt;branchname&gt;]@{push}</em>, e.g. <em>master@{push}</em>, <em>@{push}</em>
1016 </dt>
1017 <dd>
1019 The suffix <em>@{push}</em> reports the branch "where we would push to" if
1020 <code>git push</code> were run while <code>branchname</code> was checked out (or the current
1021 <code>HEAD</code> if no branchname is specified). Like for <em>@{upstream}</em>, we report
1022 the remote-tracking branch that corresponds to that branch at the remote.
1023 </p>
1024 <div class="paragraph"><p>Here&#8217;s an example to make it more clear:</p></div>
1025 <div class="listingblock">
1026 <div class="content">
1027 <pre><code>$ git config push.default current
1028 $ git config remote.pushdefault myfork
1029 $ git switch -c mybranch origin/master
1031 $ git rev-parse --symbolic-full-name @{upstream}
1032 refs/remotes/origin/master
1034 $ git rev-parse --symbolic-full-name @{push}
1035 refs/remotes/myfork/mybranch</code></pre>
1036 </div></div>
1037 <div class="paragraph"><p>Note in the example that we set up a triangular workflow, where we pull
1038 from one location and push to another. In a non-triangular workflow,
1039 <em>@{push}</em> is the same as <em>@{upstream}</em>, and there is no need for it.</p></div>
1040 <div class="paragraph"><p>This suffix is also accepted when spelled in uppercase, and means the same
1041 thing no matter the case.</p></div>
1042 </dd>
1043 <dt class="hdlist1">
1044 <em>&lt;rev&gt;&#94;[&lt;n&gt;]</em>, e.g. <em>HEAD&#94;, v1.5.1&#94;0</em>
1045 </dt>
1046 <dd>
1048 A suffix <em>&#94;</em> to a revision parameter means the first parent of
1049 that commit object. <em>&#94;&lt;n&gt;</em> means the &lt;n&gt;th parent (i.e.
1050 <em>&lt;rev&gt;&#94;</em>
1051 is equivalent to <em>&lt;rev&gt;&#94;1</em>). As a special rule,
1052 <em>&lt;rev&gt;&#94;0</em> means the commit itself and is used when <em>&lt;rev&gt;</em> is the
1053 object name of a tag object that refers to a commit object.
1054 </p>
1055 </dd>
1056 <dt class="hdlist1">
1057 <em>&lt;rev&gt;&#126;[&lt;n&gt;]</em>, e.g. <em>HEAD&#126;, master&#126;3</em>
1058 </dt>
1059 <dd>
1061 A suffix <em>&#126;</em> to a revision parameter means the first parent of
1062 that commit object.
1063 A suffix <em>&#126;&lt;n&gt;</em> to a revision parameter means the commit
1064 object that is the &lt;n&gt;th generation ancestor of the named
1065 commit object, following only the first parents. I.e. <em>&lt;rev&gt;&#126;3</em> is
1066 equivalent to <em>&lt;rev&gt;&#94;&#94;&#94;</em> which is equivalent to
1067 <em>&lt;rev&gt;&#94;1&#94;1&#94;1</em>. See below for an illustration of
1068 the usage of this form.
1069 </p>
1070 </dd>
1071 <dt class="hdlist1">
1072 <em>&lt;rev&gt;&#94;{&lt;type&gt;}</em>, e.g. <em>v0.99.8&#94;{commit}</em>
1073 </dt>
1074 <dd>
1076 A suffix <em>&#94;</em> followed by an object type name enclosed in
1077 brace pair means dereference the object at <em>&lt;rev&gt;</em> recursively until
1078 an object of type <em>&lt;type&gt;</em> is found or the object cannot be
1079 dereferenced anymore (in which case, barf).
1080 For example, if <em>&lt;rev&gt;</em> is a commit-ish, <em>&lt;rev&gt;&#94;{commit}</em>
1081 describes the corresponding commit object.
1082 Similarly, if <em>&lt;rev&gt;</em> is a tree-ish, <em>&lt;rev&gt;&#94;{tree}</em>
1083 describes the corresponding tree object.
1084 <em>&lt;rev&gt;&#94;0</em>
1085 is a short-hand for <em>&lt;rev&gt;&#94;{commit}</em>.
1086 </p>
1087 <div class="paragraph"><p><em>&lt;rev&gt;&#94;{object}</em> can be used to make sure <em>&lt;rev&gt;</em> names an
1088 object that exists, without requiring <em>&lt;rev&gt;</em> to be a tag, and
1089 without dereferencing <em>&lt;rev&gt;</em>; because a tag is already an object,
1090 it does not have to be dereferenced even once to get to an object.</p></div>
1091 <div class="paragraph"><p><em>&lt;rev&gt;&#94;{tag}</em> can be used to ensure that <em>&lt;rev&gt;</em> identifies an
1092 existing tag object.</p></div>
1093 </dd>
1094 <dt class="hdlist1">
1095 <em>&lt;rev&gt;&#94;{}</em>, e.g. <em>v0.99.8&#94;{}</em>
1096 </dt>
1097 <dd>
1099 A suffix <em>&#94;</em> followed by an empty brace pair
1100 means the object could be a tag,
1101 and dereference the tag recursively until a non-tag object is
1102 found.
1103 </p>
1104 </dd>
1105 <dt class="hdlist1">
1106 <em>&lt;rev&gt;&#94;{/&lt;text&gt;}</em>, e.g. <em>HEAD^{/fix nasty bug}</em>
1107 </dt>
1108 <dd>
1110 A suffix <em>&#94;</em> to a revision parameter, followed by a brace
1111 pair that contains a text led by a slash,
1112 is the same as the <em>:/fix nasty bug</em> syntax below except that
1113 it returns the youngest matching commit which is reachable from
1114 the <em>&lt;rev&gt;</em> before <em>&#94;</em>.
1115 </p>
1116 </dd>
1117 <dt class="hdlist1">
1118 <em>:/&lt;text&gt;</em>, e.g. <em>:/fix nasty bug</em>
1119 </dt>
1120 <dd>
1122 A colon, followed by a slash, followed by a text, names
1123 a commit whose commit message matches the specified regular expression.
1124 This name returns the youngest matching commit which is
1125 reachable from any ref, including HEAD.
1126 The regular expression can match any part of the
1127 commit message. To match messages starting with a string, one can use
1128 e.g. <em>:/^foo</em>. The special sequence <em>:/!</em> is reserved for modifiers to what
1129 is matched. <em>:/!-foo</em> performs a negative match, while <em>:/!!foo</em> matches a
1130 literal <em>!</em> character, followed by <em>foo</em>. Any other sequence beginning with
1131 <em>:/!</em> is reserved for now.
1132 Depending on the given text, the shell&#8217;s word splitting rules might
1133 require additional quoting.
1134 </p>
1135 </dd>
1136 <dt class="hdlist1">
1137 <em>&lt;rev&gt;:&lt;path&gt;</em>, e.g. <em>HEAD:README</em>, <em>master:./README</em>
1138 </dt>
1139 <dd>
1141 A suffix <em>:</em> followed by a path names the blob or tree
1142 at the given path in the tree-ish object named by the part
1143 before the colon.
1144 A path starting with <em>./</em> or <em>../</em> is relative to the current working directory.
1145 The given path will be converted to be relative to the working tree&#8217;s root directory.
1146 This is most useful to address a blob or tree from a commit or tree that has
1147 the same tree structure as the working tree.
1148 </p>
1149 </dd>
1150 <dt class="hdlist1">
1151 <em>:[&lt;n&gt;:]&lt;path&gt;</em>, e.g. <em>:0:README</em>, <em>:README</em>
1152 </dt>
1153 <dd>
1155 A colon, optionally followed by a stage number (0 to 3) and a
1156 colon, followed by a path, names a blob object in the
1157 index at the given path. A missing stage number (and the colon
1158 that follows it) names a stage 0 entry. During a merge, stage
1159 1 is the common ancestor, stage 2 is the target branch&#8217;s version
1160 (typically the current branch), and stage 3 is the version from
1161 the branch which is being merged.
1162 </p>
1163 </dd>
1164 </dl></div>
1165 <div class="paragraph"><p>Here is an illustration, by Jon Loeliger. Both commit nodes B
1166 and C are parents of commit node A. Parent commits are ordered
1167 left-to-right.</p></div>
1168 <div class="literalblock">
1169 <div class="content">
1170 <pre><code>G H I J
1171 \ / \ /
1172 D E F
1173 \ | / \
1174 \ | / |
1175 \|/ |
1179 A</code></pre>
1180 </div></div>
1181 <div class="literalblock">
1182 <div class="content">
1183 <pre><code>A = = A^0
1184 B = A^ = A^1 = A~1
1185 C = = A^2
1186 D = A^^ = A^1^1 = A~2
1187 E = B^2 = A^^2
1188 F = B^3 = A^^3
1189 G = A^^^ = A^1^1^1 = A~3
1190 H = D^2 = B^^2 = A^^^2 = A~2^2
1191 I = F^ = B^3^ = A^^3^
1192 J = F^2 = B^3^2 = A^^3^2</code></pre>
1193 </div></div>
1194 </div>
1195 </div>
1196 <div class="sect1">
1197 <h2 id="_specifying_ranges">SPECIFYING RANGES</h2>
1198 <div class="sectionbody">
1199 <div class="paragraph"><p>History traversing commands such as <code>git log</code> operate on a set
1200 of commits, not just a single commit.</p></div>
1201 <div class="paragraph"><p>For these commands,
1202 specifying a single revision, using the notation described in the
1203 previous section, means the set of commits <code>reachable</code> from the given
1204 commit.</p></div>
1205 <div class="paragraph"><p>Specifying several revisions means the set of commits reachable from
1206 any of the given commits.</p></div>
1207 <div class="paragraph"><p>A commit&#8217;s reachable set is the commit itself and the commits in
1208 its ancestry chain.</p></div>
1209 <div class="paragraph"><p>There are several notations to specify a set of connected commits
1210 (called a "revision range"), illustrated below.</p></div>
1211 <div class="sect2">
1212 <h3 id="_commit_exclusions">Commit Exclusions</h3>
1213 <div class="dlist"><dl>
1214 <dt class="hdlist1">
1215 <em>&#94;&lt;rev&gt;</em> (caret) Notation
1216 </dt>
1217 <dd>
1219 To exclude commits reachable from a commit, a prefix <em>&#94;</em>
1220 notation is used. E.g. <em>&#94;r1 r2</em> means commits reachable
1221 from <em>r2</em> but exclude the ones reachable from <em>r1</em> (i.e. <em>r1</em> and
1222 its ancestors).
1223 </p>
1224 </dd>
1225 </dl></div>
1226 </div>
1227 <div class="sect2">
1228 <h3 id="_dotted_range_notations">Dotted Range Notations</h3>
1229 <div class="dlist"><dl>
1230 <dt class="hdlist1">
1231 The <em>..</em> (two-dot) Range Notation
1232 </dt>
1233 <dd>
1235 The <em>&#94;r1 r2</em> set operation appears so often that there is a shorthand
1236 for it. When you have two commits <em>r1</em> and <em>r2</em> (named according
1237 to the syntax explained in SPECIFYING REVISIONS above), you can ask
1238 for commits that are reachable from r2 excluding those that are reachable
1239 from r1 by <em>&#94;r1 r2</em> and it can be written as <em>r1..r2</em>.
1240 </p>
1241 </dd>
1242 <dt class="hdlist1">
1243 The <em>...</em> (three-dot) Symmetric Difference Notation
1244 </dt>
1245 <dd>
1247 A similar notation <em>r1...r2</em> is called symmetric difference
1248 of <em>r1</em> and <em>r2</em> and is defined as
1249 <em>r1 r2 --not $(git merge-base --all r1 r2)</em>.
1250 It is the set of commits that are reachable from either one of
1251 <em>r1</em> (left side) or <em>r2</em> (right side) but not from both.
1252 </p>
1253 </dd>
1254 </dl></div>
1255 <div class="paragraph"><p>In these two shorthand notations, you can omit one end and let it default to HEAD.
1256 For example, <em>origin..</em> is a shorthand for <em>origin..HEAD</em> and asks "What
1257 did I do since I forked from the origin branch?" Similarly, <em>..origin</em>
1258 is a shorthand for <em>HEAD..origin</em> and asks "What did the origin do since
1259 I forked from them?" Note that <em>..</em> would mean <em>HEAD..HEAD</em> which is an
1260 empty range that is both reachable and unreachable from HEAD.</p></div>
1261 <div class="paragraph"><p>Commands that are specifically designed to take two distinct ranges
1262 (e.g. "git range-diff R1 R2" to compare two ranges) do exist, but
1263 they are exceptions. Unless otherwise noted, all "git" commands
1264 that operate on a set of commits work on a single revision range.
1265 In other words, writing two "two-dot range notation" next to each
1266 other, e.g.</p></div>
1267 <div class="literalblock">
1268 <div class="content">
1269 <pre><code>$ git log A..B C..D</code></pre>
1270 </div></div>
1271 <div class="paragraph"><p>does <strong>not</strong> specify two revision ranges for most commands. Instead
1272 it will name a single connected set of commits, i.e. those that are
1273 reachable from either B or D but are reachable from neither A or C.
1274 In a linear history like this:</p></div>
1275 <div class="literalblock">
1276 <div class="content">
1277 <pre><code>---A---B---o---o---C---D</code></pre>
1278 </div></div>
1279 <div class="paragraph"><p>because A and B are reachable from C, the revision range specified
1280 by these two dotted ranges is a single commit D.</p></div>
1281 </div>
1282 <div class="sect2">
1283 <h3 id="_other_lt_rev_gt_94_parent_shorthand_notations">Other &lt;rev&gt;&#94; Parent Shorthand Notations</h3>
1284 <div class="paragraph"><p>Three other shorthands exist, particularly useful for merge commits,
1285 for naming a set that is formed by a commit and its parent commits.</p></div>
1286 <div class="paragraph"><p>The <em>r1&#94;@</em> notation means all parents of <em>r1</em>.</p></div>
1287 <div class="paragraph"><p>The <em>r1&#94;!</em> notation includes commit <em>r1</em> but excludes all of its parents.
1288 By itself, this notation denotes the single commit <em>r1</em>.</p></div>
1289 <div class="paragraph"><p>The <em>&lt;rev&gt;&#94;-[&lt;n&gt;]</em> notation includes <em>&lt;rev&gt;</em> but excludes the &lt;n&gt;th
1290 parent (i.e. a shorthand for <em>&lt;rev&gt;&#94;&lt;n&gt;..&lt;rev&gt;</em>), with <em>&lt;n&gt;</em> = 1 if
1291 not given. This is typically useful for merge commits where you
1292 can just pass <em>&lt;commit&gt;&#94;-</em> to get all the commits in the branch
1293 that was merged in merge commit <em>&lt;commit&gt;</em> (including <em>&lt;commit&gt;</em>
1294 itself).</p></div>
1295 <div class="paragraph"><p>While <em>&lt;rev&gt;&#94;&lt;n&gt;</em> was about specifying a single commit parent, these
1296 three notations also consider its parents. For example you can say
1297 <em>HEAD&#94;2&#94;@</em>, however you cannot say <em>HEAD&#94;@&#94;2</em>.</p></div>
1298 </div>
1299 </div>
1300 </div>
1301 <div class="sect1">
1302 <h2 id="_revision_range_summary">Revision Range Summary</h2>
1303 <div class="sectionbody">
1304 <div class="dlist"><dl>
1305 <dt class="hdlist1">
1306 <em>&lt;rev&gt;</em>
1307 </dt>
1308 <dd>
1310 Include commits that are reachable from &lt;rev&gt; (i.e. &lt;rev&gt; and its
1311 ancestors).
1312 </p>
1313 </dd>
1314 <dt class="hdlist1">
1315 <em>&#94;&lt;rev&gt;</em>
1316 </dt>
1317 <dd>
1319 Exclude commits that are reachable from &lt;rev&gt; (i.e. &lt;rev&gt; and its
1320 ancestors).
1321 </p>
1322 </dd>
1323 <dt class="hdlist1">
1324 <em>&lt;rev1&gt;..&lt;rev2&gt;</em>
1325 </dt>
1326 <dd>
1328 Include commits that are reachable from &lt;rev2&gt; but exclude
1329 those that are reachable from &lt;rev1&gt;. When either &lt;rev1&gt; or
1330 &lt;rev2&gt; is omitted, it defaults to <code>HEAD</code>.
1331 </p>
1332 </dd>
1333 <dt class="hdlist1">
1334 <em>&lt;rev1&gt;...&lt;rev2&gt;</em>
1335 </dt>
1336 <dd>
1338 Include commits that are reachable from either &lt;rev1&gt; or
1339 &lt;rev2&gt; but exclude those that are reachable from both. When
1340 either &lt;rev1&gt; or &lt;rev2&gt; is omitted, it defaults to <code>HEAD</code>.
1341 </p>
1342 </dd>
1343 <dt class="hdlist1">
1344 <em>&lt;rev&gt;&#94;@</em>, e.g. <em>HEAD&#94;@</em>
1345 </dt>
1346 <dd>
1348 A suffix <em>&#94;</em> followed by an at sign is the same as listing
1349 all parents of <em>&lt;rev&gt;</em> (meaning, include anything reachable from
1350 its parents, but not the commit itself).
1351 </p>
1352 </dd>
1353 <dt class="hdlist1">
1354 <em>&lt;rev&gt;&#94;!</em>, e.g. <em>HEAD&#94;!</em>
1355 </dt>
1356 <dd>
1358 A suffix <em>&#94;</em> followed by an exclamation mark is the same
1359 as giving commit <em>&lt;rev&gt;</em> and all its parents prefixed with
1360 <em>&#94;</em> to exclude them (and their ancestors).
1361 </p>
1362 </dd>
1363 <dt class="hdlist1">
1364 <em>&lt;rev&gt;&#94;-&lt;n&gt;</em>, e.g. <em>HEAD&#94;-, HEAD&#94;-2</em>
1365 </dt>
1366 <dd>
1368 Equivalent to <em>&lt;rev&gt;&#94;&lt;n&gt;..&lt;rev&gt;</em>, with <em>&lt;n&gt;</em> = 1 if not
1369 given.
1370 </p>
1371 </dd>
1372 </dl></div>
1373 <div class="paragraph"><p>Here are a handful of examples using the Loeliger illustration above,
1374 with each step in the notation&#8217;s expansion and selection carefully
1375 spelt out:</p></div>
1376 <div class="literalblock">
1377 <div class="content">
1378 <pre><code> Args Expanded arguments Selected commits
1379 D G H D
1380 D F G H I J D F
1381 ^G D H D
1382 ^D B E I J F B
1383 ^D B C E I J F B C
1384 C I J F C
1385 B..C = ^B C C
1386 B...C = B ^F C G H D E B C
1387 B^- = B^..B
1388 = ^B^1 B E I J F B
1389 C^@ = C^1
1390 = F I J F
1391 B^@ = B^1 B^2 B^3
1392 = D E F D G H E F I J
1393 C^! = C ^C^@
1394 = C ^C^1
1395 = C ^F C
1396 B^! = B ^B^@
1397 = B ^B^1 ^B^2 ^B^3
1398 = B ^D ^E ^F B
1399 F^! D = F ^I ^J D G H D F</code></pre>
1400 </div></div>
1401 </div>
1402 </div>
1403 <div class="sect1">
1404 <h2 id="_see_also">SEE ALSO</h2>
1405 <div class="sectionbody">
1406 <div class="paragraph"><p><a href="git-rev-parse.html">git-rev-parse(1)</a></p></div>
1407 </div>
1408 </div>
1409 <div class="sect1">
1410 <h2 id="_git">GIT</h2>
1411 <div class="sectionbody">
1412 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1413 </div>
1414 </div>
1415 </div>
1416 <div id="footnotes"><hr /></div>
1417 <div id="footer">
1418 <div id="footer-text">
1419 Last updated
1420 2020-03-10 15:02:33 PDT
1421 </div>
1422 </div>
1423 </body>
1424 </html>