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>.  This command is used to
 765 distinguish between them.</p></div>
 766 </div>
 767 </div>
 768 <div class="sect1">
 769 <h2 id="_options">OPTIONS</h2>
 770 <div class="sectionbody">
 771 <div class="sect2">
 772 <h3 id="_operation_modes">Operation Modes</h3>
 773 <div class="paragraph"><p>Each of these options must appear first on the command line.</p></div>
 774 <div class="dlist"><dl>
 775 <dt class="hdlist1">
 776 --parseopt
 777 </dt>
 778 <dd>
 779 <p>
 780         Use <em>git rev-parse</em> in option parsing mode (see PARSEOPT section below).
 781 </p>
 782 </dd>
 783 <dt class="hdlist1">
 784 --sq-quote
 785 </dt>
 786 <dd>
 787 <p>
 788         Use <em>git rev-parse</em> in shell quoting mode (see SQ-QUOTE
 789         section below). In contrast to the <code>--sq</code> option below, this
 790         mode only does quoting. Nothing else is done to command input.
 791 </p>
 792 </dd>
 793 </dl></div>
 794 </div>
 795 <div class="sect2">
 796 <h3 id="_options_for_parseopt">Options for --parseopt</h3>
 797 <div class="dlist"><dl>
 798 <dt class="hdlist1">
 799 --keep-dashdash
 800 </dt>
 801 <dd>
 802 <p>
 803         Only meaningful in <code>--parseopt</code> mode. Tells the option parser to echo
 804         out the first <code>--</code> met instead of skipping it.
 805 </p>
 806 </dd>
 807 <dt class="hdlist1">
 808 --stop-at-non-option
 809 </dt>
 810 <dd>
 811 <p>
 812         Only meaningful in <code>--parseopt</code> mode.  Lets the option parser stop at
 813         the first non-option argument.  This can be used to parse sub-commands
 814         that take options themselves.
 815 </p>
 816 </dd>
 817 <dt class="hdlist1">
 818 --stuck-long
 819 </dt>
 820 <dd>
 821 <p>
 822         Only meaningful in <code>--parseopt</code> mode. Output the options in their
 823         long form if available, and with their arguments stuck.
 824 </p>
 825 </dd>
 826 </dl></div>
 827 </div>
 828 <div class="sect2">
 829 <h3 id="_options_for_filtering">Options for Filtering</h3>
 830 <div class="dlist"><dl>
 831 <dt class="hdlist1">
 832 --revs-only
 833 </dt>
 834 <dd>
 835 <p>
 836         Do not output flags and parameters not meant for
 837         <em>git rev-list</em> command.
 838 </p>
 839 </dd>
 840 <dt class="hdlist1">
 841 --no-revs
 842 </dt>
 843 <dd>
 844 <p>
 845         Do not output flags and parameters meant for
 846         <em>git rev-list</em> command.
 847 </p>
 848 </dd>
 849 <dt class="hdlist1">
 850 --flags
 851 </dt>
 852 <dd>
 853 <p>
 854         Do not output non-flag parameters.
 855 </p>
 856 </dd>
 857 <dt class="hdlist1">
 858 --no-flags
 859 </dt>
 860 <dd>
 861 <p>
 862         Do not output flag parameters.
 863 </p>
 864 </dd>
 865 </dl></div>
 866 </div>
 867 <div class="sect2">
 868 <h3 id="_options_for_output">Options for Output</h3>
 869 <div class="dlist"><dl>
 870 <dt class="hdlist1">
 871 --default &lt;arg&gt;
 872 </dt>
 873 <dd>
 874 <p>
 875         If there is no parameter given by the user, use <code>&lt;arg&gt;</code>
 876         instead.
 877 </p>
 878 </dd>
 879 <dt class="hdlist1">
 880 --prefix &lt;arg&gt;
 881 </dt>
 882 <dd>
 883 <p>
 884         Behave as if <em>git rev-parse</em> was invoked from the <code>&lt;arg&gt;</code>
 885         subdirectory of the working tree.  Any relative filenames are
 886         resolved as if they are prefixed by <code>&lt;arg&gt;</code> and will be printed
 887         in that form.
 888 </p>
 889 <div class="paragraph"><p>This can be used to convert arguments to a command run in a subdirectory
 890 so that they can still be used after moving to the top-level of the
 891 repository.  For example:</p></div>
 892 <div class="listingblock">
 893 <div class="content">
 894 <pre><code>prefix=$(git rev-parse --show-prefix)
 895 cd "$(git rev-parse --show-toplevel)"
 896 # rev-parse provides the -- needed for 'set'
 897 eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"</code></pre>
 898 </div></div>
 899 </dd>
 900 <dt class="hdlist1">
 901 --verify
 902 </dt>
 903 <dd>
 904 <p>
 905         Verify that exactly one parameter is provided, and that it
 906         can be turned into a raw 20-byte SHA-1 that can be used to
 907         access the object database. If so, emit it to the standard
 908         output; otherwise, error out.
 909 </p>
 910 <div class="paragraph"><p>If you want to make sure that the output actually names an object in
 911 your object database and/or can be used as a specific type of object
 912 you require, you can add the <code>^{type}</code> peeling operator to the parameter.
 913 For example, <code>git rev-parse "$VAR^{commit}"</code> will make sure <code>$VAR</code>
 914 names an existing object that is a commit-ish (i.e. a commit, or an
 915 annotated tag that points at a commit).  To make sure that <code>$VAR</code>
 916 names an existing object of any type, <code>git rev-parse "$VAR^{object}"</code>
 917 can be used.</p></div>
 918 <div class="paragraph"><p>Note that if you are verifying a name from an untrusted source, it is
 919 wise to use <code>--end-of-options</code> so that the name argument is not mistaken
 920 for another option.</p></div>
 921 </dd>
 922 <dt class="hdlist1">
 923 -q
 924 </dt>
 925 <dt class="hdlist1">
 926 --quiet
 927 </dt>
 928 <dd>
 929 <p>
 930         Only meaningful in <code>--verify</code> mode. Do not output an error
 931         message if the first argument is not a valid object name;
 932         instead exit with non-zero status silently.
 933         SHA-1s for valid object names are printed to stdout on success.
 934 </p>
 935 </dd>
 936 <dt class="hdlist1">
 937 --sq
 938 </dt>
 939 <dd>
 940 <p>
 941         Usually the output is made one line per flag and
 942         parameter.  This option makes output a single line,
 943         properly quoted for consumption by shell.  Useful when
 944         you expect your parameter to contain whitespaces and
 945         newlines (e.g. when using pickaxe <code>-S</code> with
 946         <em>git diff-&#42;</em>). In contrast to the <code>--sq-quote</code> option,
 947         the command input is still interpreted as usual.
 948 </p>
 949 </dd>
 950 <dt class="hdlist1">
 951 --short[=&lt;length&gt;]
 952 </dt>
 953 <dd>
 954 <p>
 955         Same as <code>--verify</code> but shortens the object name to a unique
 956         prefix with at least <code>length</code> characters. The minimum length
 957         is 4, the default is the effective value of the <code>core.abbrev</code>
 958         configuration variable (see <a href="git-config.html">git-config(1)</a>).
 959 </p>
 960 </dd>
 961 <dt class="hdlist1">
 962 --not
 963 </dt>
 964 <dd>
 965 <p>
 966         When showing object names, prefix them with <em>&#94;</em> and
 967         strip <em>&#94;</em> prefix from the object names that already have
 968         one.
 969 </p>
 970 </dd>
 971 <dt class="hdlist1">
 972 --abbrev-ref[=(strict|loose)]
 973 </dt>
 974 <dd>
 975 <p>
 976         A non-ambiguous short name of the objects name.
 977         The option core.warnAmbiguousRefs is used to select the strict
 978         abbreviation mode.
 979 </p>
 980 </dd>
 981 <dt class="hdlist1">
 982 --symbolic
 983 </dt>
 984 <dd>
 985 <p>
 986         Usually the object names are output in SHA-1 form (with
 987         possible <em>&#94;</em> prefix); this option makes them output in a
 988         form as close to the original input as possible.
 989 </p>
 990 </dd>
 991 <dt class="hdlist1">
 992 --symbolic-full-name
 993 </dt>
 994 <dd>
 995 <p>
 996         This is similar to --symbolic, but it omits input that
 997         are not refs (i.e. branch or tag names; or more
 998         explicitly disambiguating "heads/master" form, when you
 999         want to name the "master" branch when there is an
1000         unfortunately named tag "master"), and shows them as full
1001         refnames (e.g. "refs/heads/master").
1002 </p>
1003 </dd>
1004 <dt class="hdlist1">
1005 --output-object-format=(sha1|sha256|storage)
1006 </dt>
1007 <dd>
1008 <p>
1009         Allow oids to be input from any object format that the current
1010         repository supports.
1011 </p>
1012 <div class="literalblock">
1013 <div class="content">
1014 <pre><code>Specifying "sha1" translates if necessary and returns a sha1 oid.</code></pre>
1015 </div></div>
1016 <div class="literalblock">
1017 <div class="content">
1018 <pre><code>Specifying "sha256" translates if necessary and returns a sha256 oid.</code></pre>
1019 </div></div>
1020 <div class="literalblock">
1021 <div class="content">
1022 <pre><code>Specifying "storage" translates if necessary and returns an oid in
1023 encoded in the storage hash algorithm.</code></pre>
1024 </div></div>
1025 </dd>
1026 </dl></div>
1027 </div>
1028 <div class="sect2">
1029 <h3 id="_options_for_objects">Options for Objects</h3>
1030 <div class="dlist"><dl>
1031 <dt class="hdlist1">
1032 --all
1033 </dt>
1034 <dd>
1035 <p>
1036         Show all refs found in <code>refs/</code>.
1037 </p>
1038 </dd>
1039 <dt class="hdlist1">
1040 --branches[=&lt;pattern&gt;]
1041 </dt>
1042 <dt class="hdlist1">
1043 --tags[=&lt;pattern&gt;]
1044 </dt>
1045 <dt class="hdlist1">
1046 --remotes[=&lt;pattern&gt;]
1047 </dt>
1048 <dd>
1049 <p>
1050         Show all branches, tags, or remote-tracking branches,
1051         respectively (i.e., refs found in <code>refs/heads</code>,
1052         <code>refs/tags</code>, or <code>refs/remotes</code>, respectively).
1053 </p>
1054 <div class="paragraph"><p>If a <code>pattern</code> is given, only refs matching the given shell glob are
1055 shown.  If the pattern does not contain a globbing character (<code>?</code>,
1056 <code>*</code>, or <code>[</code>), it is turned into a prefix match by appending <code>/*</code>.</p></div>
1057 </dd>
1058 <dt class="hdlist1">
1059 --glob=&lt;pattern&gt;
1060 </dt>
1061 <dd>
1062 <p>
1063         Show all refs matching the shell glob pattern <code>pattern</code>. If
1064         the pattern does not start with <code>refs/</code>, this is automatically
1065         prepended.  If the pattern does not contain a globbing
1066         character (<code>?</code>, <code>*</code>, or <code>[</code>), it is turned into a prefix
1067         match by appending <code>/*</code>.
1068 </p>
1069 </dd>
1070 <dt class="hdlist1">
1071 --exclude=&lt;glob-pattern&gt;
1072 </dt>
1073 <dd>
1074 <p>
1075         Do not include refs matching <em>&lt;glob-pattern&gt;</em> that the next <code>--all</code>,
1076         <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or <code>--glob</code> would otherwise
1077         consider. Repetitions of this option accumulate exclusion patterns
1078         up to the next <code>--all</code>, <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or
1079         <code>--glob</code> option (other options or arguments do not clear
1080         accumulated patterns).
1081 </p>
1082 <div class="paragraph"><p>The patterns given should not begin with <code>refs/heads</code>, <code>refs/tags</code>, or
1083 <code>refs/remotes</code> when applied to <code>--branches</code>, <code>--tags</code>, or <code>--remotes</code>,
1084 respectively, and they must begin with <code>refs/</code> when applied to <code>--glob</code>
1085 or <code>--all</code>. If a trailing <em>/&#42;</em> is intended, it must be given
1086 explicitly.</p></div>
1087 </dd>
1088 <dt class="hdlist1">
1089 --exclude-hidden=(fetch|receive|uploadpack)
1090 </dt>
1091 <dd>
1092 <p>
1093         Do not include refs that would be hidden by <code>git-fetch</code>,
1094         <code>git-receive-pack</code> or <code>git-upload-pack</code> by consulting the appropriate
1095         <code>fetch.hideRefs</code>, <code>receive.hideRefs</code> or <code>uploadpack.hideRefs</code>
1096         configuration along with <code>transfer.hideRefs</code> (see
1097         <a href="git-config.html">git-config(1)</a>). This option affects the next pseudo-ref option
1098         <code>--all</code> or <code>--glob</code> and is cleared after processing them.
1099 </p>
1100 </dd>
1101 <dt class="hdlist1">
1102 --disambiguate=&lt;prefix&gt;
1103 </dt>
1104 <dd>
1105 <p>
1106         Show every object whose name begins with the given prefix.
1107         The &lt;prefix&gt; must be at least 4 hexadecimal digits long to
1108         avoid listing each and every object in the repository by
1109         mistake.
1110 </p>
1111 </dd>
1112 </dl></div>
1113 </div>
1114 <div class="sect2">
1115 <h3 id="_options_for_files">Options for Files</h3>
1116 <div class="dlist"><dl>
1117 <dt class="hdlist1">
1118 --local-env-vars
1119 </dt>
1120 <dd>
1121 <p>
1122         List the GIT_* environment variables that are local to the
1123         repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
1124         Only the names of the variables are listed, not their value,
1125         even if they are set.
1126 </p>
1127 </dd>
1128 <dt class="hdlist1">
1129 --path-format=(absolute|relative)
1130 </dt>
1131 <dd>
1132 <p>
1133         Controls the behavior of certain other options. If specified as absolute, the
1134         paths printed by those options will be absolute and canonical. If specified as
1135         relative, the paths will be relative to the current working directory if that
1136         is possible.  The default is option specific.
1137 </p>
1138 <div class="paragraph"><p>This option may be specified multiple times and affects only the arguments that
1139 follow it on the command line, either to the end of the command line or the next
1140 instance of this option.</p></div>
1141 </dd>
1142 </dl></div>
1143 <div class="paragraph"><p>The following options are modified by <code>--path-format</code>:</p></div>
1144 <div class="dlist"><dl>
1145 <dt class="hdlist1">
1146 --git-dir
1147 </dt>
1148 <dd>
1149 <p>
1150         Show <code>$GIT_DIR</code> if defined. Otherwise show the path to
1151         the .git directory. The path shown, when relative, is
1152         relative to the current working directory.
1153 </p>
1154 <div class="paragraph"><p>If <code>$GIT_DIR</code> is not defined and the current directory
1155 is not detected to lie in a Git repository or work tree
1156 print a message to stderr and exit with nonzero status.</p></div>
1157 </dd>
1158 <dt class="hdlist1">
1159 --git-common-dir
1160 </dt>
1161 <dd>
1162 <p>
1163         Show <code>$GIT_COMMON_DIR</code> if defined, else <code>$GIT_DIR</code>.
1164 </p>
1165 </dd>
1166 <dt class="hdlist1">
1167 --resolve-git-dir &lt;path&gt;
1168 </dt>
1169 <dd>
1170 <p>
1171         Check if &lt;path&gt; is a valid repository or a gitfile that
1172         points at a valid repository, and print the location of the
1173         repository.  If &lt;path&gt; is a gitfile then the resolved path
1174         to the real repository is printed.
1175 </p>
1176 </dd>
1177 <dt class="hdlist1">
1178 --git-path &lt;path&gt;
1179 </dt>
1180 <dd>
1181 <p>
1182         Resolve "$GIT_DIR/&lt;path&gt;" and takes other path relocation
1183         variables such as $GIT_OBJECT_DIRECTORY,
1184         $GIT_INDEX_FILE&#8230; into account. For example, if
1185         $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse
1186         --git-path objects/abc" returns /foo/bar/abc.
1187 </p>
1188 </dd>
1189 <dt class="hdlist1">
1190 --show-toplevel
1191 </dt>
1192 <dd>
1193 <p>
1194         Show the (by default, absolute) path of the top-level directory
1195         of the working tree. If there is no working tree, report an error.
1196 </p>
1197 </dd>
1198 <dt class="hdlist1">
1199 --show-superproject-working-tree
1200 </dt>
1201 <dd>
1202 <p>
1203         Show the absolute path of the root of the superproject&#8217;s
1204         working tree (if exists) that uses the current repository as
1205         its submodule.  Outputs nothing if the current repository is
1206         not used as a submodule by any project.
1207 </p>
1208 </dd>
1209 <dt class="hdlist1">
1210 --shared-index-path
1211 </dt>
1212 <dd>
1213 <p>
1214         Show the path to the shared index file in split index mode, or
1215         empty if not in split-index mode.
1216 </p>
1217 </dd>
1218 </dl></div>
1219 <div class="paragraph"><p>The following options are unaffected by <code>--path-format</code>:</p></div>
1220 <div class="dlist"><dl>
1221 <dt class="hdlist1">
1222 --absolute-git-dir
1223 </dt>
1224 <dd>
1225 <p>
1226         Like <code>--git-dir</code>, but its output is always the canonicalized
1227         absolute path.
1228 </p>
1229 </dd>
1230 <dt class="hdlist1">
1231 --is-inside-git-dir
1232 </dt>
1233 <dd>
1234 <p>
1235         When the current working directory is below the repository
1236         directory print "true", otherwise "false".
1237 </p>
1238 </dd>
1239 <dt class="hdlist1">
1240 --is-inside-work-tree
1241 </dt>
1242 <dd>
1243 <p>
1244         When the current working directory is inside the work tree of the
1245         repository print "true", otherwise "false".
1246 </p>
1247 </dd>
1248 <dt class="hdlist1">
1249 --is-bare-repository
1250 </dt>
1251 <dd>
1252 <p>
1253         When the repository is bare print "true", otherwise "false".
1254 </p>
1255 </dd>
1256 <dt class="hdlist1">
1257 --is-shallow-repository
1258 </dt>
1259 <dd>
1260 <p>
1261         When the repository is shallow print "true", otherwise "false".
1262 </p>
1263 </dd>
1264 <dt class="hdlist1">
1265 --show-cdup
1266 </dt>
1267 <dd>
1268 <p>
1269         When the command is invoked from a subdirectory, show the
1270         path of the top-level directory relative to the current
1271         directory (typically a sequence of "../", or an empty string).
1272 </p>
1273 </dd>
1274 <dt class="hdlist1">
1275 --show-prefix
1276 </dt>
1277 <dd>
1278 <p>
1279         When the command is invoked from a subdirectory, show the
1280         path of the current directory relative to the top-level
1281         directory.
1282 </p>
1283 </dd>
1284 <dt class="hdlist1">
1285 --show-object-format[=(storage|input|output)]
1286 </dt>
1287 <dd>
1288 <p>
1289         Show the object format (hash algorithm) used for the repository
1290         for storage inside the <code>.git</code> directory, input, or output. For
1291         input, multiple algorithms may be printed, space-separated.
1292         If not specified, the default is "storage".
1293 </p>
1294 </dd>
1295 <dt class="hdlist1">
1296 --show-ref-format
1297 </dt>
1298 <dd>
1299 <p>
1300         Show the reference storage format used for the repository.
1301 </p>
1302 </dd>
1303 </dl></div>
1304 </div>
1305 <div class="sect2">
1306 <h3 id="_other_options">Other Options</h3>
1307 <div class="dlist"><dl>
1308 <dt class="hdlist1">
1309 --since=&lt;datestring&gt;
1310 </dt>
1311 <dt class="hdlist1">
1312 --after=&lt;datestring&gt;
1313 </dt>
1314 <dd>
1315 <p>
1316         Parse the date string, and output the corresponding
1317         --max-age= parameter for <em>git rev-list</em>.
1318 </p>
1319 </dd>
1320 <dt class="hdlist1">
1321 --until=&lt;datestring&gt;
1322 </dt>
1323 <dt class="hdlist1">
1324 --before=&lt;datestring&gt;
1325 </dt>
1326 <dd>
1327 <p>
1328         Parse the date string, and output the corresponding
1329         --min-age= parameter for <em>git rev-list</em>.
1330 </p>
1331 </dd>
1332 <dt class="hdlist1">
1333 &lt;arg&gt;&#8230;
1334 </dt>
1335 <dd>
1336 <p>
1337         Flags and parameters to be parsed.
1338 </p>
1339 </dd>
1340 </dl></div>
1341 </div>
1342 </div>
1343 </div>
1344 <div class="sect1">
1345 <h2 id="_specifying_revisions">SPECIFYING REVISIONS</h2>
1346 <div class="sectionbody">
1347 <div class="paragraph"><p>A revision parameter <em>&lt;rev&gt;</em> typically, but not necessarily, names a
1348 commit object.  It uses what is called an <em>extended SHA-1</em>
1349 syntax.  Here are various ways to spell object names.  The
1350 ones listed near the end of this list name trees and
1351 blobs contained in a commit.</p></div>
1352 <div class="admonitionblock">
1353 <table><tr>
1354 <td class="icon">
1355 <div class="title">Note</div>
1356 </td>
1357 <td class="content">This document shows the "raw" syntax as seen by git. The shell
1358 and other UIs might require additional quoting to protect special
1359 characters and to avoid word splitting.</td>
1360 </tr></table>
1361 </div>
1362 <div class="dlist"><dl>
1363 <dt class="hdlist1">
1364 <em>&lt;sha1&gt;</em>, e.g. <em>dae86e1950b1277e545cee180551750029cfe735</em>, <em>dae86e</em>
1365 </dt>
1366 <dd>
1367 <p>
1368   The full SHA-1 object name (40-byte hexadecimal string), or
1369   a leading substring that is unique within the repository.
1370   E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
1371   name the same commit object if there is no other object in
1372   your repository whose object name starts with dae86e.
1373 </p>
1374 </dd>
1375 <dt class="hdlist1">
1376 <em>&lt;describeOutput&gt;</em>, e.g. <em>v1.7.4.2-679-g3bee7fb</em>
1377 </dt>
1378 <dd>
1379 <p>
1380   Output from <code>git describe</code>; i.e. a closest tag, optionally
1381   followed by a dash and a number of commits, followed by a dash, a
1382   <em>g</em>, and an abbreviated object name.
1383 </p>
1384 </dd>
1385 <dt class="hdlist1">
1386 <em>&lt;refname&gt;</em>, e.g. <em>master</em>, <em>heads/master</em>, <em>refs/heads/master</em>
1387 </dt>
1388 <dd>
1389 <p>
1390   A symbolic ref name.  E.g. <em>master</em> typically means the commit
1391   object referenced by <em>refs/heads/master</em>.  If you
1392   happen to have both <em>heads/master</em> and <em>tags/master</em>, you can
1393   explicitly say <em>heads/master</em> to tell Git which one you mean.
1394   When ambiguous, a <em>&lt;refname&gt;</em> is disambiguated by taking the
1395   first match in the following rules:
1396 </p>
1397 <div class="olist arabic"><ol class="arabic">
1398 <li>
1399 <p>
1400 If <em>$GIT_DIR/&lt;refname&gt;</em> exists, that is what you mean (this is usually
1401     useful only for <code>HEAD</code>, <code>FETCH_HEAD</code>, <code>ORIG_HEAD</code>, <code>MERGE_HEAD</code>,
1402     <code>REBASE_HEAD</code>, <code>REVERT_HEAD</code>, <code>CHERRY_PICK_HEAD</code>, <code>BISECT_HEAD</code>
1403     and <code>AUTO_MERGE</code>);
1404 </p>
1405 </li>
1406 <li>
1407 <p>
1408 otherwise, <em>refs/&lt;refname&gt;</em> if it exists;
1409 </p>
1410 </li>
1411 <li>
1412 <p>
1413 otherwise, <em>refs/tags/&lt;refname&gt;</em> if it exists;
1414 </p>
1415 </li>
1416 <li>
1417 <p>
1418 otherwise, <em>refs/heads/&lt;refname&gt;</em> if it exists;
1419 </p>
1420 </li>
1421 <li>
1422 <p>
1423 otherwise, <em>refs/remotes/&lt;refname&gt;</em> if it exists;
1424 </p>
1425 </li>
1426 <li>
1427 <p>
1428 otherwise, <em>refs/remotes/&lt;refname&gt;/HEAD</em> if it exists.
1429 </p>
1430 </li>
1431 </ol></div>
1432 <div class="dlist"><dl>
1433 <dt class="hdlist1">
1434 <code>HEAD</code>
1435 </dt>
1436 <dd>
1437 <p>
1438     names the commit on which you based the changes in the working tree.
1439 </p>
1440 </dd>
1441 <dt class="hdlist1">
1442 <code>FETCH_HEAD</code>
1443 </dt>
1444 <dd>
1445 <p>
1446     records the branch which you fetched from a remote repository with
1447     your last <code>git fetch</code> invocation.
1448 </p>
1449 </dd>
1450 <dt class="hdlist1">
1451 <code>ORIG_HEAD</code>
1452 </dt>
1453 <dd>
1454 <p>
1455     is created by commands that move your <code>HEAD</code> in a drastic way (<code>git
1456     am</code>, <code>git merge</code>, <code>git rebase</code>, <code>git reset</code>), to record the position
1457     of the <code>HEAD</code> before their operation, so that you can easily change
1458     the tip of the branch back to the state before you ran them.
1459 </p>
1460 </dd>
1461 <dt class="hdlist1">
1462 <code>MERGE_HEAD</code>
1463 </dt>
1464 <dd>
1465 <p>
1466     records the commit(s) which you are merging into your branch when you
1467     run <code>git merge</code>.
1468 </p>
1469 </dd>
1470 <dt class="hdlist1">
1471 <code>REBASE_HEAD</code>
1472 </dt>
1473 <dd>
1474 <p>
1475     during a rebase, records the commit at which the operation is
1476     currently stopped, either because of conflicts or an <code>edit</code> command in
1477     an interactive rebase.
1478 </p>
1479 </dd>
1480 <dt class="hdlist1">
1481 <code>REVERT_HEAD</code>
1482 </dt>
1483 <dd>
1484 <p>
1485     records the commit which you are reverting when you run <code>git revert</code>.
1486 </p>
1487 </dd>
1488 <dt class="hdlist1">
1489 <code>CHERRY_PICK_HEAD</code>
1490 </dt>
1491 <dd>
1492 <p>
1493     records the commit which you are cherry-picking when you run <code>git
1494     cherry-pick</code>.
1495 </p>
1496 </dd>
1497 <dt class="hdlist1">
1498 <code>BISECT_HEAD</code>
1499 </dt>
1500 <dd>
1501 <p>
1502     records the current commit to be tested when you run <code>git bisect
1503     --no-checkout</code>.
1504 </p>
1505 </dd>
1506 <dt class="hdlist1">
1507 <code>AUTO_MERGE</code>
1508 </dt>
1509 <dd>
1510 <p>
1511     records a tree object corresponding to the state the
1512     <em>ort</em> merge strategy wrote to the working tree when a merge operation
1513     resulted in conflicts.
1514 </p>
1515 </dd>
1516 </dl></div>
1517 <div class="paragraph"><p>Note that any of the <em>refs/*</em> cases above may come either from
1518 the <code>$GIT_DIR/refs</code> directory or from the <code>$GIT_DIR/packed-refs</code> file.
1519 While the ref name encoding is unspecified, UTF-8 is preferred as
1520 some output processing may assume ref names in UTF-8.</p></div>
1521 </dd>
1522 <dt class="hdlist1">
1523 <em>@</em>
1524 </dt>
1525 <dd>
1526 <p>
1527   <em>@</em> alone is a shortcut for <code>HEAD</code>.
1528 </p>
1529 </dd>
1530 <dt class="hdlist1">
1531 <em>[&lt;refname&gt;]@{&lt;date&gt;}</em>, e.g. <em>master@{yesterday}</em>, <em>HEAD@{5 minutes ago}</em>
1532 </dt>
1533 <dd>
1534 <p>
1535   A ref followed by the suffix <em>@</em> with a date specification
1536   enclosed in a brace
1537   pair (e.g. <em>{yesterday}</em>, <em>{1 month 2 weeks 3 days 1 hour 1
1538   second ago}</em> or <em>{1979-02-26 18:30:00}</em>) specifies the value
1539   of the ref at a prior point in time.  This suffix may only be
1540   used immediately following a ref name and the ref must have an
1541   existing log (<em>$GIT_DIR/logs/&lt;ref&gt;</em>). Note that this looks up the state
1542   of your <strong>local</strong> ref at a given time; e.g., what was in your local
1543   <em>master</em> branch last week. If you want to look at commits made during
1544   certain times, see <code>--since</code> and <code>--until</code>.
1545 </p>
1546 </dd>
1547 <dt class="hdlist1">
1548 <em>&lt;refname&gt;@{&lt;n&gt;}</em>, e.g. <em>master@{1}</em>
1549 </dt>
1550 <dd>
1551 <p>
1552   A ref followed by the suffix <em>@</em> with an ordinal specification
1553   enclosed in a brace pair (e.g. <em>{1}</em>, <em>{15}</em>) specifies
1554   the n-th prior value of that ref.  For example <em>master@{1}</em>
1555   is the immediate prior value of <em>master</em> while <em>master@{5}</em>
1556   is the 5th prior value of <em>master</em>. This suffix may only be used
1557   immediately following a ref name and the ref must have an existing
1558   log (<em>$GIT_DIR/logs/&lt;refname&gt;</em>).
1559 </p>
1560 </dd>
1561 <dt class="hdlist1">
1562 <em>@{&lt;n&gt;}</em>, e.g. <em>@{1}</em>
1563 </dt>
1564 <dd>
1565 <p>
1566   You can use the <em>@</em> construct with an empty ref part to get at a
1567   reflog entry of the current branch. For example, if you are on
1568   branch <em>blabla</em> then <em>@{1}</em> means the same as <em>blabla@{1}</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   The construct <em>@{-&lt;n&gt;}</em> means the &lt;n&gt;th branch/commit checked out
1577   before the current one.
1578 </p>
1579 </dd>
1580 <dt class="hdlist1">
1581 <em>[&lt;branchname&gt;]@{upstream}</em>, e.g. <em>master@{upstream}</em>, <em>@{u}</em>
1582 </dt>
1583 <dd>
1584 <p>
1585   A branch B may be set up to build on top of a branch X (configured with
1586   <code>branch.&lt;name&gt;.merge</code>) at a remote R (configured with
1587   the branch X taken from remote R, typically found at <code>refs/remotes/R/X</code>.
1588 </p>
1589 </dd>
1590 <dt class="hdlist1">
1591 <em>[&lt;branchname&gt;]@{push}</em>, e.g. <em>master@{push}</em>, <em>@{push}</em>
1592 </dt>
1593 <dd>
1594 <p>
1595   The suffix <em>@{push}</em> reports the branch "where we would push to" if
1596   <code>git push</code> were run while <code>branchname</code> was checked out (or the current
1597   <code>HEAD</code> if no branchname is specified). Like for <em>@{upstream}</em>, we report
1598   the remote-tracking branch that corresponds to that branch at the remote.
1599 </p>
1600 <div class="paragraph"><p>Here&#8217;s an example to make it more clear:</p></div>
1601 <div class="listingblock">
1602 <div class="content">
1603 <pre><code>$ git config push.default current
1604 $ git config remote.pushdefault myfork
1605 $ git switch -c mybranch origin/master
1606
1607 $ git rev-parse --symbolic-full-name @{upstream}
1608 refs/remotes/origin/master
1609
1610 $ git rev-parse --symbolic-full-name @{push}
1611 refs/remotes/myfork/mybranch</code></pre>
1612 </div></div>
1613 <div class="paragraph"><p>Note in the example that we set up a triangular workflow, where we pull
1614 from one location and push to another. In a non-triangular workflow,
1615 <em>@{push}</em> is the same as <em>@{upstream}</em>, and there is no need for it.</p></div>
1616 <div class="paragraph"><p>This suffix is also accepted when spelled in uppercase, and means the same
1617 thing no matter the case.</p></div>
1618 </dd>
1619 <dt class="hdlist1">
1620 <em>&lt;rev&gt;&#94;[&lt;n&gt;]</em>, e.g. <em>HEAD&#94;, v1.5.1&#94;0</em>
1621 </dt>
1622 <dd>
1623 <p>
1624   A suffix <em>&#94;</em> to a revision parameter means the first parent of
1625   that commit object.  <em>&#94;&lt;n&gt;</em> means the &lt;n&gt;th parent (i.e.
1626   <em>&lt;rev&gt;&#94;</em>
1627   is equivalent to <em>&lt;rev&gt;&#94;1</em>).  As a special rule,
1628   <em>&lt;rev&gt;&#94;0</em> means the commit itself and is used when <em>&lt;rev&gt;</em> is the
1629   object name of a tag object that refers to a commit object.
1630 </p>
1631 </dd>
1632 <dt class="hdlist1">
1633 <em>&lt;rev&gt;&#126;[&lt;n&gt;]</em>, e.g. <em>HEAD&#126;, master&#126;3</em>
1634 </dt>
1635 <dd>
1636 <p>
1637   A suffix <em>&#126;</em> to a revision parameter means the first parent of
1638   that commit object.
1639   A suffix <em>&#126;&lt;n&gt;</em> to a revision parameter means the commit
1640   object that is the &lt;n&gt;th generation ancestor of the named
1641   commit object, following only the first parents.  I.e. <em>&lt;rev&gt;&#126;3</em> is
1642   equivalent to <em>&lt;rev&gt;&#94;&#94;&#94;</em> which is equivalent to
1643   <em>&lt;rev&gt;&#94;1&#94;1&#94;1</em>.  See below for an illustration of
1644   the usage of this form.
1645 </p>
1646 </dd>
1647 <dt class="hdlist1">
1648 <em>&lt;rev&gt;&#94;{&lt;type&gt;}</em>, e.g. <em>v0.99.8&#94;{commit}</em>
1649 </dt>
1650 <dd>
1651 <p>
1652   A suffix <em>&#94;</em> followed by an object type name enclosed in
1653   brace pair means dereference the object at <em>&lt;rev&gt;</em> recursively until
1654   an object of type <em>&lt;type&gt;</em> is found or the object cannot be
1655   dereferenced anymore (in which case, barf).
1656   For example, if <em>&lt;rev&gt;</em> is a commit-ish, <em>&lt;rev&gt;&#94;{commit}</em>
1657   describes the corresponding commit object.
1658   Similarly, if <em>&lt;rev&gt;</em> is a tree-ish, <em>&lt;rev&gt;&#94;{tree}</em>
1659   describes the corresponding tree object.
1660   <em>&lt;rev&gt;&#94;0</em>
1661   is a short-hand for <em>&lt;rev&gt;&#94;{commit}</em>.
1662 </p>
1663 <div class="paragraph"><p><em>&lt;rev&gt;&#94;{object}</em> can be used to make sure <em>&lt;rev&gt;</em> names an
1664 object that exists, without requiring <em>&lt;rev&gt;</em> to be a tag, and
1665 without dereferencing <em>&lt;rev&gt;</em>; because a tag is already an object,
1666 it does not have to be dereferenced even once to get to an object.</p></div>
1667 <div class="paragraph"><p><em>&lt;rev&gt;&#94;{tag}</em> can be used to ensure that <em>&lt;rev&gt;</em> identifies an
1668 existing tag object.</p></div>
1669 </dd>
1670 <dt class="hdlist1">
1671 <em>&lt;rev&gt;&#94;{}</em>, e.g. <em>v0.99.8&#94;{}</em>
1672 </dt>
1673 <dd>
1674 <p>
1675   A suffix <em>&#94;</em> followed by an empty brace pair
1676   means the object could be a tag,
1677   and dereference the tag recursively until a non-tag object is
1678   found.
1679 </p>
1680 </dd>
1681 <dt class="hdlist1">
1682 <em>&lt;rev&gt;&#94;{/&lt;text&gt;}</em>, e.g. <em>HEAD^{/fix nasty bug}</em>
1683 </dt>
1684 <dd>
1685 <p>
1686   A suffix <em>&#94;</em> to a revision parameter, followed by a brace
1687   pair that contains a text led by a slash,
1688   is the same as the <em>:/fix nasty bug</em> syntax below except that
1689   it returns the youngest matching commit which is reachable from
1690   the <em>&lt;rev&gt;</em> before <em>&#94;</em>.
1691 </p>
1692 </dd>
1693 <dt class="hdlist1">
1694 <em>:/&lt;text&gt;</em>, e.g. <em>:/fix nasty bug</em>
1695 </dt>
1696 <dd>
1697 <p>
1698   A colon, followed by a slash, followed by a text, names
1699   a commit whose commit message matches the specified regular expression.
1700   This name returns the youngest matching commit which is
1701   reachable from any ref, including HEAD.
1702   The regular expression can match any part of the
1703   commit message. To match messages starting with a string, one can use
1704   e.g. <em>:/^foo</em>. The special sequence <em>:/!</em> is reserved for modifiers to what
1705   is matched. <em>:/!-foo</em> performs a negative match, while <em>:/!!foo</em> matches a
1706   literal <em>!</em> character, followed by <em>foo</em>. Any other sequence beginning with
1707   <em>:/!</em> is reserved for now.
1708   Depending on the given text, the shell&#8217;s word splitting rules might
1709   require additional quoting.
1710 </p>
1711 </dd>
1712 <dt class="hdlist1">
1713 <em>&lt;rev&gt;:&lt;path&gt;</em>, e.g. <em>HEAD:README</em>, <em>master:./README</em>
1714 </dt>
1715 <dd>
1716 <p>
1717   A suffix <em>:</em> followed by a path names the blob or tree
1718   at the given path in the tree-ish object named by the part
1719   before the colon.
1720   A path starting with <em>./</em> or <em>../</em> is relative to the current working directory.
1721   The given path will be converted to be relative to the working tree&#8217;s root directory.
1722   This is most useful to address a blob or tree from a commit or tree that has
1723   the same tree structure as the working tree.
1724 </p>
1725 </dd>
1726 <dt class="hdlist1">
1727 <em>:[&lt;n&gt;:]&lt;path&gt;</em>, e.g. <em>:0:README</em>, <em>:README</em>
1728 </dt>
1729 <dd>
1730 <p>
1731   A colon, optionally followed by a stage number (0 to 3) and a
1732   colon, followed by a path, names a blob object in the
1733   index at the given path. A missing stage number (and the colon
1734   that follows it) names a stage 0 entry. During a merge, stage
1735   1 is the common ancestor, stage 2 is the target branch&#8217;s version
1736   (typically the current branch), and stage 3 is the version from
1737   the branch which is being merged.
1738 </p>
1739 </dd>
1740 </dl></div>
1741 <div class="paragraph"><p>Here is an illustration, by Jon Loeliger.  Both commit nodes B
1742 and C are parents of commit node A.  Parent commits are ordered
1743 left-to-right.</p></div>
1744 <div class="literalblock">
1745 <div class="content">
1746 <pre><code>G   H   I   J
1747  \ /     \ /
1748   D   E   F
1749    \  |  / \
1750     \ | /   |
1751      \|/    |
1752       B     C
1753        \   /
1754         \ /
1755          A</code></pre>
1756 </div></div>
1757 <div class="literalblock">
1758 <div class="content">
1759 <pre><code>A =      = A^0
1760 B = A^   = A^1     = A~1
1761 C =      = A^2
1762 D = A^^  = A^1^1   = A~2
1763 E = B^2  = A^^2
1764 F = B^3  = A^^3
1765 G = A^^^ = A^1^1^1 = A~3
1766 H = D^2  = B^^2    = A^^^2  = A~2^2
1767 I = F^   = B^3^    = A^^3^
1768 J = F^2  = B^3^2   = A^^3^2</code></pre>
1769 </div></div>
1770 </div>
1771 </div>
1772 <div class="sect1">
1773 <h2 id="_specifying_ranges">SPECIFYING RANGES</h2>
1774 <div class="sectionbody">
1775 <div class="paragraph"><p>History traversing commands such as <code>git log</code> operate on a set
1776 of commits, not just a single commit.</p></div>
1777 <div class="paragraph"><p>For these commands,
1778 specifying a single revision, using the notation described in the
1779 previous section, means the set of commits <code>reachable</code> from the given
1780 commit.</p></div>
1781 <div class="paragraph"><p>Specifying several revisions means the set of commits reachable from
1782 any of the given commits.</p></div>
1783 <div class="paragraph"><p>A commit&#8217;s reachable set is the commit itself and the commits in
1784 its ancestry chain.</p></div>
1785 <div class="paragraph"><p>There are several notations to specify a set of connected commits
1786 (called a "revision range"), illustrated below.</p></div>
1787 <div class="sect2">
1788 <h3 id="_commit_exclusions">Commit Exclusions</h3>
1789 <div class="dlist"><dl>
1790 <dt class="hdlist1">
1791 <em>&#94;&lt;rev&gt;</em> (caret) Notation
1792 </dt>
1793 <dd>
1794 <p>
1795  To exclude commits reachable from a commit, a prefix <em>&#94;</em>
1796  notation is used.  E.g. <em>&#94;r1 r2</em> means commits reachable
1797  from <em>r2</em> but exclude the ones reachable from <em>r1</em> (i.e. <em>r1</em> and
1798  its ancestors).
1799 </p>
1800 </dd>
1801 </dl></div>
1802 </div>
1803 <div class="sect2">
1804 <h3 id="_dotted_range_notations">Dotted Range Notations</h3>
1805 <div class="dlist"><dl>
1806 <dt class="hdlist1">
1807 The <em>..</em> (two-dot) Range Notation
1808 </dt>
1809 <dd>
1810 <p>
1811  The <em>&#94;r1 r2</em> set operation appears so often that there is a shorthand
1812  for it.  When you have two commits <em>r1</em> and <em>r2</em> (named according
1813  to the syntax explained in SPECIFYING REVISIONS above), you can ask
1814  for commits that are reachable from r2 excluding those that are reachable
1815  from r1 by <em>&#94;r1 r2</em> and it can be written as <em>r1..r2</em>.
1816 </p>
1817 </dd>
1818 <dt class="hdlist1">
1819 The <em>...</em> (three-dot) Symmetric Difference Notation
1820 </dt>
1821 <dd>
1822 <p>
1823  A similar notation <em>r1...r2</em> is called symmetric difference
1824  of <em>r1</em> and <em>r2</em> and is defined as
1825  <em>r1 r2 --not $(git merge-base --all r1 r2)</em>.
1826  It is the set of commits that are reachable from either one of
1827  <em>r1</em> (left side) or <em>r2</em> (right side) but not from both.
1828 </p>
1829 </dd>
1830 </dl></div>
1831 <div class="paragraph"><p>In these two shorthand notations, you can omit one end and let it default to HEAD.
1832 For example, <em>origin..</em> is a shorthand for <em>origin..HEAD</em> and asks "What
1833 did I do since I forked from the origin branch?"  Similarly, <em>..origin</em>
1834 is a shorthand for <em>HEAD..origin</em> and asks "What did the origin do since
1835 I forked from them?"  Note that <em>..</em> would mean <em>HEAD..HEAD</em> which is an
1836 empty range that is both reachable and unreachable from HEAD.</p></div>
1837 <div class="paragraph"><p>Commands that are specifically designed to take two distinct ranges
1838 (e.g. "git range-diff R1 R2" to compare two ranges) do exist, but
1839 they are exceptions.  Unless otherwise noted, all "git" commands
1840 that operate on a set of commits work on a single revision range.
1841 In other words, writing two "two-dot range notation" next to each
1842 other, e.g.</p></div>
1843 <div class="literalblock">
1844 <div class="content">
1845 <pre><code>$ git log A..B C..D</code></pre>
1846 </div></div>
1847 <div class="paragraph"><p>does <strong>not</strong> specify two revision ranges for most commands.  Instead
1848 it will name a single connected set of commits, i.e. those that are
1849 reachable from either B or D but are reachable from neither A or C.
1850 In a linear history like this:</p></div>
1851 <div class="literalblock">
1852 <div class="content">
1853 <pre><code>---A---B---o---o---C---D</code></pre>
1854 </div></div>
1855 <div class="paragraph"><p>because A and B are reachable from C, the revision range specified
1856 by these two dotted ranges is a single commit D.</p></div>
1857 </div>
1858 <div class="sect2">
1859 <h3 id="_other_lt_rev_gt_94_parent_shorthand_notations">Other &lt;rev&gt;&#94; Parent Shorthand Notations</h3>
1860 <div class="paragraph"><p>Three other shorthands exist, particularly useful for merge commits,
1861 for naming a set that is formed by a commit and its parent commits.</p></div>
1862 <div class="paragraph"><p>The <em>r1&#94;@</em> notation means all parents of <em>r1</em>.</p></div>
1863 <div class="paragraph"><p>The <em>r1&#94;!</em> notation includes commit <em>r1</em> but excludes all of its parents.
1864 By itself, this notation denotes the single commit <em>r1</em>.</p></div>
1865 <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
1866 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
1867 not given. This is typically useful for merge commits where you
1868 can just pass <em>&lt;commit&gt;&#94;-</em> to get all the commits in the branch
1869 that was merged in merge commit <em>&lt;commit&gt;</em> (including <em>&lt;commit&gt;</em>
1870 itself).</p></div>
1871 <div class="paragraph"><p>While <em>&lt;rev&gt;&#94;&lt;n&gt;</em> was about specifying a single commit parent, these
1872 three notations also consider its parents. For example you can say
1873 <em>HEAD&#94;2&#94;@</em>, however you cannot say <em>HEAD&#94;@&#94;2</em>.</p></div>
1874 </div>
1875 </div>
1876 </div>
1877 <div class="sect1">
1878 <h2 id="_revision_range_summary">Revision Range Summary</h2>
1879 <div class="sectionbody">
1880 <div class="dlist"><dl>
1881 <dt class="hdlist1">
1882 <em>&lt;rev&gt;</em>
1883 </dt>
1884 <dd>
1885 <p>
1886         Include commits that are reachable from &lt;rev&gt; (i.e. &lt;rev&gt; and its
1887         ancestors).
1888 </p>
1889 </dd>
1890 <dt class="hdlist1">
1891 <em>&#94;&lt;rev&gt;</em>
1892 </dt>
1893 <dd>
1894 <p>
1895         Exclude commits that are reachable from &lt;rev&gt; (i.e. &lt;rev&gt; and its
1896         ancestors).
1897 </p>
1898 </dd>
1899 <dt class="hdlist1">
1900 <em>&lt;rev1&gt;..&lt;rev2&gt;</em>
1901 </dt>
1902 <dd>
1903 <p>
1904         Include commits that are reachable from &lt;rev2&gt; but exclude
1905         those that are reachable from &lt;rev1&gt;.  When either &lt;rev1&gt; or
1906         &lt;rev2&gt; is omitted, it defaults to <code>HEAD</code>.
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 either &lt;rev1&gt; or
1915         &lt;rev2&gt; but exclude those that are reachable from both.  When
1916         either &lt;rev1&gt; or &lt;rev2&gt; is omitted, it defaults to <code>HEAD</code>.
1917 </p>
1918 </dd>
1919 <dt class="hdlist1">
1920 <em>&lt;rev&gt;&#94;@</em>, e.g. <em>HEAD&#94;@</em>
1921 </dt>
1922 <dd>
1923 <p>
1924   A suffix <em>&#94;</em> followed by an at sign is the same as listing
1925   all parents of <em>&lt;rev&gt;</em> (meaning, include anything reachable from
1926   its parents, but not the commit itself).
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 exclamation mark is the same
1935   as giving commit <em>&lt;rev&gt;</em> and all its parents prefixed with
1936   <em>&#94;</em> to exclude them (and their ancestors).
1937 </p>
1938 </dd>
1939 <dt class="hdlist1">
1940 <em>&lt;rev&gt;&#94;-&lt;n&gt;</em>, e.g. <em>HEAD&#94;-, HEAD&#94;-2</em>
1941 </dt>
1942 <dd>
1943 <p>
1944         Equivalent to <em>&lt;rev&gt;&#94;&lt;n&gt;..&lt;rev&gt;</em>, with <em>&lt;n&gt;</em> = 1 if not
1945         given.
1946 </p>
1947 </dd>
1948 </dl></div>
1949 <div class="paragraph"><p>Here are a handful of examples using the Loeliger illustration above,
1950 with each step in the notation&#8217;s expansion and selection carefully
1951 spelt out:</p></div>
1952 <div class="literalblock">
1953 <div class="content">
1954 <pre><code>   Args   Expanded arguments    Selected commits
1955    D                            G H D
1956    D F                          G H I J D F
1957    ^G D                         H D
1958    ^D B                         E I J F B
1959    ^D B C                       E I J F B C
1960    C                            I J F C
1961    B..C   = ^B C                C
1962    B...C  = B ^F C              G H D E B C
1963    B^-    = B^..B
1964           = ^B^1 B              E I J F B
1965    C^@    = C^1
1966           = F                   I J F
1967    B^@    = B^1 B^2 B^3
1968           = D E F               D G H E F I J
1969    C^!    = C ^C^@
1970           = C ^C^1
1971           = C ^F                C
1972    B^!    = B ^B^@
1973           = B ^B^1 ^B^2 ^B^3
1974           = B ^D ^E ^F          B
1975    F^! D  = F ^I ^J D           G H D F</code></pre>
1976 </div></div>
1977 </div>
1978 </div>
1979 <div class="sect1">
1980 <h2 id="_parseopt">PARSEOPT</h2>
1981 <div class="sectionbody">
1982 <div class="paragraph"><p>In <code>--parseopt</code> mode, <em>git rev-parse</em> helps massaging options to bring to shell
1983 scripts the same facilities C builtins have. It works as an option normalizer
1984 (e.g. splits single switches aggregate values), a bit like <code>getopt(1)</code> does.</p></div>
1985 <div class="paragraph"><p>It takes on the standard input the specification of the options to parse and
1986 understand, and echoes on the standard output a string suitable for <code>sh(1)</code> <code>eval</code>
1987 to replace the arguments with normalized ones.  In case of error, it outputs
1988 usage on the standard error stream, and exits with code 129.</p></div>
1989 <div class="paragraph"><p>Note: Make sure you quote the result when passing it to <code>eval</code>.  See
1990 below for an example.</p></div>
1991 <div class="sect2">
1992 <h3 id="_input_format">Input Format</h3>
1993 <div class="paragraph"><p><em>git rev-parse --parseopt</em> input format is fully text based. It has two parts,
1994 separated by a line that contains only <code>--</code>. The lines before the separator
1995 (should be one or more) are used for the usage.
1996 The lines after the separator describe the options.</p></div>
1997 <div class="paragraph"><p>Each line of options has this format:</p></div>
1998 <div class="listingblock">
1999 <div class="content">
2000 <pre><code>&lt;opt-spec&gt;&lt;flags&gt;*&lt;arg-hint&gt;? SP+ help LF</code></pre>
2001 </div></div>
2002 <div class="dlist"><dl>
2003 <dt class="hdlist1">
2004 <code>&lt;opt-spec&gt;</code>
2005 </dt>
2006 <dd>
2007 <p>
2008         its format is the short option character, then the long option name
2009         separated by a comma. Both parts are not required, though at least one
2010         is necessary. May not contain any of the <code>&lt;flags&gt;</code> characters.
2011         <code>h,help</code>, <code>dry-run</code> and <code>f</code> are examples of correct <code>&lt;opt-spec&gt;</code>.
2012 </p>
2013 </dd>
2014 <dt class="hdlist1">
2015 <code>&lt;flags&gt;</code>
2016 </dt>
2017 <dd>
2018 <p>
2019         <code>&lt;flags&gt;</code> are of <code>*</code>, <code>=</code>, <code>?</code> or <code>!</code>.
2020 </p>
2021 <div class="ulist"><ul>
2022 <li>
2023 <p>
2024 Use <code>=</code> if the option takes an argument.
2025 </p>
2026 </li>
2027 <li>
2028 <p>
2029 Use <code>?</code> to mean that the option takes an optional argument. You
2030           probably want to use the <code>--stuck-long</code> mode to be able to
2031           unambiguously parse the optional argument.
2032 </p>
2033 </li>
2034 <li>
2035 <p>
2036 Use <code>*</code> to mean that this option should not be listed in the usage
2037           generated for the <code>-h</code> argument. It&#8217;s shown for <code>--help-all</code> as
2038           documented in <a href="gitcli.html">gitcli(7)</a>.
2039 </p>
2040 </li>
2041 <li>
2042 <p>
2043 Use <code>!</code> to not make the corresponding negated long option available.
2044 </p>
2045 </li>
2046 </ul></div>
2047 </dd>
2048 <dt class="hdlist1">
2049 <code>&lt;arg-hint&gt;</code>
2050 </dt>
2051 <dd>
2052 <p>
2053         <code>&lt;arg-hint&gt;</code>, if specified, is used as a name of the argument in the
2054         help output, for options that take arguments. <code>&lt;arg-hint&gt;</code> is
2055         terminated by the first whitespace.  It is customary to use a
2056         dash to separate words in a multi-word argument hint.
2057 </p>
2058 </dd>
2059 </dl></div>
2060 <div class="paragraph"><p>The remainder of the line, after stripping the spaces, is used
2061 as the help associated with the option.</p></div>
2062 <div class="paragraph"><p>Blank lines are ignored, and lines that don&#8217;t match this specification are used
2063 as option group headers (start the line with a space to create such
2064 lines on purpose).</p></div>
2065 </div>
2066 <div class="sect2">
2067 <h3 id="_example">Example</h3>
2068 <div class="listingblock">
2069 <div class="content">
2070 <pre><code>OPTS_SPEC="\
2071 some-command [&lt;options&gt;] &lt;args&gt;...
2072
2073 some-command does foo and bar!
2074 --
2075 h,help!   show the help
2076
2077 foo       some nifty option --foo
2078 bar=      some cool option --bar with an argument
2079 baz=arg   another cool option --baz with a named argument
2080 qux?path  qux may take a path argument but has meaning by itself
2081
2082   An option group Header
2083 C?        option C with an optional argument"
2084
2085 eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"</code></pre>
2086 </div></div>
2087 </div>
2088 <div class="sect2">
2089 <h3 id="_usage_text">Usage text</h3>
2090 <div class="paragraph"><p>When <code>"$@"</code> is <code>-h</code> or <code>--help</code> in the above example, the following
2091 usage text would be shown:</p></div>
2092 <div class="listingblock">
2093 <div class="content">
2094 <pre><code>usage: some-command [&lt;options&gt;] &lt;args&gt;...
2095
2096     some-command does foo and bar!
2097
2098     -h, --help            show the help
2099     --[no-]foo            some nifty option --foo
2100     --[no-]bar ...        some cool option --bar with an argument
2101     --[no-]baz &lt;arg&gt;      another cool option --baz with a named argument
2102     --[no-]qux[=&lt;path&gt;]   qux may take a path argument but has meaning by itself
2103
2104 An option group Header
2105     -C[...]               option C with an optional argument</code></pre>
2106 </div></div>
2107 </div>
2108 </div>
2109 </div>
2110 <div class="sect1">
2111 <h2 id="_sq_quote">SQ-QUOTE</h2>
2112 <div class="sectionbody">
2113 <div class="paragraph"><p>In <code>--sq-quote</code> mode, <em>git rev-parse</em> echoes on the standard output a
2114 single line suitable for <code>sh(1)</code> <code>eval</code>. This line is made by
2115 normalizing the arguments following <code>--sq-quote</code>. Nothing other than
2116 quoting the arguments is done.</p></div>
2117 <div class="paragraph"><p>If you want command input to still be interpreted as usual by
2118 <em>git rev-parse</em> before the output is shell quoted, see the <code>--sq</code>
2119 option.</p></div>
2120 <div class="sect2">
2121 <h3 id="_example_2">Example</h3>
2122 <div class="listingblock">
2123 <div class="content">
2124 <pre><code>$ cat &gt;your-git-script.sh &lt;&lt;\EOF
2125 #!/bin/sh
2126 args=$(git rev-parse --sq-quote "$@")   # quote user-supplied arguments
2127 command="git frotz -n24 $args"          # and use it inside a handcrafted
2128                                         # command line
2129 eval "$command"
2130 EOF
2131
2132 $ sh your-git-script.sh "a b'c"</code></pre>
2133 </div></div>
2134 </div>
2135 </div>
2136 </div>
2137 <div class="sect1">
2138 <h2 id="_examples">EXAMPLES</h2>
2139 <div class="sectionbody">
2140 <div class="ulist"><ul>
2141 <li>
2142 <p>
2143 Print the object name of the current commit:
2144 </p>
2145 <div class="listingblock">
2146 <div class="content">
2147 <pre><code>$ git rev-parse --verify HEAD</code></pre>
2148 </div></div>
2149 </li>
2150 <li>
2151 <p>
2152 Print the commit object name from the revision in the $REV shell variable:
2153 </p>
2154 <div class="listingblock">
2155 <div class="content">
2156 <pre><code>$ git rev-parse --verify --end-of-options $REV^{commit}</code></pre>
2157 </div></div>
2158 <div class="paragraph"><p>This will error out if $REV is empty or not a valid revision.</p></div>
2159 </li>
2160 <li>
2161 <p>
2162 Similar to above:
2163 </p>
2164 <div class="listingblock">
2165 <div class="content">
2166 <pre><code>$ git rev-parse --default master --verify --end-of-options $REV</code></pre>
2167 </div></div>
2168 <div class="paragraph"><p>but if $REV is empty, the commit object name from master will be printed.</p></div>
2169 </li>
2170 </ul></div>
2171 </div>
2172 </div>
2173 <div class="sect1">
2174 <h2 id="_git">GIT</h2>
2175 <div class="sectionbody">
2176 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
2177 </div>
2178 </div>
2179 </div>
2180 <div id="footnotes"><hr /></div>
2181 <div id="footer">
2182 <div id="footer-text">
2183 Last updated
2184  2024-03-28 14:36:08 PDT
2185 </div>
2186 </div>
2187 </body>
2188 </html>