git-rev-parse.html

   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>git-rev-parse(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  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;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  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;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 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;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 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;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 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;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 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;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 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; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 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;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 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;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 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; }
 392
 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; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 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;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 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.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 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);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 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);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 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);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 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);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 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;
 654   }
 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);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 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);
 682       }
 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;
 689     }
 690   }
 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>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-rev-parse(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-rev-parse -
 743    Pick out and massage parameters
 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="verseblock">
 752 <pre class="content"><em>git rev-parse</em> [&lt;options&gt;] &lt;arg&gt;&#8230;</pre>
 753 <div class="attribution">
 754 </div></div>
 755 </div>
 756 </div>
 757 <div class="sect1">
 758 <h2 id="_description">DESCRIPTION</h2>
 759 <div class="sectionbody">
 760 <div class="paragraph"><p>Many Git porcelainish commands take a mixture of flags
 761 (i.e. parameters that begin with a dash <em>-</em>) and parameters
 762 meant for the underlying <em>git rev-list</em> command they use internally
 763 and flags and parameters for the other commands they use
 764 downstream of <em>git rev-list</em>.  The primary purpose of this command
 765 is to allow calling programs to distinguish between them.  There are
 766 a few other operation modes that have nothing to do with the above
 767 "help parse command line options".</p></div>
 768 <div class="paragraph"><p>Unless otherwise specified, most of the options and operation modes
 769 require you to run this command inside a git repository or a working
 770 tree that is under the control of a git repository, and will give you
 771 a fatal error otherwise.</p></div>
 772 </div>
 773 </div>
 774 <div class="sect1">
 775 <h2 id="_options">OPTIONS</h2>
 776 <div class="sectionbody">
 777 <div class="sect2">
 778 <h3 id="_operation_modes">Operation Modes</h3>
 779 <div class="paragraph"><p>Each of these options must appear first on the command line.</p></div>
 780 <div class="dlist"><dl>
 781 <dt class="hdlist1">
 782 --parseopt
 783 </dt>
 784 <dd>
 785 <p>
 786         Use <em>git rev-parse</em> in option parsing mode (see PARSEOPT section below).
 787         The command in this mode can be used outside a repository or
 788         a working tree controlled by a repository.
 789 </p>
 790 </dd>
 791 <dt class="hdlist1">
 792 --sq-quote
 793 </dt>
 794 <dd>
 795 <p>
 796         Use <em>git rev-parse</em> in shell quoting mode (see SQ-QUOTE
 797         section below). In contrast to the <code>--sq</code> option below, this
 798         mode only does quoting. Nothing else is done to command input.
 799         The command in this mode can be used outside a repository or
 800         a working tree controlled by a repository.
 801 </p>
 802 </dd>
 803 </dl></div>
 804 </div>
 805 <div class="sect2">
 806 <h3 id="_options_for_parseopt">Options for --parseopt</h3>
 807 <div class="dlist"><dl>
 808 <dt class="hdlist1">
 809 --keep-dashdash
 810 </dt>
 811 <dd>
 812 <p>
 813         Only meaningful in <code>--parseopt</code> mode. Tells the option parser to echo
 814         out the first <code>--</code> met instead of skipping it.
 815 </p>
 816 </dd>
 817 <dt class="hdlist1">
 818 --stop-at-non-option
 819 </dt>
 820 <dd>
 821 <p>
 822         Only meaningful in <code>--parseopt</code> mode.  Lets the option parser stop at
 823         the first non-option argument.  This can be used to parse sub-commands
 824         that take options themselves.
 825 </p>
 826 </dd>
 827 <dt class="hdlist1">
 828 --stuck-long
 829 </dt>
 830 <dd>
 831 <p>
 832         Only meaningful in <code>--parseopt</code> mode. Output the options in their
 833         long form if available, and with their arguments stuck.
 834 </p>
 835 </dd>
 836 </dl></div>
 837 </div>
 838 <div class="sect2">
 839 <h3 id="_options_for_filtering">Options for Filtering</h3>
 840 <div class="dlist"><dl>
 841 <dt class="hdlist1">
 842 --revs-only
 843 </dt>
 844 <dd>
 845 <p>
 846         Do not output flags and parameters not meant for
 847         <em>git rev-list</em> command.
 848 </p>
 849 </dd>
 850 <dt class="hdlist1">
 851 --no-revs
 852 </dt>
 853 <dd>
 854 <p>
 855         Do not output flags and parameters meant for
 856         <em>git rev-list</em> command.
 857 </p>
 858 </dd>
 859 <dt class="hdlist1">
 860 --flags
 861 </dt>
 862 <dd>
 863 <p>
 864         Do not output non-flag parameters.
 865 </p>
 866 </dd>
 867 <dt class="hdlist1">
 868 --no-flags
 869 </dt>
 870 <dd>
 871 <p>
 872         Do not output flag parameters.
 873 </p>
 874 </dd>
 875 </dl></div>
 876 </div>
 877 <div class="sect2">
 878 <h3 id="_options_for_output">Options for Output</h3>
 879 <div class="dlist"><dl>
 880 <dt class="hdlist1">
 881 --default &lt;arg&gt;
 882 </dt>
 883 <dd>
 884 <p>
 885         If there is no parameter given by the user, use <code>&lt;arg&gt;</code>
 886         instead.
 887 </p>
 888 </dd>
 889 <dt class="hdlist1">
 890 --prefix &lt;arg&gt;
 891 </dt>
 892 <dd>
 893 <p>
 894         Behave as if <em>git rev-parse</em> was invoked from the <code>&lt;arg&gt;</code>
 895         subdirectory of the working tree.  Any relative filenames are
 896         resolved as if they are prefixed by <code>&lt;arg&gt;</code> and will be printed
 897         in that form.
 898 </p>
 899 <div class="paragraph"><p>This can be used to convert arguments to a command run in a subdirectory
 900 so that they can still be used after moving to the top-level of the
 901 repository.  For example:</p></div>
 902 <div class="listingblock">
 903 <div class="content">
 904 <pre><code>prefix=$(git rev-parse --show-prefix)
 905 cd "$(git rev-parse --show-toplevel)"
 906 # rev-parse provides the -- needed for 'set'
 907 eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"</code></pre>
 908 </div></div>
 909 </dd>
 910 <dt class="hdlist1">
 911 --verify
 912 </dt>
 913 <dd>
 914 <p>
 915         Verify that exactly one parameter is provided, and that it
 916         can be turned into a raw 20-byte SHA-1 that can be used to
 917         access the object database. If so, emit it to the standard
 918         output; otherwise, error out.
 919 </p>
 920 <div class="paragraph"><p>If you want to make sure that the output actually names an object in
 921 your object database and/or can be used as a specific type of object
 922 you require, you can add the <code>^{type}</code> peeling operator to the parameter.
 923 For example, <code>git rev-parse "$VAR^{commit}"</code> will make sure <code>$VAR</code>
 924 names an existing object that is a commit-ish (i.e. a commit, or an
 925 annotated tag that points at a commit).  To make sure that <code>$VAR</code>
 926 names an existing object of any type, <code>git rev-parse "$VAR^{object}"</code>
 927 can be used.</p></div>
 928 <div class="paragraph"><p>Note that if you are verifying a name from an untrusted source, it is
 929 wise to use <code>--end-of-options</code> so that the name argument is not mistaken
 930 for another option.</p></div>
 931 </dd>
 932 <dt class="hdlist1">
 933 -q
 934 </dt>
 935 <dt class="hdlist1">
 936 --quiet
 937 </dt>
 938 <dd>
 939 <p>
 940         Only meaningful in <code>--verify</code> mode. Do not output an error
 941         message if the first argument is not a valid object name;
 942         instead exit with non-zero status silently.
 943         SHA-1s for valid object names are printed to stdout on success.
 944 </p>
 945 </dd>
 946 <dt class="hdlist1">
 947 --sq
 948 </dt>
 949 <dd>
 950 <p>
 951         Usually the output is made one line per flag and
 952         parameter.  This option makes output a single line,
 953         properly quoted for consumption by shell.  Useful when
 954         you expect your parameter to contain whitespaces and
 955         newlines (e.g. when using pickaxe <code>-S</code> with
 956         <em>git diff-&#42;</em>). In contrast to the <code>--sq-quote</code> option,
 957         the command input is still interpreted as usual.
 958 </p>
 959 </dd>
 960 <dt class="hdlist1">
 961 --short[=&lt;length&gt;]
 962 </dt>
 963 <dd>
 964 <p>
 965         Same as <code>--verify</code> but shortens the object name to a unique
 966         prefix with at least <code>length</code> characters. The minimum length
 967         is 4, the default is the effective value of the <code>core.abbrev</code>
 968         configuration variable (see <a href="git-config.html">git-config(1)</a>).
 969 </p>
 970 </dd>
 971 <dt class="hdlist1">
 972 --not
 973 </dt>
 974 <dd>
 975 <p>
 976         When showing object names, prefix them with <em>&#94;</em> and
 977         strip <em>&#94;</em> prefix from the object names that already have
 978         one.
 979 </p>
 980 </dd>
 981 <dt class="hdlist1">
 982 --abbrev-ref[=(strict|loose)]
 983 </dt>
 984 <dd>
 985 <p>
 986         A non-ambiguous short name of the objects name.
 987         The option core.warnAmbiguousRefs is used to select the strict
 988         abbreviation mode.
 989 </p>
 990 </dd>
 991 <dt class="hdlist1">
 992 --symbolic
 993 </dt>
 994 <dd>
 995 <p>
 996         Usually the object names are output in SHA-1 form (with
 997         possible <em>&#94;</em> prefix); this option makes them output in a
 998         form as close to the original input as possible.
 999 </p>
1000 </dd>
1001 <dt class="hdlist1">
1002 --symbolic-full-name
1003 </dt>
1004 <dd>
1005 <p>
1006         This is similar to --symbolic, but it omits input that
1007         are not refs (i.e. branch or tag names; or more
1008         explicitly disambiguating "heads/master" form, when you
1009         want to name the "master" branch when there is an
1010         unfortunately named tag "master"), and shows them as full
1011         refnames (e.g. "refs/heads/master").
1012 </p>
1013 </dd>
1014 <dt class="hdlist1">
1015 --output-object-format=(sha1|sha256|storage)
1016 </dt>
1017 <dd>
1018 <p>
1019         Allow oids to be input from any object format that the current
1020         repository supports.
1021 </p>
1022 <div class="literalblock">
1023 <div class="content">
1024 <pre><code>Specifying "sha1" translates if necessary and returns a sha1 oid.</code></pre>
1025 </div></div>
1026 <div class="literalblock">
1027 <div class="content">
1028 <pre><code>Specifying "sha256" translates if necessary and returns a sha256 oid.</code></pre>
1029 </div></div>
1030 <div class="literalblock">
1031 <div class="content">
1032 <pre><code>Specifying "storage" translates if necessary and returns an oid in
1033 encoded in the storage hash algorithm.</code></pre>
1034 </div></div>
1035 </dd>
1036 </dl></div>
1037 </div>
1038 <div class="sect2">
1039 <h3 id="_options_for_objects">Options for Objects</h3>
1040 <div class="dlist"><dl>
1041 <dt class="hdlist1">
1042 --all
1043 </dt>
1044 <dd>
1045 <p>
1046         Show all refs found in <code>refs/</code>.
1047 </p>
1048 </dd>
1049 <dt class="hdlist1">
1050 --branches[=&lt;pattern&gt;]
1051 </dt>
1052 <dt class="hdlist1">
1053 --tags[=&lt;pattern&gt;]
1054 </dt>
1055 <dt class="hdlist1">
1056 --remotes[=&lt;pattern&gt;]
1057 </dt>
1058 <dd>
1059 <p>
1060         Show all branches, tags, or remote-tracking branches,
1061         respectively (i.e., refs found in <code>refs/heads</code>,
1062         <code>refs/tags</code>, or <code>refs/remotes</code>, respectively).
1063 </p>
1064 <div class="paragraph"><p>If a <code>pattern</code> is given, only refs matching the given shell glob are
1065 shown.  If the pattern does not contain a globbing character (<code>?</code>,
1066 <code>*</code>, or <code>[</code>), it is turned into a prefix match by appending <code>/*</code>.</p></div>
1067 </dd>
1068 <dt class="hdlist1">
1069 --glob=&lt;pattern&gt;
1070 </dt>
1071 <dd>
1072 <p>
1073         Show all refs matching the shell glob pattern <code>pattern</code>. If
1074         the pattern does not start with <code>refs/</code>, this is automatically
1075         prepended.  If the pattern does not contain a globbing
1076         character (<code>?</code>, <code>*</code>, or <code>[</code>), it is turned into a prefix
1077         match by appending <code>/*</code>.
1078 </p>
1079 </dd>
1080 <dt class="hdlist1">
1081 --exclude=&lt;glob-pattern&gt;
1082 </dt>
1083 <dd>
1084 <p>
1085         Do not include refs matching <em>&lt;glob-pattern&gt;</em> that the next <code>--all</code>,
1086         <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or <code>--glob</code> would otherwise
1087         consider. Repetitions of this option accumulate exclusion patterns
1088         up to the next <code>--all</code>, <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or
1089         <code>--glob</code> option (other options or arguments do not clear
1090         accumulated patterns).
1091 </p>
1092 <div class="paragraph"><p>The patterns given should not begin with <code>refs/heads</code>, <code>refs/tags</code>, or
1093 <code>refs/remotes</code> when applied to <code>--branches</code>, <code>--tags</code>, or <code>--remotes</code>,
1094 respectively, and they must begin with <code>refs/</code> when applied to <code>--glob</code>
1095 or <code>--all</code>. If a trailing <em>/&#42;</em> is intended, it must be given
1096 explicitly.</p></div>
1097 </dd>
1098 <dt class="hdlist1">
1099 --exclude-hidden=(fetch|receive|uploadpack)
1100 </dt>
1101 <dd>
1102 <p>
1103         Do not include refs that would be hidden by <code>git-fetch</code>,
1104         <code>git-receive-pack</code> or <code>git-upload-pack</code> by consulting the appropriate
1105         <code>fetch.hideRefs</code>, <code>receive.hideRefs</code> or <code>uploadpack.hideRefs</code>
1106         configuration along with <code>transfer.hideRefs</code> (see
1107         <a href="git-config.html">git-config(1)</a>). This option affects the next pseudo-ref option
1108         <code>--all</code> or <code>--glob</code> and is cleared after processing them.
1109 </p>
1110 </dd>
1111 <dt class="hdlist1">
1112 --disambiguate=&lt;prefix&gt;
1113 </dt>
1114 <dd>
1115 <p>
1116         Show every object whose name begins with the given prefix.
1117         The &lt;prefix&gt; must be at least 4 hexadecimal digits long to
1118         avoid listing each and every object in the repository by
1119         mistake.
1120 </p>
1121 </dd>
1122 </dl></div>
1123 </div>
1124 <div class="sect2">
1125 <h3 id="_options_for_files">Options for Files</h3>
1126 <div class="dlist"><dl>
1127 <dt class="hdlist1">
1128 --local-env-vars
1129 </dt>
1130 <dd>
1131 <p>
1132         List the GIT_* environment variables that are local to the
1133         repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
1134         Only the names of the variables are listed, not their value,
1135         even if they are set.
1136 </p>
1137 </dd>
1138 <dt class="hdlist1">
1139 --path-format=(absolute|relative)
1140 </dt>
1141 <dd>
1142 <p>
1143         Controls the behavior of certain other options. If specified as absolute, the
1144         paths printed by those options will be absolute and canonical. If specified as
1145         relative, the paths will be relative to the current working directory if that
1146         is possible.  The default is option specific.
1147 </p>
1148 <div class="paragraph"><p>This option may be specified multiple times and affects only the arguments that
1149 follow it on the command line, either to the end of the command line or the next
1150 instance of this option.</p></div>
1151 </dd>
1152 </dl></div>
1153 <div class="paragraph"><p>The following options are modified by <code>--path-format</code>:</p></div>
1154 <div class="dlist"><dl>
1155 <dt class="hdlist1">
1156 --git-dir
1157 </dt>
1158 <dd>
1159 <p>
1160         Show <code>$GIT_DIR</code> if defined. Otherwise show the path to
1161         the .git directory. The path shown, when relative, is
1162         relative to the current working directory.
1163 </p>
1164 <div class="paragraph"><p>If <code>$GIT_DIR</code> is not defined and the current directory
1165 is not detected to lie in a Git repository or work tree
1166 print a message to stderr and exit with nonzero status.</p></div>
1167 </dd>
1168 <dt class="hdlist1">
1169 --git-common-dir
1170 </dt>
1171 <dd>
1172 <p>
1173         Show <code>$GIT_COMMON_DIR</code> if defined, else <code>$GIT_DIR</code>.
1174 </p>
1175 </dd>
1176 <dt class="hdlist1">
1177 --resolve-git-dir &lt;path&gt;
1178 </dt>
1179 <dd>
1180 <p>
1181         Check if &lt;path&gt; is a valid repository or a gitfile that
1182         points at a valid repository, and print the location of the
1183         repository.  If &lt;path&gt; is a gitfile then the resolved path
1184         to the real repository is printed.
1185 </p>
1186 </dd>
1187 <dt class="hdlist1">
1188 --git-path &lt;path&gt;
1189 </dt>
1190 <dd>
1191 <p>
1192         Resolve "$GIT_DIR/&lt;path&gt;" and takes other path relocation
1193         variables such as $GIT_OBJECT_DIRECTORY,
1194         $GIT_INDEX_FILE&#8230; into account. For example, if
1195         $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse
1196         --git-path objects/abc" returns /foo/bar/abc.
1197 </p>
1198 </dd>
1199 <dt class="hdlist1">
1200 --show-toplevel
1201 </dt>
1202 <dd>
1203 <p>
1204         Show the (by default, absolute) path of the top-level directory
1205         of the working tree. If there is no working tree, report an error.
1206 </p>
1207 </dd>
1208 <dt class="hdlist1">
1209 --show-superproject-working-tree
1210 </dt>
1211 <dd>
1212 <p>
1213         Show the absolute path of the root of the superproject&#8217;s
1214         working tree (if exists) that uses the current repository as
1215         its submodule.  Outputs nothing if the current repository is
1216         not used as a submodule by any project.
1217 </p>
1218 </dd>
1219 <dt class="hdlist1">
1220 --shared-index-path
1221 </dt>
1222 <dd>
1223 <p>
1224         Show the path to the shared index file in split index mode, or
1225         empty if not in split-index mode.
1226 </p>
1227 </dd>
1228 </dl></div>
1229 <div class="paragraph"><p>The following options are unaffected by <code>--path-format</code>:</p></div>
1230 <div class="dlist"><dl>
1231 <dt class="hdlist1">
1232 --absolute-git-dir
1233 </dt>
1234 <dd>
1235 <p>
1236         Like <code>--git-dir</code>, but its output is always the canonicalized
1237         absolute path.
1238 </p>
1239 </dd>
1240 <dt class="hdlist1">
1241 --is-inside-git-dir
1242 </dt>
1243 <dd>
1244 <p>
1245         When the current working directory is below the repository
1246         directory print "true", otherwise "false".
1247 </p>
1248 </dd>
1249 <dt class="hdlist1">
1250 --is-inside-work-tree
1251 </dt>
1252 <dd>
1253 <p>
1254         When the current working directory is inside the work tree of the
1255         repository print "true", otherwise "false".
1256 </p>
1257 </dd>
1258 <dt class="hdlist1">
1259 --is-bare-repository
1260 </dt>
1261 <dd>
1262 <p>
1263         When the repository is bare print "true", otherwise "false".
1264 </p>
1265 </dd>
1266 <dt class="hdlist1">
1267 --is-shallow-repository
1268 </dt>
1269 <dd>
1270 <p>
1271         When the repository is shallow print "true", otherwise "false".
1272 </p>
1273 </dd>
1274 <dt class="hdlist1">
1275 --show-cdup
1276 </dt>
1277 <dd>
1278 <p>
1279         When the command is invoked from a subdirectory, show the
1280         path of the top-level directory relative to the current
1281         directory (typically a sequence of "../", or an empty string).
1282 </p>
1283 </dd>
1284 <dt class="hdlist1">
1285 --show-prefix
1286 </dt>
1287 <dd>
1288 <p>
1289         When the command is invoked from a subdirectory, show the
1290         path of the current directory relative to the top-level
1291         directory.
1292 </p>
1293 </dd>
1294 <dt class="hdlist1">
1295 --show-object-format[=(storage|input|output)]
1296 </dt>
1297 <dd>
1298 <p>
1299         Show the object format (hash algorithm) used for the repository
1300         for storage inside the <code>.git</code> directory, input, or output. For
1301         input, multiple algorithms may be printed, space-separated.
1302         If not specified, the default is "storage".
1303 </p>
1304 </dd>
1305 <dt class="hdlist1">
1306 --show-ref-format
1307 </dt>
1308 <dd>
1309 <p>
1310         Show the reference storage format used for the repository.
1311 </p>
1312 </dd>
1313 </dl></div>
1314 </div>
1315 <div class="sect2">
1316 <h3 id="_other_options">Other Options</h3>
1317 <div class="dlist"><dl>
1318 <dt class="hdlist1">
1319 --since=&lt;datestring&gt;
1320 </dt>
1321 <dt class="hdlist1">
1322 --after=&lt;datestring&gt;
1323 </dt>
1324 <dd>
1325 <p>
1326         Parse the date string, and output the corresponding
1327         --max-age= parameter for <em>git rev-list</em>.
1328 </p>
1329 </dd>
1330 <dt class="hdlist1">
1331 --until=&lt;datestring&gt;
1332 </dt>
1333 <dt class="hdlist1">
1334 --before=&lt;datestring&gt;
1335 </dt>
1336 <dd>
1337 <p>
1338         Parse the date string, and output the corresponding
1339         --min-age= parameter for <em>git rev-list</em>.
1340 </p>
1341 </dd>
1342 <dt class="hdlist1">
1343 &lt;arg&gt;&#8230;
1344 </dt>
1345 <dd>
1346 <p>
1347         Flags and parameters to be parsed.
1348 </p>
1349 </dd>
1350 </dl></div>
1351 </div>
1352 </div>
1353 </div>
1354 <div class="sect1">
1355 <h2 id="_specifying_revisions">SPECIFYING REVISIONS</h2>
1356 <div class="sectionbody">
1357 <div class="paragraph"><p>A revision parameter <em>&lt;rev&gt;</em> typically, but not necessarily, names a
1358 commit object.  It uses what is called an <em>extended SHA-1</em>
1359 syntax.  Here are various ways to spell object names.  The
1360 ones listed near the end of this list name trees and
1361 blobs contained in a commit.</p></div>
1362 <div class="admonitionblock">
1363 <table><tr>
1364 <td class="icon">
1365 <div class="title">Note</div>
1366 </td>
1367 <td class="content">This document shows the "raw" syntax as seen by git. The shell
1368 and other UIs might require additional quoting to protect special
1369 characters and to avoid word splitting.</td>
1370 </tr></table>
1371 </div>
1372 <div class="dlist"><dl>
1373 <dt class="hdlist1">
1374 <em>&lt;sha1&gt;</em>, e.g. <em>dae86e1950b1277e545cee180551750029cfe735</em>, <em>dae86e</em>
1375 </dt>
1376 <dd>
1377 <p>
1378   The full SHA-1 object name (40-byte hexadecimal string), or
1379   a leading substring that is unique within the repository.
1380   E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
1381   name the same commit object if there is no other object in
1382   your repository whose object name starts with dae86e.
1383 </p>
1384 </dd>
1385 <dt class="hdlist1">
1386 <em>&lt;describeOutput&gt;</em>, e.g. <em>v1.7.4.2-679-g3bee7fb</em>
1387 </dt>
1388 <dd>
1389 <p>
1390   Output from <code>git describe</code>; i.e. a closest tag, optionally
1391   followed by a dash and a number of commits, followed by a dash, a
1392   <em>g</em>, and an abbreviated object name.
1393 </p>
1394 </dd>
1395 <dt class="hdlist1">
1396 <em>&lt;refname&gt;</em>, e.g. <em>master</em>, <em>heads/master</em>, <em>refs/heads/master</em>
1397 </dt>
1398 <dd>
1399 <p>
1400   A symbolic ref name.  E.g. <em>master</em> typically means the commit
1401   object referenced by <em>refs/heads/master</em>.  If you
1402   happen to have both <em>heads/master</em> and <em>tags/master</em>, you can
1403   explicitly say <em>heads/master</em> to tell Git which one you mean.
1404   When ambiguous, a <em>&lt;refname&gt;</em> is disambiguated by taking the
1405   first match in the following rules:
1406 </p>
1407 <div class="olist arabic"><ol class="arabic">
1408 <li>
1409 <p>
1410 If <em>$GIT_DIR/&lt;refname&gt;</em> exists, that is what you mean (this is usually
1411     useful only for <code>HEAD</code>, <code>FETCH_HEAD</code>, <code>ORIG_HEAD</code>, <code>MERGE_HEAD</code>,
1412     <code>REBASE_HEAD</code>, <code>REVERT_HEAD</code>, <code>CHERRY_PICK_HEAD</code>, <code>BISECT_HEAD</code>
1413     and <code>AUTO_MERGE</code>);
1414 </p>
1415 </li>
1416 <li>
1417 <p>
1418 otherwise, <em>refs/&lt;refname&gt;</em> if it exists;
1419 </p>
1420 </li>
1421 <li>
1422 <p>
1423 otherwise, <em>refs/tags/&lt;refname&gt;</em> if it exists;
1424 </p>
1425 </li>
1426 <li>
1427 <p>
1428 otherwise, <em>refs/heads/&lt;refname&gt;</em> if it exists;
1429 </p>
1430 </li>
1431 <li>
1432 <p>
1433 otherwise, <em>refs/remotes/&lt;refname&gt;</em> if it exists;
1434 </p>
1435 </li>
1436 <li>
1437 <p>
1438 otherwise, <em>refs/remotes/&lt;refname&gt;/HEAD</em> if it exists.
1439 </p>
1440 </li>
1441 </ol></div>
1442 <div class="dlist"><dl>
1443 <dt class="hdlist1">
1444 <code>HEAD</code>
1445 </dt>
1446 <dd>
1447 <p>
1448     names the commit on which you based the changes in the working tree.
1449 </p>
1450 </dd>
1451 <dt class="hdlist1">
1452 <code>FETCH_HEAD</code>
1453 </dt>
1454 <dd>
1455 <p>
1456     records the branch which you fetched from a remote repository with
1457     your last <code>git fetch</code> invocation.
1458 </p>
1459 </dd>
1460 <dt class="hdlist1">
1461 <code>ORIG_HEAD</code>
1462 </dt>
1463 <dd>
1464 <p>
1465     is created by commands that move your <code>HEAD</code> in a drastic way (<code>git
1466     am</code>, <code>git merge</code>, <code>git rebase</code>, <code>git reset</code>), to record the position
1467     of the <code>HEAD</code> before their operation, so that you can easily change
1468     the tip of the branch back to the state before you ran them.
1469 </p>
1470 </dd>
1471 <dt class="hdlist1">
1472 <code>MERGE_HEAD</code>
1473 </dt>
1474 <dd>
1475 <p>
1476     records the commit(s) which you are merging into your branch when you
1477     run <code>git merge</code>.
1478 </p>
1479 </dd>
1480 <dt class="hdlist1">
1481 <code>REBASE_HEAD</code>
1482 </dt>
1483 <dd>
1484 <p>
1485     during a rebase, records the commit at which the operation is
1486     currently stopped, either because of conflicts or an <code>edit</code> command in
1487     an interactive rebase.
1488 </p>
1489 </dd>
1490 <dt class="hdlist1">
1491 <code>REVERT_HEAD</code>
1492 </dt>
1493 <dd>
1494 <p>
1495     records the commit which you are reverting when you run <code>git revert</code>.
1496 </p>
1497 </dd>
1498 <dt class="hdlist1">
1499 <code>CHERRY_PICK_HEAD</code>
1500 </dt>
1501 <dd>
1502 <p>
1503     records the commit which you are cherry-picking when you run <code>git
1504     cherry-pick</code>.
1505 </p>
1506 </dd>
1507 <dt class="hdlist1">
1508 <code>BISECT_HEAD</code>
1509 </dt>
1510 <dd>
1511 <p>
1512     records the current commit to be tested when you run <code>git bisect
1513     --no-checkout</code>.
1514 </p>
1515 </dd>
1516 <dt class="hdlist1">
1517 <code>AUTO_MERGE</code>
1518 </dt>
1519 <dd>
1520 <p>
1521     records a tree object corresponding to the state the
1522     <em>ort</em> merge strategy wrote to the working tree when a merge operation
1523     resulted in conflicts.
1524 </p>
1525 </dd>
1526 </dl></div>
1527 <div class="paragraph"><p>Note that any of the <em>refs/*</em> cases above may come either from
1528 the <code>$GIT_DIR/refs</code> directory or from the <code>$GIT_DIR/packed-refs</code> file.
1529 While the ref name encoding is unspecified, UTF-8 is preferred as
1530 some output processing may assume ref names in UTF-8.</p></div>
1531 </dd>
1532 <dt class="hdlist1">
1533 <em>@</em>
1534 </dt>
1535 <dd>
1536 <p>
1537   <em>@</em> alone is a shortcut for <code>HEAD</code>.
1538 </p>
1539 </dd>
1540 <dt class="hdlist1">
1541 <em>[&lt;refname&gt;]@{&lt;date&gt;}</em>, e.g. <em>master@{yesterday}</em>, <em>HEAD@{5 minutes ago}</em>
1542 </dt>
1543 <dd>
1544 <p>
1545   A ref followed by the suffix <em>@</em> with a date specification
1546   enclosed in a brace
1547   pair (e.g. <em>{yesterday}</em>, <em>{1 month 2 weeks 3 days 1 hour 1
1548   second ago}</em> or <em>{1979-02-26 18:30:00}</em>) specifies the value
1549   of the ref at a prior point in time.  This suffix may only be
1550   used immediately following a ref name and the ref must have an
1551   existing log (<em>$GIT_DIR/logs/&lt;ref&gt;</em>). Note that this looks up the state
1552   of your <strong>local</strong> ref at a given time; e.g., what was in your local
1553   <em>master</em> branch last week. If you want to look at commits made during
1554   certain times, see <code>--since</code> and <code>--until</code>.
1555 </p>
1556 </dd>
1557 <dt class="hdlist1">
1558 <em>&lt;refname&gt;@{&lt;n&gt;}</em>, e.g. <em>master@{1}</em>
1559 </dt>
1560 <dd>
1561 <p>
1562   A ref followed by the suffix <em>@</em> with an ordinal specification
1563   enclosed in a brace pair (e.g. <em>{1}</em>, <em>{15}</em>) specifies
1564   the n-th prior value of that ref.  For example <em>master@{1}</em>
1565   is the immediate prior value of <em>master</em> while <em>master@{5}</em>
1566   is the 5th prior value of <em>master</em>. This suffix may only be used
1567   immediately following a ref name and the ref must have an existing
1568   log (<em>$GIT_DIR/logs/&lt;refname&gt;</em>).
1569 </p>
1570 </dd>
1571 <dt class="hdlist1">
1572 <em>@{&lt;n&gt;}</em>, e.g. <em>@{1}</em>
1573 </dt>
1574 <dd>
1575 <p>
1576   You can use the <em>@</em> construct with an empty ref part to get at a
1577   reflog entry of the current branch. For example, if you are on
1578   branch <em>blabla</em> then <em>@{1}</em> means the same as <em>blabla@{1}</em>.
1579 </p>
1580 </dd>
1581 <dt class="hdlist1">
1582 <em>@{-&lt;n&gt;}</em>, e.g. <em>@{-1}</em>
1583 </dt>
1584 <dd>
1585 <p>
1586   The construct <em>@{-&lt;n&gt;}</em> means the &lt;n&gt;th branch/commit checked out
1587   before the current one.
1588 </p>
1589 </dd>
1590 <dt class="hdlist1">
1591 <em>[&lt;branchname&gt;]@{upstream}</em>, e.g. <em>master@{upstream}</em>, <em>@{u}</em>
1592 </dt>
1593 <dd>
1594 <p>
1595   A branch B may be set up to build on top of a branch X (configured with
1596   <code>branch.&lt;name&gt;.merge</code>) at a remote R (configured with
1597   the branch X taken from remote R, typically found at <code>refs/remotes/R/X</code>.
1598 </p>
1599 </dd>
1600 <dt class="hdlist1">
1601 <em>[&lt;branchname&gt;]@{push}</em>, e.g. <em>master@{push}</em>, <em>@{push}</em>
1602 </dt>
1603 <dd>
1604 <p>
1605   The suffix <em>@{push}</em> reports the branch "where we would push to" if
1606   <code>git push</code> were run while <code>branchname</code> was checked out (or the current
1607   <code>HEAD</code> if no branchname is specified). Like for <em>@{upstream}</em>, we report
1608   the remote-tracking branch that corresponds to that branch at the remote.
1609 </p>
1610 <div class="paragraph"><p>Here&#8217;s an example to make it more clear:</p></div>
1611 <div class="listingblock">
1612 <div class="content">
1613 <pre><code>$ git config push.default current
1614 $ git config remote.pushdefault myfork
1615 $ git switch -c mybranch origin/master
1616
1617 $ git rev-parse --symbolic-full-name @{upstream}
1618 refs/remotes/origin/master
1619
1620 $ git rev-parse --symbolic-full-name @{push}
1621 refs/remotes/myfork/mybranch</code></pre>
1622 </div></div>
1623 <div class="paragraph"><p>Note in the example that we set up a triangular workflow, where we pull
1624 from one location and push to another. In a non-triangular workflow,
1625 <em>@{push}</em> is the same as <em>@{upstream}</em>, and there is no need for it.</p></div>
1626 <div class="paragraph"><p>This suffix is also accepted when spelled in uppercase, and means the same
1627 thing no matter the case.</p></div>
1628 </dd>
1629 <dt class="hdlist1">
1630 <em>&lt;rev&gt;&#94;[&lt;n&gt;]</em>, e.g. <em>HEAD&#94;, v1.5.1&#94;0</em>
1631 </dt>
1632 <dd>
1633 <p>
1634   A suffix <em>&#94;</em> to a revision parameter means the first parent of
1635   that commit object.  <em>&#94;&lt;n&gt;</em> means the &lt;n&gt;th parent (i.e.
1636   <em>&lt;rev&gt;&#94;</em>
1637   is equivalent to <em>&lt;rev&gt;&#94;1</em>).  As a special rule,
1638   <em>&lt;rev&gt;&#94;0</em> means the commit itself and is used when <em>&lt;rev&gt;</em> is the
1639   object name of a tag object that refers to a commit object.
1640 </p>
1641 </dd>
1642 <dt class="hdlist1">
1643 <em>&lt;rev&gt;&#126;[&lt;n&gt;]</em>, e.g. <em>HEAD&#126;, master&#126;3</em>
1644 </dt>
1645 <dd>
1646 <p>
1647   A suffix <em>&#126;</em> to a revision parameter means the first parent of
1648   that commit object.
1649   A suffix <em>&#126;&lt;n&gt;</em> to a revision parameter means the commit
1650   object that is the &lt;n&gt;th generation ancestor of the named
1651   commit object, following only the first parents.  I.e. <em>&lt;rev&gt;&#126;3</em> is
1652   equivalent to <em>&lt;rev&gt;&#94;&#94;&#94;</em> which is equivalent to
1653   <em>&lt;rev&gt;&#94;1&#94;1&#94;1</em>.  See below for an illustration of
1654   the usage of this form.
1655 </p>
1656 </dd>
1657 <dt class="hdlist1">
1658 <em>&lt;rev&gt;&#94;{&lt;type&gt;}</em>, e.g. <em>v0.99.8&#94;{commit}</em>
1659 </dt>
1660 <dd>
1661 <p>
1662   A suffix <em>&#94;</em> followed by an object type name enclosed in
1663   brace pair means dereference the object at <em>&lt;rev&gt;</em> recursively until
1664   an object of type <em>&lt;type&gt;</em> is found or the object cannot be
1665   dereferenced anymore (in which case, barf).
1666   For example, if <em>&lt;rev&gt;</em> is a commit-ish, <em>&lt;rev&gt;&#94;{commit}</em>
1667   describes the corresponding commit object.
1668   Similarly, if <em>&lt;rev&gt;</em> is a tree-ish, <em>&lt;rev&gt;&#94;{tree}</em>
1669   describes the corresponding tree object.
1670   <em>&lt;rev&gt;&#94;0</em>
1671   is a short-hand for <em>&lt;rev&gt;&#94;{commit}</em>.
1672 </p>
1673 <div class="paragraph"><p><em>&lt;rev&gt;&#94;{object}</em> can be used to make sure <em>&lt;rev&gt;</em> names an
1674 object that exists, without requiring <em>&lt;rev&gt;</em> to be a tag, and
1675 without dereferencing <em>&lt;rev&gt;</em>; because a tag is already an object,
1676 it does not have to be dereferenced even once to get to an object.</p></div>
1677 <div class="paragraph"><p><em>&lt;rev&gt;&#94;{tag}</em> can be used to ensure that <em>&lt;rev&gt;</em> identifies an
1678 existing tag object.</p></div>
1679 </dd>
1680 <dt class="hdlist1">
1681 <em>&lt;rev&gt;&#94;{}</em>, e.g. <em>v0.99.8&#94;{}</em>
1682 </dt>
1683 <dd>
1684 <p>
1685   A suffix <em>&#94;</em> followed by an empty brace pair
1686   means the object could be a tag,
1687   and dereference the tag recursively until a non-tag object is
1688   found.
1689 </p>
1690 </dd>
1691 <dt class="hdlist1">
1692 <em>&lt;rev&gt;&#94;{/&lt;text&gt;}</em>, e.g. <em>HEAD^{/fix nasty bug}</em>
1693 </dt>
1694 <dd>
1695 <p>
1696   A suffix <em>&#94;</em> to a revision parameter, followed by a brace
1697   pair that contains a text led by a slash,
1698   is the same as the <em>:/fix nasty bug</em> syntax below except that
1699   it returns the youngest matching commit which is reachable from
1700   the <em>&lt;rev&gt;</em> before <em>&#94;</em>.
1701 </p>
1702 </dd>
1703 <dt class="hdlist1">
1704 <em>:/&lt;text&gt;</em>, e.g. <em>:/fix nasty bug</em>
1705 </dt>
1706 <dd>
1707 <p>
1708   A colon, followed by a slash, followed by a text, names
1709   a commit whose commit message matches the specified regular expression.
1710   This name returns the youngest matching commit which is
1711   reachable from any ref, including HEAD.
1712   The regular expression can match any part of the
1713   commit message. To match messages starting with a string, one can use
1714   e.g. <em>:/^foo</em>. The special sequence <em>:/!</em> is reserved for modifiers to what
1715   is matched. <em>:/!-foo</em> performs a negative match, while <em>:/!!foo</em> matches a
1716   literal <em>!</em> character, followed by <em>foo</em>. Any other sequence beginning with
1717   <em>:/!</em> is reserved for now.
1718   Depending on the given text, the shell&#8217;s word splitting rules might
1719   require additional quoting.
1720 </p>
1721 </dd>
1722 <dt class="hdlist1">
1723 <em>&lt;rev&gt;:&lt;path&gt;</em>, e.g. <em>HEAD:README</em>, <em>master:./README</em>
1724 </dt>
1725 <dd>
1726 <p>
1727   A suffix <em>:</em> followed by a path names the blob or tree
1728   at the given path in the tree-ish object named by the part
1729   before the colon.
1730   A path starting with <em>./</em> or <em>../</em> is relative to the current working directory.
1731   The given path will be converted to be relative to the working tree&#8217;s root directory.
1732   This is most useful to address a blob or tree from a commit or tree that has
1733   the same tree structure as the working tree.
1734 </p>
1735 </dd>
1736 <dt class="hdlist1">
1737 <em>:[&lt;n&gt;:]&lt;path&gt;</em>, e.g. <em>:0:README</em>, <em>:README</em>
1738 </dt>
1739 <dd>
1740 <p>
1741   A colon, optionally followed by a stage number (0 to 3) and a
1742   colon, followed by a path, names a blob object in the
1743   index at the given path. A missing stage number (and the colon
1744   that follows it) names a stage 0 entry. During a merge, stage
1745   1 is the common ancestor, stage 2 is the target branch&#8217;s version
1746   (typically the current branch), and stage 3 is the version from
1747   the branch which is being merged.
1748 </p>
1749 </dd>
1750 </dl></div>
1751 <div class="paragraph"><p>Here is an illustration, by Jon Loeliger.  Both commit nodes B
1752 and C are parents of commit node A.  Parent commits are ordered
1753 left-to-right.</p></div>
1754 <div class="literalblock">
1755 <div class="content">
1756 <pre><code>G   H   I   J
1757  \ /     \ /
1758   D   E   F
1759    \  |  / \
1760     \ | /   |
1761      \|/    |
1762       B     C
1763        \   /
1764         \ /
1765          A</code></pre>
1766 </div></div>
1767 <div class="literalblock">
1768 <div class="content">
1769 <pre><code>A =      = A^0
1770 B = A^   = A^1     = A~1
1771 C =      = A^2
1772 D = A^^  = A^1^1   = A~2
1773 E = B^2  = A^^2
1774 F = B^3  = A^^3
1775 G = A^^^ = A^1^1^1 = A~3
1776 H = D^2  = B^^2    = A^^^2  = A~2^2
1777 I = F^   = B^3^    = A^^3^
1778 J = F^2  = B^3^2   = A^^3^2</code></pre>
1779 </div></div>
1780 </div>
1781 </div>
1782 <div class="sect1">
1783 <h2 id="_specifying_ranges">SPECIFYING RANGES</h2>
1784 <div class="sectionbody">
1785 <div class="paragraph"><p>History traversing commands such as <code>git log</code> operate on a set
1786 of commits, not just a single commit.</p></div>
1787 <div class="paragraph"><p>For these commands,
1788 specifying a single revision, using the notation described in the
1789 previous section, means the set of commits <code>reachable</code> from the given
1790 commit.</p></div>
1791 <div class="paragraph"><p>Specifying several revisions means the set of commits reachable from
1792 any of the given commits.</p></div>
1793 <div class="paragraph"><p>A commit&#8217;s reachable set is the commit itself and the commits in
1794 its ancestry chain.</p></div>
1795 <div class="paragraph"><p>There are several notations to specify a set of connected commits
1796 (called a "revision range"), illustrated below.</p></div>
1797 <div class="sect2">
1798 <h3 id="_commit_exclusions">Commit Exclusions</h3>
1799 <div class="dlist"><dl>
1800 <dt class="hdlist1">
1801 <em>&#94;&lt;rev&gt;</em> (caret) Notation
1802 </dt>
1803 <dd>
1804 <p>
1805  To exclude commits reachable from a commit, a prefix <em>&#94;</em>
1806  notation is used.  E.g. <em>&#94;r1 r2</em> means commits reachable
1807  from <em>r2</em> but exclude the ones reachable from <em>r1</em> (i.e. <em>r1</em> and
1808  its ancestors).
1809 </p>
1810 </dd>
1811 </dl></div>
1812 </div>
1813 <div class="sect2">
1814 <h3 id="_dotted_range_notations">Dotted Range Notations</h3>
1815 <div class="dlist"><dl>
1816 <dt class="hdlist1">
1817 The <em>..</em> (two-dot) Range Notation
1818 </dt>
1819 <dd>
1820 <p>
1821  The <em>&#94;r1 r2</em> set operation appears so often that there is a shorthand
1822  for it.  When you have two commits <em>r1</em> and <em>r2</em> (named according
1823  to the syntax explained in SPECIFYING REVISIONS above), you can ask
1824  for commits that are reachable from r2 excluding those that are reachable
1825  from r1 by <em>&#94;r1 r2</em> and it can be written as <em>r1..r2</em>.
1826 </p>
1827 </dd>
1828 <dt class="hdlist1">
1829 The <em>...</em> (three-dot) Symmetric Difference Notation
1830 </dt>
1831 <dd>
1832 <p>
1833  A similar notation <em>r1...r2</em> is called symmetric difference
1834  of <em>r1</em> and <em>r2</em> and is defined as
1835  <em>r1 r2 --not $(git merge-base --all r1 r2)</em>.
1836  It is the set of commits that are reachable from either one of
1837  <em>r1</em> (left side) or <em>r2</em> (right side) but not from both.
1838 </p>
1839 </dd>
1840 </dl></div>
1841 <div class="paragraph"><p>In these two shorthand notations, you can omit one end and let it default to HEAD.
1842 For example, <em>origin..</em> is a shorthand for <em>origin..HEAD</em> and asks "What
1843 did I do since I forked from the origin branch?"  Similarly, <em>..origin</em>
1844 is a shorthand for <em>HEAD..origin</em> and asks "What did the origin do since
1845 I forked from them?"  Note that <em>..</em> would mean <em>HEAD..HEAD</em> which is an
1846 empty range that is both reachable and unreachable from HEAD.</p></div>
1847 <div class="paragraph"><p>Commands that are specifically designed to take two distinct ranges
1848 (e.g. "git range-diff R1 R2" to compare two ranges) do exist, but
1849 they are exceptions.  Unless otherwise noted, all "git" commands
1850 that operate on a set of commits work on a single revision range.
1851 In other words, writing two "two-dot range notation" next to each
1852 other, e.g.</p></div>
1853 <div class="literalblock">
1854 <div class="content">
1855 <pre><code>$ git log A..B C..D</code></pre>
1856 </div></div>
1857 <div class="paragraph"><p>does <strong>not</strong> specify two revision ranges for most commands.  Instead
1858 it will name a single connected set of commits, i.e. those that are
1859 reachable from either B or D but are reachable from neither A or C.
1860 In a linear history like this:</p></div>
1861 <div class="literalblock">
1862 <div class="content">
1863 <pre><code>---A---B---o---o---C---D</code></pre>
1864 </div></div>
1865 <div class="paragraph"><p>because A and B are reachable from C, the revision range specified
1866 by these two dotted ranges is a single commit D.</p></div>
1867 </div>
1868 <div class="sect2">
1869 <h3 id="_other_lt_rev_gt_94_parent_shorthand_notations">Other &lt;rev&gt;&#94; Parent Shorthand Notations</h3>
1870 <div class="paragraph"><p>Three other shorthands exist, particularly useful for merge commits,
1871 for naming a set that is formed by a commit and its parent commits.</p></div>
1872 <div class="paragraph"><p>The <em>r1&#94;@</em> notation means all parents of <em>r1</em>.</p></div>
1873 <div class="paragraph"><p>The <em>r1&#94;!</em> notation includes commit <em>r1</em> but excludes all of its parents.
1874 By itself, this notation denotes the single commit <em>r1</em>.</p></div>
1875 <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
1876 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
1877 not given. This is typically useful for merge commits where you
1878 can just pass <em>&lt;commit&gt;&#94;-</em> to get all the commits in the branch
1879 that was merged in merge commit <em>&lt;commit&gt;</em> (including <em>&lt;commit&gt;</em>
1880 itself).</p></div>
1881 <div class="paragraph"><p>While <em>&lt;rev&gt;&#94;&lt;n&gt;</em> was about specifying a single commit parent, these
1882 three notations also consider its parents. For example you can say
1883 <em>HEAD&#94;2&#94;@</em>, however you cannot say <em>HEAD&#94;@&#94;2</em>.</p></div>
1884 </div>
1885 </div>
1886 </div>
1887 <div class="sect1">
1888 <h2 id="_revision_range_summary">Revision Range Summary</h2>
1889 <div class="sectionbody">
1890 <div class="dlist"><dl>
1891 <dt class="hdlist1">
1892 <em>&lt;rev&gt;</em>
1893 </dt>
1894 <dd>
1895 <p>
1896         Include commits that are reachable from &lt;rev&gt; (i.e. &lt;rev&gt; and its
1897         ancestors).
1898 </p>
1899 </dd>
1900 <dt class="hdlist1">
1901 <em>&#94;&lt;rev&gt;</em>
1902 </dt>
1903 <dd>
1904 <p>
1905         Exclude commits that are reachable from &lt;rev&gt; (i.e. &lt;rev&gt; and its
1906         ancestors).
1907 </p>
1908 </dd>
1909 <dt class="hdlist1">
1910 <em>&lt;rev1&gt;..&lt;rev2&gt;</em>
1911 </dt>
1912 <dd>
1913 <p>
1914         Include commits that are reachable from &lt;rev2&gt; but exclude
1915         those that are reachable from &lt;rev1&gt;.  When either &lt;rev1&gt; or
1916         &lt;rev2&gt; is omitted, it defaults to <code>HEAD</code>.
1917 </p>
1918 </dd>
1919 <dt class="hdlist1">
1920 <em>&lt;rev1&gt;...&lt;rev2&gt;</em>
1921 </dt>
1922 <dd>
1923 <p>
1924         Include commits that are reachable from either &lt;rev1&gt; or
1925         &lt;rev2&gt; but exclude those that are reachable from both.  When
1926         either &lt;rev1&gt; or &lt;rev2&gt; is omitted, it defaults to <code>HEAD</code>.
1927 </p>
1928 </dd>
1929 <dt class="hdlist1">
1930 <em>&lt;rev&gt;&#94;@</em>, e.g. <em>HEAD&#94;@</em>
1931 </dt>
1932 <dd>
1933 <p>
1934   A suffix <em>&#94;</em> followed by an at sign is the same as listing
1935   all parents of <em>&lt;rev&gt;</em> (meaning, include anything reachable from
1936   its parents, but not the commit itself).
1937 </p>
1938 </dd>
1939 <dt class="hdlist1">
1940 <em>&lt;rev&gt;&#94;!</em>, e.g. <em>HEAD&#94;!</em>
1941 </dt>
1942 <dd>
1943 <p>
1944   A suffix <em>&#94;</em> followed by an exclamation mark is the same
1945   as giving commit <em>&lt;rev&gt;</em> and all its parents prefixed with
1946   <em>&#94;</em> to exclude them (and their ancestors).
1947 </p>
1948 </dd>
1949 <dt class="hdlist1">
1950 <em>&lt;rev&gt;&#94;-&lt;n&gt;</em>, e.g. <em>HEAD&#94;-, HEAD&#94;-2</em>
1951 </dt>
1952 <dd>
1953 <p>
1954         Equivalent to <em>&lt;rev&gt;&#94;&lt;n&gt;..&lt;rev&gt;</em>, with <em>&lt;n&gt;</em> = 1 if not
1955         given.
1956 </p>
1957 </dd>
1958 </dl></div>
1959 <div class="paragraph"><p>Here are a handful of examples using the Loeliger illustration above,
1960 with each step in the notation&#8217;s expansion and selection carefully
1961 spelt out:</p></div>
1962 <div class="literalblock">
1963 <div class="content">
1964 <pre><code>   Args   Expanded arguments    Selected commits
1965    D                            G H D
1966    D F                          G H I J D F
1967    ^G D                         H D
1968    ^D B                         E I J F B
1969    ^D B C                       E I J F B C
1970    C                            I J F C
1971    B..C   = ^B C                C
1972    B...C  = B ^F C              G H D E B C
1973    B^-    = B^..B
1974           = ^B^1 B              E I J F B
1975    C^@    = C^1
1976           = F                   I J F
1977    B^@    = B^1 B^2 B^3
1978           = D E F               D G H E F I J
1979    C^!    = C ^C^@
1980           = C ^C^1
1981           = C ^F                C
1982    B^!    = B ^B^@
1983           = B ^B^1 ^B^2 ^B^3
1984           = B ^D ^E ^F          B
1985    F^! D  = F ^I ^J D           G H D F</code></pre>
1986 </div></div>
1987 </div>
1988 </div>
1989 <div class="sect1">
1990 <h2 id="_parseopt">PARSEOPT</h2>
1991 <div class="sectionbody">
1992 <div class="paragraph"><p>In <code>--parseopt</code> mode, <em>git rev-parse</em> helps massaging options to bring to shell
1993 scripts the same facilities C builtins have. It works as an option normalizer
1994 (e.g. splits single switches aggregate values), a bit like <code>getopt(1)</code> does.</p></div>
1995 <div class="paragraph"><p>It takes on the standard input the specification of the options to parse and
1996 understand, and echoes on the standard output a string suitable for <code>sh(1)</code> <code>eval</code>
1997 to replace the arguments with normalized ones.  In case of error, it outputs
1998 usage on the standard error stream, and exits with code 129.</p></div>
1999 <div class="paragraph"><p>Note: Make sure you quote the result when passing it to <code>eval</code>.  See
2000 below for an example.</p></div>
2001 <div class="sect2">
2002 <h3 id="_input_format">Input Format</h3>
2003 <div class="paragraph"><p><em>git rev-parse --parseopt</em> input format is fully text based. It has two parts,
2004 separated by a line that contains only <code>--</code>. The lines before the separator
2005 (should be one or more) are used for the usage.
2006 The lines after the separator describe the options.</p></div>
2007 <div class="paragraph"><p>Each line of options has this format:</p></div>
2008 <div class="listingblock">
2009 <div class="content">
2010 <pre><code>&lt;opt-spec&gt;&lt;flags&gt;*&lt;arg-hint&gt;? SP+ help LF</code></pre>
2011 </div></div>
2012 <div class="dlist"><dl>
2013 <dt class="hdlist1">
2014 <code>&lt;opt-spec&gt;</code>
2015 </dt>
2016 <dd>
2017 <p>
2018         its format is the short option character, then the long option name
2019         separated by a comma. Both parts are not required, though at least one
2020         is necessary. May not contain any of the <code>&lt;flags&gt;</code> characters.
2021         <code>h,help</code>, <code>dry-run</code> and <code>f</code> are examples of correct <code>&lt;opt-spec&gt;</code>.
2022 </p>
2023 </dd>
2024 <dt class="hdlist1">
2025 <code>&lt;flags&gt;</code>
2026 </dt>
2027 <dd>
2028 <p>
2029         <code>&lt;flags&gt;</code> are of <code>*</code>, <code>=</code>, <code>?</code> or <code>!</code>.
2030 </p>
2031 <div class="ulist"><ul>
2032 <li>
2033 <p>
2034 Use <code>=</code> if the option takes an argument.
2035 </p>
2036 </li>
2037 <li>
2038 <p>
2039 Use <code>?</code> to mean that the option takes an optional argument. You
2040           probably want to use the <code>--stuck-long</code> mode to be able to
2041           unambiguously parse the optional argument.
2042 </p>
2043 </li>
2044 <li>
2045 <p>
2046 Use <code>*</code> to mean that this option should not be listed in the usage
2047           generated for the <code>-h</code> argument. It&#8217;s shown for <code>--help-all</code> as
2048           documented in <a href="gitcli.html">gitcli(7)</a>.
2049 </p>
2050 </li>
2051 <li>
2052 <p>
2053 Use <code>!</code> to not make the corresponding negated long option available.
2054 </p>
2055 </li>
2056 </ul></div>
2057 </dd>
2058 <dt class="hdlist1">
2059 <code>&lt;arg-hint&gt;</code>
2060 </dt>
2061 <dd>
2062 <p>
2063         <code>&lt;arg-hint&gt;</code>, if specified, is used as a name of the argument in the
2064         help output, for options that take arguments. <code>&lt;arg-hint&gt;</code> is
2065         terminated by the first whitespace.  It is customary to use a
2066         dash to separate words in a multi-word argument hint.
2067 </p>
2068 </dd>
2069 </dl></div>
2070 <div class="paragraph"><p>The remainder of the line, after stripping the spaces, is used
2071 as the help associated with the option.</p></div>
2072 <div class="paragraph"><p>Blank lines are ignored, and lines that don&#8217;t match this specification are used
2073 as option group headers (start the line with a space to create such
2074 lines on purpose).</p></div>
2075 </div>
2076 <div class="sect2">
2077 <h3 id="_example">Example</h3>
2078 <div class="listingblock">
2079 <div class="content">
2080 <pre><code>OPTS_SPEC="\
2081 some-command [&lt;options&gt;] &lt;args&gt;...
2082
2083 some-command does foo and bar!
2084 --
2085 h,help!   show the help
2086
2087 foo       some nifty option --foo
2088 bar=      some cool option --bar with an argument
2089 baz=arg   another cool option --baz with a named argument
2090 qux?path  qux may take a path argument but has meaning by itself
2091
2092   An option group Header
2093 C?        option C with an optional argument"
2094
2095 eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"</code></pre>
2096 </div></div>
2097 </div>
2098 <div class="sect2">
2099 <h3 id="_usage_text">Usage text</h3>
2100 <div class="paragraph"><p>When <code>"$@"</code> is <code>-h</code> or <code>--help</code> in the above example, the following
2101 usage text would be shown:</p></div>
2102 <div class="listingblock">
2103 <div class="content">
2104 <pre><code>usage: some-command [&lt;options&gt;] &lt;args&gt;...
2105
2106     some-command does foo and bar!
2107
2108     -h, --help            show the help
2109     --[no-]foo            some nifty option --foo
2110     --[no-]bar ...        some cool option --bar with an argument
2111     --[no-]baz &lt;arg&gt;      another cool option --baz with a named argument
2112     --[no-]qux[=&lt;path&gt;]   qux may take a path argument but has meaning by itself
2113
2114 An option group Header
2115     -C[...]               option C with an optional argument</code></pre>
2116 </div></div>
2117 </div>
2118 </div>
2119 </div>
2120 <div class="sect1">
2121 <h2 id="_sq_quote">SQ-QUOTE</h2>
2122 <div class="sectionbody">
2123 <div class="paragraph"><p>In <code>--sq-quote</code> mode, <em>git rev-parse</em> echoes on the standard output a
2124 single line suitable for <code>sh(1)</code> <code>eval</code>. This line is made by
2125 normalizing the arguments following <code>--sq-quote</code>. Nothing other than
2126 quoting the arguments is done.</p></div>
2127 <div class="paragraph"><p>If you want command input to still be interpreted as usual by
2128 <em>git rev-parse</em> before the output is shell quoted, see the <code>--sq</code>
2129 option.</p></div>
2130 <div class="sect2">
2131 <h3 id="_example_2">Example</h3>
2132 <div class="listingblock">
2133 <div class="content">
2134 <pre><code>$ cat &gt;your-git-script.sh &lt;&lt;\EOF
2135 #!/bin/sh
2136 args=$(git rev-parse --sq-quote "$@")   # quote user-supplied arguments
2137 command="git frotz -n24 $args"          # and use it inside a handcrafted
2138                                         # command line
2139 eval "$command"
2140 EOF
2141
2142 $ sh your-git-script.sh "a b'c"</code></pre>
2143 </div></div>
2144 </div>
2145 </div>
2146 </div>
2147 <div class="sect1">
2148 <h2 id="_examples">EXAMPLES</h2>
2149 <div class="sectionbody">
2150 <div class="ulist"><ul>
2151 <li>
2152 <p>
2153 Print the object name of the current commit:
2154 </p>
2155 <div class="listingblock">
2156 <div class="content">
2157 <pre><code>$ git rev-parse --verify HEAD</code></pre>
2158 </div></div>
2159 </li>
2160 <li>
2161 <p>
2162 Print the commit object name from the revision in the $REV shell variable:
2163 </p>
2164 <div class="listingblock">
2165 <div class="content">
2166 <pre><code>$ git rev-parse --verify --end-of-options $REV^{commit}</code></pre>
2167 </div></div>
2168 <div class="paragraph"><p>This will error out if $REV is empty or not a valid revision.</p></div>
2169 </li>
2170 <li>
2171 <p>
2172 Similar to above:
2173 </p>
2174 <div class="listingblock">
2175 <div class="content">
2176 <pre><code>$ git rev-parse --default master --verify --end-of-options $REV</code></pre>
2177 </div></div>
2178 <div class="paragraph"><p>but if $REV is empty, the commit object name from master will be printed.</p></div>
2179 </li>
2180 </ul></div>
2181 </div>
2182 </div>
2183 <div class="sect1">
2184 <h2 id="_git">GIT</h2>
2185 <div class="sectionbody">
2186 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
2187 </div>
2188 </div>
2189 </div>
2190 <div id="footnotes"><hr /></div>
2191 <div id="footer">
2192 <div id="footer-text">
2193 Last updated
2194  2024-05-28 13:39:08 PDT
2195 </div>
2196 </div>
2197 </body>
2198 </html>