summaryrefslogtreecommitdiffstats
path: root/git-rev-parse.html
blob: d50d9174fcf2d48bfa1603145f13e02f291a5af9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.2.0" />
<title>git-rev-parse(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */

/* Default font. */
body {
  font-family: Georgia,serif;
}

/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
  font-family: Arial,Helvetica,sans-serif;
}

body {
  margin: 1em 5% 1em 5%;
}

a {
  color: blue;
  text-decoration: underline;
}
a:visited {
  color: fuchsia;
}

em {
  font-style: italic;
  color: navy;
}

strong {
  font-weight: bold;
  color: #083194;
}

h1, h2, h3, h4, h5, h6 {
  color: #527bbd;
  margin-top: 1.2em;
  margin-bottom: 0.5em;
  line-height: 1.3;
}

h1, h2, h3 {
  border-bottom: 2px solid silver;
}
h2 {
  padding-top: 0.5em;
}
h3 {
  float: left;
}
h3 + * {
  clear: left;
}
h5 {
  font-size: 1.0em;
}

div.sectionbody {
  margin-left: 0;
}

hr {
  border: 1px solid silver;
}

p {
  margin-top: 0.5em;
  margin-bottom: 0.5em;
}

ul, ol, li > p {
  margin-top: 0;
}
ul > li     { color: #aaa; }
ul > li > * { color: black; }

.monospaced, code, pre {
  font-family: "Courier New", Courier, monospace;
  font-size: inherit;
  color: navy;
  padding: 0;
  margin: 0;
}
pre {
  white-space: pre-wrap;
}

#author {
  color: #527bbd;
  font-weight: bold;
  font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}

#footer {
  font-size: small;
  border-top: 2px solid silver;
  padding-top: 0.5em;
  margin-top: 4.0em;
}
#footer-text {
  float: left;
  padding-bottom: 0.5em;
}
#footer-badges {
  float: right;
  padding-bottom: 0.5em;
}

#preamble {
  margin-top: 1.5em;
  margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.admonitionblock {
  margin-top: 2.0em;
  margin-bottom: 2.0em;
  margin-right: 10%;
  color: #606060;
}

div.content { /* Block element content. */
  padding: 0;
}

/* Block element titles. */
div.title, caption.title {
  color: #527bbd;
  font-weight: bold;
  text-align: left;
  margin-top: 1.0em;
  margin-bottom: 0.5em;
}
div.title + * {
  margin-top: 0;
}

td div.title:first-child {
  margin-top: 0.0em;
}
div.content div.title:first-child {
  margin-top: 0.0em;
}
div.content + div.title {
  margin-top: 0.0em;
}

div.sidebarblock > div.content {
  background: #ffffee;
  border: 1px solid #dddddd;
  border-left: 4px solid #f0f0f0;
  padding: 0.5em;
}

div.listingblock > div.content {
  border: 1px solid #dddddd;
  border-left: 5px solid #f0f0f0;
  background: #f8f8f8;
  padding: 0.5em;
}

div.quoteblock, div.verseblock {
  padding-left: 1.0em;
  margin-left: 1.0em;
  margin-right: 10%;
  border-left: 5px solid #f0f0f0;
  color: #888;
}

div.quoteblock > div.attribution {
  padding-top: 0.5em;
  text-align: right;
}

div.verseblock > pre.content {
  font-family: inherit;
  font-size: inherit;
}
div.verseblock > div.attribution {
  padding-top: 0.75em;
  text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
  text-align: left;
}

div.admonitionblock .icon {
  vertical-align: top;
  font-size: 1.1em;
  font-weight: bold;
  text-decoration: underline;
  color: #527bbd;
  padding-right: 0.5em;
}
div.admonitionblock td.content {
  padding-left: 0.5em;
  border-left: 3px solid #dddddd;
}

div.exampleblock > div.content {
  border-left: 3px solid #dddddd;
  padding-left: 0.5em;
}

div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }

dl {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
dt {
  margin-top: 0.5em;
  margin-bottom: 0;
  font-style: normal;
  color: navy;
}
dd > *:first-child {
  margin-top: 0.1em;
}

ul, ol {
    list-style-position: outside;
}
ol.arabic {
  list-style-type: decimal;
}
ol.loweralpha {
  list-style-type: lower-alpha;
}
ol.upperalpha {
  list-style-type: upper-alpha;
}
ol.lowerroman {
  list-style-type: lower-roman;
}
ol.upperroman {
  list-style-type: upper-roman;
}

div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
  margin-top: 0.1em;
  margin-bottom: 0.1em;
}

tfoot {
  font-weight: bold;
}
td > div.verse {
  white-space: pre;
}

div.hdlist {
  margin-top: 0.8em;
  margin-bottom: 0.8em;
}
div.hdlist tr {
  padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
  font-weight: bold;
}
td.hdlist1 {
  vertical-align: top;
  font-style: normal;
  padding-right: 0.8em;
  color: navy;
}
td.hdlist2 {
  vertical-align: top;
}
div.hdlist.compact tr {
  margin: 0;
  padding-bottom: 0;
}

.comment {
  background: yellow;
}

.footnote, .footnoteref {
  font-size: 0.8em;
}

span.footnote, span.footnoteref {
  vertical-align: super;
}

#footnotes {
  margin: 20px 0 20px 0;
  padding: 7px 0 0 0;
}

#footnotes div.footnote {
  margin: 0 0 5px 0;
}

#footnotes hr {
  border: none;
  border-top: 1px solid silver;
  height: 1px;
  text-align: left;
  margin-left: 0;
  width: 20%;
  min-width: 100px;
}

div.colist td {
  padding-right: 0.5em;
  padding-bottom: 0.3em;
  vertical-align: top;
}
div.colist td img {
  margin-top: 0.3em;
}

@media print {
  #footer-badges { display: none; }
}

#toc {
  margin-bottom: 2.5em;
}

#toctitle {
  color: #527bbd;
  font-size: 1.1em;
  font-weight: bold;
  margin-top: 1.0em;
  margin-bottom: 0.1em;
}

div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
  margin-top: 0;
  margin-bottom: 0;
}
div.toclevel2 {
  margin-left: 2em;
  font-size: 0.9em;
}
div.toclevel3 {
  margin-left: 4em;
  font-size: 0.9em;
}
div.toclevel4 {
  margin-left: 6em;
  font-size: 0.9em;
}

span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }

span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }

span.big { font-size: 2em; }
span.small { font-size: 0.6em; }

span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }

div.unbreakable { page-break-inside: avoid; }


/*
 * xhtml11 specific
 *
 * */

div.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
div.tableblock > table {
  border: 3px solid #527bbd;
}
thead, p.table.header {
  font-weight: bold;
  color: #527bbd;
}
p.table {
  margin-top: 0;
}
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
  border-style: none;
}
div.tableblock > table[frame="hsides"] {
  border-left-style: none;
  border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
  border-top-style: none;
  border-bottom-style: none;
}


/*
 * html5 specific
 *
 * */

table.tableblock {
  margin-top: 1.0em;
  margin-bottom: 1.5em;
}
thead, p.tableblock.header {
  font-weight: bold;
  color: #527bbd;
}
p.tableblock {
  margin-top: 0;
}
table.tableblock {
  border-width: 3px;
  border-spacing: 0px;
  border-style: solid;
  border-color: #527bbd;
  border-collapse: collapse;
}
th.tableblock, td.tableblock {
  border-width: 1px;
  padding: 4px;
  border-style: solid;
  border-color: #527bbd;
}

table.tableblock.frame-topbot {
  border-left-style: hidden;
  border-right-style: hidden;
}
table.tableblock.frame-sides {
  border-top-style: hidden;
  border-bottom-style: hidden;
}
table.tableblock.frame-none {
  border-style: hidden;
}

th.tableblock.halign-left, td.tableblock.halign-left {
  text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
  text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
  text-align: right;
}

th.tableblock.valign-top, td.tableblock.valign-top {
  vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
  vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
  vertical-align: bottom;
}


/*
 * manpage specific
 *
 * */

body.manpage h1 {
  padding-top: 0.5em;
  padding-bottom: 0.5em;
  border-top: 2px solid silver;
  border-bottom: 2px solid silver;
}
body.manpage h2 {
  border-style: none;
}
body.manpage div.sectionbody {
  margin-left: 3em;
}

@media print {
  body.manpage div#toc { display: none; }
}


</style>
<script type="text/javascript">
/*<![CDATA[*/
var asciidoc = {  // Namespace.

/////////////////////////////////////////////////////////////////////
// Table Of Contents generator
/////////////////////////////////////////////////////////////////////

/* Author: Mihai Bazon, September 2002
 * http://students.infoiasi.ro/~mishoo
 *
 * Table Of Content generator
 * Version: 0.4
 *
 * Feel free to use this script under the terms of the GNU General Public
 * License, as long as you do not remove or alter this notice.
 */

 /* modified by Troy D. Hanson, September 2006. License: GPL */
 /* modified by Stuart Rackham, 2006, 2009. License: GPL */

// toclevels = 1..4.
toc: function (toclevels) {

  function getText(el) {
    var text = "";
    for (var i = el.firstChild; i != null; i = i.nextSibling) {
      if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
        text += i.data;
      else if (i.firstChild != null)
        text += getText(i);
    }
    return text;
  }

  function TocEntry(el, text, toclevel) {
    this.element = el;
    this.text = text;
    this.toclevel = toclevel;
  }

  function tocEntries(el, toclevels) {
    var result = new Array;
    var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
    // Function that scans the DOM tree for header elements (the DOM2
    // nodeIterator API would be a better technique but not supported by all
    // browsers).
    var iterate = function (el) {
      for (var i = el.firstChild; i != null; i = i.nextSibling) {
        if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
          var mo = re.exec(i.tagName);
          if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
            result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
          }
          iterate(i);
        }
      }
    }
    iterate(el);
    return result;
  }

  var toc = document.getElementById("toc");
  if (!toc) {
    return;
  }

  // Delete existing TOC entries in case we're reloading the TOC.
  var tocEntriesToRemove = [];
  var i;
  for (i = 0; i < toc.childNodes.length; i++) {
    var entry = toc.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div'
     && entry.getAttribute("class")
     && entry.getAttribute("class").match(/^toclevel/))
      tocEntriesToRemove.push(entry);
  }
  for (i = 0; i < tocEntriesToRemove.length; i++) {
    toc.removeChild(tocEntriesToRemove[i]);
  }

  // Rebuild TOC entries.
  var entries = tocEntries(document.getElementById("content"), toclevels);
  for (var i = 0; i < entries.length; ++i) {
    var entry = entries[i];
    if (entry.element.id == "")
      entry.element.id = "_toc_" + i;
    var a = document.createElement("a");
    a.href = "#" + entry.element.id;
    a.appendChild(document.createTextNode(entry.text));
    var div = document.createElement("div");
    div.appendChild(a);
    div.className = "toclevel" + entry.toclevel;
    toc.appendChild(div);
  }
  if (entries.length == 0)
    toc.parentNode.removeChild(toc);
},


/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////

/* Based on footnote generation code from:
 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 */

footnotes: function () {
  // Delete existing footnote entries in case we're reloading the footnodes.
  var i;
  var noteholder = document.getElementById("footnotes");
  if (!noteholder) {
    return;
  }
  var entriesToRemove = [];
  for (i = 0; i < noteholder.childNodes.length; i++) {
    var entry = noteholder.childNodes[i];
    if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
      entriesToRemove.push(entry);
  }
  for (i = 0; i < entriesToRemove.length; i++) {
    noteholder.removeChild(entriesToRemove[i]);
  }

  // Rebuild footnote entries.
  var cont = document.getElementById("content");
  var spans = cont.getElementsByTagName("span");
  var refs = {};
  var n = 0;
  for (i=0; i<spans.length; i++) {
    if (spans[i].className == "footnote") {
      n++;
      var note = spans[i].getAttribute("data-note");
      if (!note) {
        // Use [\s\S] in place of . so multi-line matches work.
        // Because JavaScript has no s (dotall) regex flag.
        note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
        spans[i].innerHTML =
          "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
        spans[i].setAttribute("data-note", note);
      }
      noteholder.innerHTML +=
        "<div class='footnote' id='_footnote_" + n + "'>" +
        "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
        n + "</a>. " + note + "</div>";
      var id =spans[i].getAttribute("id");
      if (id != null) refs["#"+id] = n;
    }
  }
  if (n == 0)
    noteholder.parentNode.removeChild(noteholder);
  else {
    // Process footnoterefs.
    for (i=0; i<spans.length; i++) {
      if (spans[i].className == "footnoteref") {
        var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
        href = href.match(/#.*/)[0];  // Because IE return full URL.
        n = refs[href];
        spans[i].innerHTML =
          "[<a href='#_footnote_" + n +
          "' title='View footnote' class='footnote'>" + n + "</a>]";
      }
    }
  }
},

install: function(toclevels) {
  var timerId;

  function reinstall() {
    asciidoc.footnotes();
    if (toclevels) {
      asciidoc.toc(toclevels);
    }
  }

  function reinstallAndRemoveTimer() {
    clearInterval(timerId);
    reinstall();
  }

  timerId = setInterval(reinstall, 500);
  if (document.addEventListener)
    document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
  else
    window.onload = reinstallAndRemoveTimer;
}

}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="manpage">
<div id="header">
<h1>
git-rev-parse(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-rev-parse -
   Pick out and massage parameters
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content"><em>git rev-parse</em> [&lt;options&gt;] &lt;arg&gt;&#8230;</pre>
<div class="attribution">
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Many Git porcelainish commands take a mixture of flags
(i.e. parameters that begin with a dash <em>-</em>) and parameters
meant for the underlying <em>git rev-list</em> command they use internally
and flags and parameters for the other commands they use
downstream of <em>git rev-list</em>.  This command is used to
distinguish between them.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_operation_modes">Operation Modes</h3>
<div class="paragraph"><p>Each of these options must appear first on the command line.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
--parseopt
</dt>
<dd>
<p>
        Use <em>git rev-parse</em> in option parsing mode (see PARSEOPT section below).
</p>
</dd>
<dt class="hdlist1">
--sq-quote
</dt>
<dd>
<p>
        Use <em>git rev-parse</em> in shell quoting mode (see SQ-QUOTE
        section below). In contrast to the <code>--sq</code> option below, this
        mode only does quoting. Nothing else is done to command input.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_options_for_parseopt">Options for --parseopt</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--keep-dashdash
</dt>
<dd>
<p>
        Only meaningful in <code>--parseopt</code> mode. Tells the option parser to echo
        out the first <code>--</code> met instead of skipping it.
</p>
</dd>
<dt class="hdlist1">
--stop-at-non-option
</dt>
<dd>
<p>
        Only meaningful in <code>--parseopt</code> mode.  Lets the option parser stop at
        the first non-option argument.  This can be used to parse sub-commands
        that take options themselves.
</p>
</dd>
<dt class="hdlist1">
--stuck-long
</dt>
<dd>
<p>
        Only meaningful in <code>--parseopt</code> mode. Output the options in their
        long form if available, and with their arguments stuck.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_options_for_filtering">Options for Filtering</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--revs-only
</dt>
<dd>
<p>
        Do not output flags and parameters not meant for
        <em>git rev-list</em> command.
</p>
</dd>
<dt class="hdlist1">
--no-revs
</dt>
<dd>
<p>
        Do not output flags and parameters meant for
        <em>git rev-list</em> command.
</p>
</dd>
<dt class="hdlist1">
--flags
</dt>
<dd>
<p>
        Do not output non-flag parameters.
</p>
</dd>
<dt class="hdlist1">
--no-flags
</dt>
<dd>
<p>
        Do not output flag parameters.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_options_for_output">Options for Output</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--default &lt;arg&gt;
</dt>
<dd>
<p>
        If there is no parameter given by the user, use <code>&lt;arg&gt;</code>
        instead.
</p>
</dd>
<dt class="hdlist1">
--prefix &lt;arg&gt;
</dt>
<dd>
<p>
        Behave as if <em>git rev-parse</em> was invoked from the <code>&lt;arg&gt;</code>
        subdirectory of the working tree.  Any relative filenames are
        resolved as if they are prefixed by <code>&lt;arg&gt;</code> and will be printed
        in that form.
</p>
<div class="paragraph"><p>This can be used to convert arguments to a command run in a subdirectory
so that they can still be used after moving to the top-level of the
repository.  For example:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>prefix=$(git rev-parse --show-prefix)
cd "$(git rev-parse --show-toplevel)"
# rev-parse provides the -- needed for 'set'
eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
--verify
</dt>
<dd>
<p>
        Verify that exactly one parameter is provided, and that it
        can be turned into a raw 20-byte SHA-1 that can be used to
        access the object database. If so, emit it to the standard
        output; otherwise, error out.
</p>
<div class="paragraph"><p>If you want to make sure that the output actually names an object in
your object database and/or can be used as a specific type of object
you require, you can add the <code>^{type}</code> peeling operator to the parameter.
For example, <code>git rev-parse "$VAR^{commit}"</code> will make sure <code>$VAR</code>
names an existing object that is a commit-ish (i.e. a commit, or an
annotated tag that points at a commit).  To make sure that <code>$VAR</code>
names an existing object of any type, <code>git rev-parse "$VAR^{object}"</code>
can be used.</p></div>
<div class="paragraph"><p>Note that if you are verifying a name from an untrusted source, it is
wise to use <code>--end-of-options</code> so that the name argument is not mistaken
for another option.</p></div>
</dd>
<dt class="hdlist1">
-q
</dt>
<dt class="hdlist1">
--quiet
</dt>
<dd>
<p>
        Only meaningful in <code>--verify</code> mode. Do not output an error
        message if the first argument is not a valid object name;
        instead exit with non-zero status silently.
        SHA-1s for valid object names are printed to stdout on success.
</p>
</dd>
<dt class="hdlist1">
--sq
</dt>
<dd>
<p>
        Usually the output is made one line per flag and
        parameter.  This option makes output a single line,
        properly quoted for consumption by shell.  Useful when
        you expect your parameter to contain whitespaces and
        newlines (e.g. when using pickaxe <code>-S</code> with
        <em>git diff-&#42;</em>). In contrast to the <code>--sq-quote</code> option,
        the command input is still interpreted as usual.
</p>
</dd>
<dt class="hdlist1">
--short[=&lt;length&gt;]
</dt>
<dd>
<p>
        Same as <code>--verify</code> but shortens the object name to a unique
        prefix with at least <code>length</code> characters. The minimum length
        is 4, the default is the effective value of the <code>core.abbrev</code>
        configuration variable (see <a href="git-config.html">git-config(1)</a>).
</p>
</dd>
<dt class="hdlist1">
--not
</dt>
<dd>
<p>
        When showing object names, prefix them with <em>&#94;</em> and
        strip <em>&#94;</em> prefix from the object names that already have
        one.
</p>
</dd>
<dt class="hdlist1">
--abbrev-ref[=(strict|loose)]
</dt>
<dd>
<p>
        A non-ambiguous short name of the objects name.
        The option core.warnAmbiguousRefs is used to select the strict
        abbreviation mode.
</p>
</dd>
<dt class="hdlist1">
--symbolic
</dt>
<dd>
<p>
        Usually the object names are output in SHA-1 form (with
        possible <em>&#94;</em> prefix); this option makes them output in a
        form as close to the original input as possible.
</p>
</dd>
<dt class="hdlist1">
--symbolic-full-name
</dt>
<dd>
<p>
        This is similar to --symbolic, but it omits input that
        are not refs (i.e. branch or tag names; or more
        explicitly disambiguating "heads/master" form, when you
        want to name the "master" branch when there is an
        unfortunately named tag "master"), and shows them as full
        refnames (e.g. "refs/heads/master").
</p>
</dd>
<dt class="hdlist1">
--output-object-format=(sha1|sha256|storage)
</dt>
<dd>
<p>
        Allow oids to be input from any object format that the current
        repository supports.
</p>
<div class="literalblock">
<div class="content">
<pre><code>Specifying "sha1" translates if necessary and returns a sha1 oid.</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>Specifying "sha256" translates if necessary and returns a sha256 oid.</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>Specifying "storage" translates if necessary and returns an oid in
encoded in the storage hash algorithm.</code></pre>
</div></div>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_options_for_objects">Options for Objects</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--all
</dt>
<dd>
<p>
        Show all refs found in <code>refs/</code>.
</p>
</dd>
<dt class="hdlist1">
--branches[=&lt;pattern&gt;]
</dt>
<dt class="hdlist1">
--tags[=&lt;pattern&gt;]
</dt>
<dt class="hdlist1">
--remotes[=&lt;pattern&gt;]
</dt>
<dd>
<p>
        Show all branches, tags, or remote-tracking branches,
        respectively (i.e., refs found in <code>refs/heads</code>,
        <code>refs/tags</code>, or <code>refs/remotes</code>, respectively).
</p>
<div class="paragraph"><p>If a <code>pattern</code> is given, only refs matching the given shell glob are
shown.  If the pattern does not contain a globbing character (<code>?</code>,
<code>*</code>, or <code>[</code>), it is turned into a prefix match by appending <code>/*</code>.</p></div>
</dd>
<dt class="hdlist1">
--glob=&lt;pattern&gt;
</dt>
<dd>
<p>
        Show all refs matching the shell glob pattern <code>pattern</code>. If
        the pattern does not start with <code>refs/</code>, this is automatically
        prepended.  If the pattern does not contain a globbing
        character (<code>?</code>, <code>*</code>, or <code>[</code>), it is turned into a prefix
        match by appending <code>/*</code>.
</p>
</dd>
<dt class="hdlist1">
--exclude=&lt;glob-pattern&gt;
</dt>
<dd>
<p>
        Do not include refs matching <em>&lt;glob-pattern&gt;</em> that the next <code>--all</code>,
        <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or <code>--glob</code> would otherwise
        consider. Repetitions of this option accumulate exclusion patterns
        up to the next <code>--all</code>, <code>--branches</code>, <code>--tags</code>, <code>--remotes</code>, or
        <code>--glob</code> option (other options or arguments do not clear
        accumulated patterns).
</p>
<div class="paragraph"><p>The patterns given should not begin with <code>refs/heads</code>, <code>refs/tags</code>, or
<code>refs/remotes</code> when applied to <code>--branches</code>, <code>--tags</code>, or <code>--remotes</code>,
respectively, and they must begin with <code>refs/</code> when applied to <code>--glob</code>
or <code>--all</code>. If a trailing <em>/&#42;</em> is intended, it must be given
explicitly.</p></div>
</dd>
<dt class="hdlist1">
--exclude-hidden=(fetch|receive|uploadpack)
</dt>
<dd>
<p>
        Do not include refs that would be hidden by <code>git-fetch</code>,
        <code>git-receive-pack</code> or <code>git-upload-pack</code> by consulting the appropriate
        <code>fetch.hideRefs</code>, <code>receive.hideRefs</code> or <code>uploadpack.hideRefs</code>
        configuration along with <code>transfer.hideRefs</code> (see
        <a href="git-config.html">git-config(1)</a>). This option affects the next pseudo-ref option
        <code>--all</code> or <code>--glob</code> and is cleared after processing them.
</p>
</dd>
<dt class="hdlist1">
--disambiguate=&lt;prefix&gt;
</dt>
<dd>
<p>
        Show every object whose name begins with the given prefix.
        The &lt;prefix&gt; must be at least 4 hexadecimal digits long to
        avoid listing each and every object in the repository by
        mistake.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_options_for_files">Options for Files</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--local-env-vars
</dt>
<dd>
<p>
        List the GIT_* environment variables that are local to the
        repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
        Only the names of the variables are listed, not their value,
        even if they are set.
</p>
</dd>
<dt class="hdlist1">
--path-format=(absolute|relative)
</dt>
<dd>
<p>
        Controls the behavior of certain other options. If specified as absolute, the
        paths printed by those options will be absolute and canonical. If specified as
        relative, the paths will be relative to the current working directory if that
        is possible.  The default is option specific.
</p>
<div class="paragraph"><p>This option may be specified multiple times and affects only the arguments that
follow it on the command line, either to the end of the command line or the next
instance of this option.</p></div>
</dd>
</dl></div>
<div class="paragraph"><p>The following options are modified by <code>--path-format</code>:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
--git-dir
</dt>
<dd>
<p>
        Show <code>$GIT_DIR</code> if defined. Otherwise show the path to
        the .git directory. The path shown, when relative, is
        relative to the current working directory.
</p>
<div class="paragraph"><p>If <code>$GIT_DIR</code> is not defined and the current directory
is not detected to lie in a Git repository or work tree
print a message to stderr and exit with nonzero status.</p></div>
</dd>
<dt class="hdlist1">
--git-common-dir
</dt>
<dd>
<p>
        Show <code>$GIT_COMMON_DIR</code> if defined, else <code>$GIT_DIR</code>.
</p>
</dd>
<dt class="hdlist1">
--resolve-git-dir &lt;path&gt;
</dt>
<dd>
<p>
        Check if &lt;path&gt; is a valid repository or a gitfile that
        points at a valid repository, and print the location of the
        repository.  If &lt;path&gt; is a gitfile then the resolved path
        to the real repository is printed.
</p>
</dd>
<dt class="hdlist1">
--git-path &lt;path&gt;
</dt>
<dd>
<p>
        Resolve "$GIT_DIR/&lt;path&gt;" and takes other path relocation
        variables such as $GIT_OBJECT_DIRECTORY,
        $GIT_INDEX_FILE&#8230; into account. For example, if
        $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse
        --git-path objects/abc" returns /foo/bar/abc.
</p>
</dd>
<dt class="hdlist1">
--show-toplevel
</dt>
<dd>
<p>
        Show the (by default, absolute) path of the top-level directory
        of the working tree. If there is no working tree, report an error.
</p>
</dd>
<dt class="hdlist1">
--show-superproject-working-tree
</dt>
<dd>
<p>
        Show the absolute path of the root of the superproject&#8217;s
        working tree (if exists) that uses the current repository as
        its submodule.  Outputs nothing if the current repository is
        not used as a submodule by any project.
</p>
</dd>
<dt class="hdlist1">
--shared-index-path
</dt>
<dd>
<p>
        Show the path to the shared index file in split index mode, or
        empty if not in split-index mode.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>The following options are unaffected by <code>--path-format</code>:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
--absolute-git-dir
</dt>
<dd>
<p>
        Like <code>--git-dir</code>, but its output is always the canonicalized
        absolute path.
</p>
</dd>
<dt class="hdlist1">
--is-inside-git-dir
</dt>
<dd>
<p>
        When the current working directory is below the repository
        directory print "true", otherwise "false".
</p>
</dd>
<dt class="hdlist1">
--is-inside-work-tree
</dt>
<dd>
<p>
        When the current working directory is inside the work tree of the
        repository print "true", otherwise "false".
</p>
</dd>
<dt class="hdlist1">
--is-bare-repository
</dt>
<dd>
<p>
        When the repository is bare print "true", otherwise "false".
</p>
</dd>
<dt class="hdlist1">
--is-shallow-repository
</dt>
<dd>
<p>
        When the repository is shallow print "true", otherwise "false".
</p>
</dd>
<dt class="hdlist1">
--show-cdup
</dt>
<dd>
<p>
        When the command is invoked from a subdirectory, show the
        path of the top-level directory relative to the current
        directory (typically a sequence of "../", or an empty string).
</p>
</dd>
<dt class="hdlist1">
--show-prefix
</dt>
<dd>
<p>
        When the command is invoked from a subdirectory, show the
        path of the current directory relative to the top-level
        directory.
</p>
</dd>
<dt class="hdlist1">
--show-object-format[=(storage|input|output)]
</dt>
<dd>
<p>
        Show the object format (hash algorithm) used for the repository
        for storage inside the <code>.git</code> directory, input, or output. For
        input, multiple algorithms may be printed, space-separated.
        If not specified, the default is "storage".
</p>
</dd>
<dt class="hdlist1">
--show-ref-format
</dt>
<dd>
<p>
        Show the reference storage format used for the repository.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_other_options">Other Options</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--since=&lt;datestring&gt;
</dt>
<dt class="hdlist1">
--after=&lt;datestring&gt;
</dt>
<dd>
<p>
        Parse the date string, and output the corresponding
        --max-age= parameter for <em>git rev-list</em>.
</p>
</dd>
<dt class="hdlist1">
--until=&lt;datestring&gt;
</dt>
<dt class="hdlist1">
--before=&lt;datestring&gt;
</dt>
<dd>
<p>
        Parse the date string, and output the corresponding
        --min-age= parameter for <em>git rev-list</em>.
</p>
</dd>
<dt class="hdlist1">
&lt;arg&gt;&#8230;
</dt>
<dd>
<p>
        Flags and parameters to be parsed.
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_specifying_revisions">SPECIFYING REVISIONS</h2>
<div class="sectionbody">
<div class="paragraph"><p>A revision parameter <em>&lt;rev&gt;</em> typically, but not necessarily, names a
commit object.  It uses what is called an <em>extended SHA-1</em>
syntax.  Here are various ways to spell object names.  The
ones listed near the end of this list name trees and
blobs contained in a commit.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">This document shows the "raw" syntax as seen by git. The shell
and other UIs might require additional quoting to protect special
characters and to avoid word splitting.</td>
</tr></table>
</div>
<div class="dlist"><dl>
<dt class="hdlist1">
<em>&lt;sha1&gt;</em>, e.g. <em>dae86e1950b1277e545cee180551750029cfe735</em>, <em>dae86e</em>
</dt>
<dd>
<p>
  The full SHA-1 object name (40-byte hexadecimal string), or
  a leading substring that is unique within the repository.
  E.g. dae86e1950b1277e545cee180551750029cfe735 and dae86e both
  name the same commit object if there is no other object in
  your repository whose object name starts with dae86e.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;describeOutput&gt;</em>, e.g. <em>v1.7.4.2-679-g3bee7fb</em>
</dt>
<dd>
<p>
  Output from <code>git describe</code>; i.e. a closest tag, optionally
  followed by a dash and a number of commits, followed by a dash, a
  <em>g</em>, and an abbreviated object name.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;refname&gt;</em>, e.g. <em>master</em>, <em>heads/master</em>, <em>refs/heads/master</em>
</dt>
<dd>
<p>
  A symbolic ref name.  E.g. <em>master</em> typically means the commit
  object referenced by <em>refs/heads/master</em>.  If you
  happen to have both <em>heads/master</em> and <em>tags/master</em>, you can
  explicitly say <em>heads/master</em> to tell Git which one you mean.
  When ambiguous, a <em>&lt;refname&gt;</em> is disambiguated by taking the
  first match in the following rules:
</p>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
If <em>$GIT_DIR/&lt;refname&gt;</em> exists, that is what you mean (this is usually
    useful only for <code>HEAD</code>, <code>FETCH_HEAD</code>, <code>ORIG_HEAD</code>, <code>MERGE_HEAD</code>,
    <code>REBASE_HEAD</code>, <code>REVERT_HEAD</code>, <code>CHERRY_PICK_HEAD</code>, <code>BISECT_HEAD</code>
    and <code>AUTO_MERGE</code>);
</p>
</li>
<li>
<p>
otherwise, <em>refs/&lt;refname&gt;</em> if it exists;
</p>
</li>
<li>
<p>
otherwise, <em>refs/tags/&lt;refname&gt;</em> if it exists;
</p>
</li>
<li>
<p>
otherwise, <em>refs/heads/&lt;refname&gt;</em> if it exists;
</p>
</li>
<li>
<p>
otherwise, <em>refs/remotes/&lt;refname&gt;</em> if it exists;
</p>
</li>
<li>
<p>
otherwise, <em>refs/remotes/&lt;refname&gt;/HEAD</em> if it exists.
</p>
</li>
</ol></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>HEAD</code>
</dt>
<dd>
<p>
    names the commit on which you based the changes in the working tree.
</p>
</dd>
<dt class="hdlist1">
<code>FETCH_HEAD</code>
</dt>
<dd>
<p>
    records the branch which you fetched from a remote repository with
    your last <code>git fetch</code> invocation.
</p>
</dd>
<dt class="hdlist1">
<code>ORIG_HEAD</code>
</dt>
<dd>
<p>
    is created by commands that move your <code>HEAD</code> in a drastic way (<code>git
    am</code>, <code>git merge</code>, <code>git rebase</code>, <code>git reset</code>), to record the position
    of the <code>HEAD</code> before their operation, so that you can easily change
    the tip of the branch back to the state before you ran them.
</p>
</dd>
<dt class="hdlist1">
<code>MERGE_HEAD</code>
</dt>
<dd>
<p>
    records the commit(s) which you are merging into your branch when you
    run <code>git merge</code>.
</p>
</dd>
<dt class="hdlist1">
<code>REBASE_HEAD</code>
</dt>
<dd>
<p>
    during a rebase, records the commit at which the operation is
    currently stopped, either because of conflicts or an <code>edit</code> command in
    an interactive rebase.
</p>
</dd>
<dt class="hdlist1">
<code>REVERT_HEAD</code>
</dt>
<dd>
<p>
    records the commit which you are reverting when you run <code>git revert</code>.
</p>
</dd>
<dt class="hdlist1">
<code>CHERRY_PICK_HEAD</code>
</dt>
<dd>
<p>
    records the commit which you are cherry-picking when you run <code>git
    cherry-pick</code>.
</p>
</dd>
<dt class="hdlist1">
<code>BISECT_HEAD</code>
</dt>
<dd>
<p>
    records the current commit to be tested when you run <code>git bisect
    --no-checkout</code>.
</p>
</dd>
<dt class="hdlist1">
<code>AUTO_MERGE</code>
</dt>
<dd>
<p>
    records a tree object corresponding to the state the
    <em>ort</em> merge strategy wrote to the working tree when a merge operation
    resulted in conflicts.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Note that any of the <em>refs/*</em> cases above may come either from
the <code>$GIT_DIR/refs</code> directory or from the <code>$GIT_DIR/packed-refs</code> file.
While the ref name encoding is unspecified, UTF-8 is preferred as
some output processing may assume ref names in UTF-8.</p></div>
</dd>
<dt class="hdlist1">
<em>@</em>
</dt>
<dd>
<p>
  <em>@</em> alone is a shortcut for <code>HEAD</code>.
</p>
</dd>
<dt class="hdlist1">
<em>[&lt;refname&gt;]@{&lt;date&gt;}</em>, e.g. <em>master@{yesterday}</em>, <em>HEAD@{5 minutes ago}</em>
</dt>
<dd>
<p>
  A ref followed by the suffix <em>@</em> with a date specification
  enclosed in a brace
  pair (e.g. <em>{yesterday}</em>, <em>{1 month 2 weeks 3 days 1 hour 1
  second ago}</em> or <em>{1979-02-26 18:30:00}</em>) specifies the value
  of the ref at a prior point in time.  This suffix may only be
  used immediately following a ref name and the ref must have an
  existing log (<em>$GIT_DIR/logs/&lt;ref&gt;</em>). Note that this looks up the state
  of your <strong>local</strong> ref at a given time; e.g., what was in your local
  <em>master</em> branch last week. If you want to look at commits made during
  certain times, see <code>--since</code> and <code>--until</code>.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;refname&gt;@{&lt;n&gt;}</em>, e.g. <em>master@{1}</em>
</dt>
<dd>
<p>
  A ref followed by the suffix <em>@</em> with an ordinal specification
  enclosed in a brace pair (e.g. <em>{1}</em>, <em>{15}</em>) specifies
  the n-th prior value of that ref.  For example <em>master@{1}</em>
  is the immediate prior value of <em>master</em> while <em>master@{5}</em>
  is the 5th prior value of <em>master</em>. This suffix may only be used
  immediately following a ref name and the ref must have an existing
  log (<em>$GIT_DIR/logs/&lt;refname&gt;</em>).
</p>
</dd>
<dt class="hdlist1">
<em>@{&lt;n&gt;}</em>, e.g. <em>@{1}</em>
</dt>
<dd>
<p>
  You can use the <em>@</em> construct with an empty ref part to get at a
  reflog entry of the current branch. For example, if you are on
  branch <em>blabla</em> then <em>@{1}</em> means the same as <em>blabla@{1}</em>.
</p>
</dd>
<dt class="hdlist1">
<em>@{-&lt;n&gt;}</em>, e.g. <em>@{-1}</em>
</dt>
<dd>
<p>
  The construct <em>@{-&lt;n&gt;}</em> means the &lt;n&gt;th branch/commit checked out
  before the current one.
</p>
</dd>
<dt class="hdlist1">
<em>[&lt;branchname&gt;]@{upstream}</em>, e.g. <em>master@{upstream}</em>, <em>@{u}</em>
</dt>
<dd>
<p>
  A branch B may be set up to build on top of a branch X (configured with
  <code>branch.&lt;name&gt;.merge</code>) at a remote R (configured with
  the branch X taken from remote R, typically found at <code>refs/remotes/R/X</code>.
</p>
</dd>
<dt class="hdlist1">
<em>[&lt;branchname&gt;]@{push}</em>, e.g. <em>master@{push}</em>, <em>@{push}</em>
</dt>
<dd>
<p>
  The suffix <em>@{push}</em> reports the branch "where we would push to" if
  <code>git push</code> were run while <code>branchname</code> was checked out (or the current
  <code>HEAD</code> if no branchname is specified). Like for <em>@{upstream}</em>, we report
  the remote-tracking branch that corresponds to that branch at the remote.
</p>
<div class="paragraph"><p>Here&#8217;s an example to make it more clear:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ git config push.default current
$ git config remote.pushdefault myfork
$ git switch -c mybranch origin/master

$ git rev-parse --symbolic-full-name @{upstream}
refs/remotes/origin/master

$ git rev-parse --symbolic-full-name @{push}
refs/remotes/myfork/mybranch</code></pre>
</div></div>
<div class="paragraph"><p>Note in the example that we set up a triangular workflow, where we pull
from one location and push to another. In a non-triangular workflow,
<em>@{push}</em> is the same as <em>@{upstream}</em>, and there is no need for it.</p></div>
<div class="paragraph"><p>This suffix is also accepted when spelled in uppercase, and means the same
thing no matter the case.</p></div>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;&#94;[&lt;n&gt;]</em>, e.g. <em>HEAD&#94;, v1.5.1&#94;0</em>
</dt>
<dd>
<p>
  A suffix <em>&#94;</em> to a revision parameter means the first parent of
  that commit object.  <em>&#94;&lt;n&gt;</em> means the &lt;n&gt;th parent (i.e.
  <em>&lt;rev&gt;&#94;</em>
  is equivalent to <em>&lt;rev&gt;&#94;1</em>).  As a special rule,
  <em>&lt;rev&gt;&#94;0</em> means the commit itself and is used when <em>&lt;rev&gt;</em> is the
  object name of a tag object that refers to a commit object.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;&#126;[&lt;n&gt;]</em>, e.g. <em>HEAD&#126;, master&#126;3</em>
</dt>
<dd>
<p>
  A suffix <em>&#126;</em> to a revision parameter means the first parent of
  that commit object.
  A suffix <em>&#126;&lt;n&gt;</em> to a revision parameter means the commit
  object that is the &lt;n&gt;th generation ancestor of the named
  commit object, following only the first parents.  I.e. <em>&lt;rev&gt;&#126;3</em> is
  equivalent to <em>&lt;rev&gt;&#94;&#94;&#94;</em> which is equivalent to
  <em>&lt;rev&gt;&#94;1&#94;1&#94;1</em>.  See below for an illustration of
  the usage of this form.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;&#94;{&lt;type&gt;}</em>, e.g. <em>v0.99.8&#94;{commit}</em>
</dt>
<dd>
<p>
  A suffix <em>&#94;</em> followed by an object type name enclosed in
  brace pair means dereference the object at <em>&lt;rev&gt;</em> recursively until
  an object of type <em>&lt;type&gt;</em> is found or the object cannot be
  dereferenced anymore (in which case, barf).
  For example, if <em>&lt;rev&gt;</em> is a commit-ish, <em>&lt;rev&gt;&#94;{commit}</em>
  describes the corresponding commit object.
  Similarly, if <em>&lt;rev&gt;</em> is a tree-ish, <em>&lt;rev&gt;&#94;{tree}</em>
  describes the corresponding tree object.
  <em>&lt;rev&gt;&#94;0</em>
  is a short-hand for <em>&lt;rev&gt;&#94;{commit}</em>.
</p>
<div class="paragraph"><p><em>&lt;rev&gt;&#94;{object}</em> can be used to make sure <em>&lt;rev&gt;</em> names an
object that exists, without requiring <em>&lt;rev&gt;</em> to be a tag, and
without dereferencing <em>&lt;rev&gt;</em>; because a tag is already an object,
it does not have to be dereferenced even once to get to an object.</p></div>
<div class="paragraph"><p><em>&lt;rev&gt;&#94;{tag}</em> can be used to ensure that <em>&lt;rev&gt;</em> identifies an
existing tag object.</p></div>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;&#94;{}</em>, e.g. <em>v0.99.8&#94;{}</em>
</dt>
<dd>
<p>
  A suffix <em>&#94;</em> followed by an empty brace pair
  means the object could be a tag,
  and dereference the tag recursively until a non-tag object is
  found.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;&#94;{/&lt;text&gt;}</em>, e.g. <em>HEAD^{/fix nasty bug}</em>
</dt>
<dd>
<p>
  A suffix <em>&#94;</em> to a revision parameter, followed by a brace
  pair that contains a text led by a slash,
  is the same as the <em>:/fix nasty bug</em> syntax below except that
  it returns the youngest matching commit which is reachable from
  the <em>&lt;rev&gt;</em> before <em>&#94;</em>.
</p>
</dd>
<dt class="hdlist1">
<em>:/&lt;text&gt;</em>, e.g. <em>:/fix nasty bug</em>
</dt>
<dd>
<p>
  A colon, followed by a slash, followed by a text, names
  a commit whose commit message matches the specified regular expression.
  This name returns the youngest matching commit which is
  reachable from any ref, including HEAD.
  The regular expression can match any part of the
  commit message. To match messages starting with a string, one can use
  e.g. <em>:/^foo</em>. The special sequence <em>:/!</em> is reserved for modifiers to what
  is matched. <em>:/!-foo</em> performs a negative match, while <em>:/!!foo</em> matches a
  literal <em>!</em> character, followed by <em>foo</em>. Any other sequence beginning with
  <em>:/!</em> is reserved for now.
  Depending on the given text, the shell&#8217;s word splitting rules might
  require additional quoting.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;:&lt;path&gt;</em>, e.g. <em>HEAD:README</em>, <em>master:./README</em>
</dt>
<dd>
<p>
  A suffix <em>:</em> followed by a path names the blob or tree
  at the given path in the tree-ish object named by the part
  before the colon.
  A path starting with <em>./</em> or <em>../</em> is relative to the current working directory.
  The given path will be converted to be relative to the working tree&#8217;s root directory.
  This is most useful to address a blob or tree from a commit or tree that has
  the same tree structure as the working tree.
</p>
</dd>
<dt class="hdlist1">
<em>:[&lt;n&gt;:]&lt;path&gt;</em>, e.g. <em>:0:README</em>, <em>:README</em>
</dt>
<dd>
<p>
  A colon, optionally followed by a stage number (0 to 3) and a
  colon, followed by a path, names a blob object in the
  index at the given path. A missing stage number (and the colon
  that follows it) names a stage 0 entry. During a merge, stage
  1 is the common ancestor, stage 2 is the target branch&#8217;s version
  (typically the current branch), and stage 3 is the version from
  the branch which is being merged.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Here is an illustration, by Jon Loeliger.  Both commit nodes B
and C are parents of commit node A.  Parent commits are ordered
left-to-right.</p></div>
<div class="literalblock">
<div class="content">
<pre><code>G   H   I   J
 \ /     \ /
  D   E   F
   \  |  / \
    \ | /   |
     \|/    |
      B     C
       \   /
        \ /
         A</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>A =      = A^0
B = A^   = A^1     = A~1
C =      = A^2
D = A^^  = A^1^1   = A~2
E = B^2  = A^^2
F = B^3  = A^^3
G = A^^^ = A^1^1^1 = A~3
H = D^2  = B^^2    = A^^^2  = A~2^2
I = F^   = B^3^    = A^^3^
J = F^2  = B^3^2   = A^^3^2</code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_specifying_ranges">SPECIFYING RANGES</h2>
<div class="sectionbody">
<div class="paragraph"><p>History traversing commands such as <code>git log</code> operate on a set
of commits, not just a single commit.</p></div>
<div class="paragraph"><p>For these commands,
specifying a single revision, using the notation described in the
previous section, means the set of commits <code>reachable</code> from the given
commit.</p></div>
<div class="paragraph"><p>Specifying several revisions means the set of commits reachable from
any of the given commits.</p></div>
<div class="paragraph"><p>A commit&#8217;s reachable set is the commit itself and the commits in
its ancestry chain.</p></div>
<div class="paragraph"><p>There are several notations to specify a set of connected commits
(called a "revision range"), illustrated below.</p></div>
<div class="sect2">
<h3 id="_commit_exclusions">Commit Exclusions</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
<em>&#94;&lt;rev&gt;</em> (caret) Notation
</dt>
<dd>
<p>
 To exclude commits reachable from a commit, a prefix <em>&#94;</em>
 notation is used.  E.g. <em>&#94;r1 r2</em> means commits reachable
 from <em>r2</em> but exclude the ones reachable from <em>r1</em> (i.e. <em>r1</em> and
 its ancestors).
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_dotted_range_notations">Dotted Range Notations</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
The <em>..</em> (two-dot) Range Notation
</dt>
<dd>
<p>
 The <em>&#94;r1 r2</em> set operation appears so often that there is a shorthand
 for it.  When you have two commits <em>r1</em> and <em>r2</em> (named according
 to the syntax explained in SPECIFYING REVISIONS above), you can ask
 for commits that are reachable from r2 excluding those that are reachable
 from r1 by <em>&#94;r1 r2</em> and it can be written as <em>r1..r2</em>.
</p>
</dd>
<dt class="hdlist1">
The <em>...</em> (three-dot) Symmetric Difference Notation
</dt>
<dd>
<p>
 A similar notation <em>r1...r2</em> is called symmetric difference
 of <em>r1</em> and <em>r2</em> and is defined as
 <em>r1 r2 --not $(git merge-base --all r1 r2)</em>.
 It is the set of commits that are reachable from either one of
 <em>r1</em> (left side) or <em>r2</em> (right side) but not from both.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>In these two shorthand notations, you can omit one end and let it default to HEAD.
For example, <em>origin..</em> is a shorthand for <em>origin..HEAD</em> and asks "What
did I do since I forked from the origin branch?"  Similarly, <em>..origin</em>
is a shorthand for <em>HEAD..origin</em> and asks "What did the origin do since
I forked from them?"  Note that <em>..</em> would mean <em>HEAD..HEAD</em> which is an
empty range that is both reachable and unreachable from HEAD.</p></div>
<div class="paragraph"><p>Commands that are specifically designed to take two distinct ranges
(e.g. "git range-diff R1 R2" to compare two ranges) do exist, but
they are exceptions.  Unless otherwise noted, all "git" commands
that operate on a set of commits work on a single revision range.
In other words, writing two "two-dot range notation" next to each
other, e.g.</p></div>
<div class="literalblock">
<div class="content">
<pre><code>$ git log A..B C..D</code></pre>
</div></div>
<div class="paragraph"><p>does <strong>not</strong> specify two revision ranges for most commands.  Instead
it will name a single connected set of commits, i.e. those that are
reachable from either B or D but are reachable from neither A or C.
In a linear history like this:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>---A---B---o---o---C---D</code></pre>
</div></div>
<div class="paragraph"><p>because A and B are reachable from C, the revision range specified
by these two dotted ranges is a single commit D.</p></div>
</div>
<div class="sect2">
<h3 id="_other_lt_rev_gt_94_parent_shorthand_notations">Other &lt;rev&gt;&#94; Parent Shorthand Notations</h3>
<div class="paragraph"><p>Three other shorthands exist, particularly useful for merge commits,
for naming a set that is formed by a commit and its parent commits.</p></div>
<div class="paragraph"><p>The <em>r1&#94;@</em> notation means all parents of <em>r1</em>.</p></div>
<div class="paragraph"><p>The <em>r1&#94;!</em> notation includes commit <em>r1</em> but excludes all of its parents.
By itself, this notation denotes the single commit <em>r1</em>.</p></div>
<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
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
not given. This is typically useful for merge commits where you
can just pass <em>&lt;commit&gt;&#94;-</em> to get all the commits in the branch
that was merged in merge commit <em>&lt;commit&gt;</em> (including <em>&lt;commit&gt;</em>
itself).</p></div>
<div class="paragraph"><p>While <em>&lt;rev&gt;&#94;&lt;n&gt;</em> was about specifying a single commit parent, these
three notations also consider its parents. For example you can say
<em>HEAD&#94;2&#94;@</em>, however you cannot say <em>HEAD&#94;@&#94;2</em>.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_revision_range_summary">Revision Range Summary</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
<em>&lt;rev&gt;</em>
</dt>
<dd>
<p>
        Include commits that are reachable from &lt;rev&gt; (i.e. &lt;rev&gt; and its
        ancestors).
</p>
</dd>
<dt class="hdlist1">
<em>&#94;&lt;rev&gt;</em>
</dt>
<dd>
<p>
        Exclude commits that are reachable from &lt;rev&gt; (i.e. &lt;rev&gt; and its
        ancestors).
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev1&gt;..&lt;rev2&gt;</em>
</dt>
<dd>
<p>
        Include commits that are reachable from &lt;rev2&gt; but exclude
        those that are reachable from &lt;rev1&gt;.  When either &lt;rev1&gt; or
        &lt;rev2&gt; is omitted, it defaults to <code>HEAD</code>.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev1&gt;...&lt;rev2&gt;</em>
</dt>
<dd>
<p>
        Include commits that are reachable from either &lt;rev1&gt; or
        &lt;rev2&gt; but exclude those that are reachable from both.  When
        either &lt;rev1&gt; or &lt;rev2&gt; is omitted, it defaults to <code>HEAD</code>.
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;&#94;@</em>, e.g. <em>HEAD&#94;@</em>
</dt>
<dd>
<p>
  A suffix <em>&#94;</em> followed by an at sign is the same as listing
  all parents of <em>&lt;rev&gt;</em> (meaning, include anything reachable from
  its parents, but not the commit itself).
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;&#94;!</em>, e.g. <em>HEAD&#94;!</em>
</dt>
<dd>
<p>
  A suffix <em>&#94;</em> followed by an exclamation mark is the same
  as giving commit <em>&lt;rev&gt;</em> and all its parents prefixed with
  <em>&#94;</em> to exclude them (and their ancestors).
</p>
</dd>
<dt class="hdlist1">
<em>&lt;rev&gt;&#94;-&lt;n&gt;</em>, e.g. <em>HEAD&#94;-, HEAD&#94;-2</em>
</dt>
<dd>
<p>
        Equivalent to <em>&lt;rev&gt;&#94;&lt;n&gt;..&lt;rev&gt;</em>, with <em>&lt;n&gt;</em> = 1 if not
        given.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>Here are a handful of examples using the Loeliger illustration above,
with each step in the notation&#8217;s expansion and selection carefully
spelt out:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>   Args   Expanded arguments    Selected commits
   D                            G H D
   D F                          G H I J D F
   ^G D                         H D
   ^D B                         E I J F B
   ^D B C                       E I J F B C
   C                            I J F C
   B..C   = ^B C                C
   B...C  = B ^F C              G H D E B C
   B^-    = B^..B
          = ^B^1 B              E I J F B
   C^@    = C^1
          = F                   I J F
   B^@    = B^1 B^2 B^3
          = D E F               D G H E F I J
   C^!    = C ^C^@
          = C ^C^1
          = C ^F                C
   B^!    = B ^B^@
          = B ^B^1 ^B^2 ^B^3
          = B ^D ^E ^F          B
   F^! D  = F ^I ^J D           G H D F</code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_parseopt">PARSEOPT</h2>
<div class="sectionbody">
<div class="paragraph"><p>In <code>--parseopt</code> mode, <em>git rev-parse</em> helps massaging options to bring to shell
scripts the same facilities C builtins have. It works as an option normalizer
(e.g. splits single switches aggregate values), a bit like <code>getopt(1)</code> does.</p></div>
<div class="paragraph"><p>It takes on the standard input the specification of the options to parse and
understand, and echoes on the standard output a string suitable for <code>sh(1)</code> <code>eval</code>
to replace the arguments with normalized ones.  In case of error, it outputs
usage on the standard error stream, and exits with code 129.</p></div>
<div class="paragraph"><p>Note: Make sure you quote the result when passing it to <code>eval</code>.  See
below for an example.</p></div>
<div class="sect2">
<h3 id="_input_format">Input Format</h3>
<div class="paragraph"><p><em>git rev-parse --parseopt</em> input format is fully text based. It has two parts,
separated by a line that contains only <code>--</code>. The lines before the separator
(should be one or more) are used for the usage.
The lines after the separator describe the options.</p></div>
<div class="paragraph"><p>Each line of options has this format:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>&lt;opt-spec&gt;&lt;flags&gt;*&lt;arg-hint&gt;? SP+ help LF</code></pre>
</div></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>&lt;opt-spec&gt;</code>
</dt>
<dd>
<p>
        its format is the short option character, then the long option name
        separated by a comma. Both parts are not required, though at least one
        is necessary. May not contain any of the <code>&lt;flags&gt;</code> characters.
        <code>h,help</code>, <code>dry-run</code> and <code>f</code> are examples of correct <code>&lt;opt-spec&gt;</code>.
</p>
</dd>
<dt class="hdlist1">
<code>&lt;flags&gt;</code>
</dt>
<dd>
<p>
        <code>&lt;flags&gt;</code> are of <code>*</code>, <code>=</code>, <code>?</code> or <code>!</code>.
</p>
<div class="ulist"><ul>
<li>
<p>
Use <code>=</code> if the option takes an argument.
</p>
</li>
<li>
<p>
Use <code>?</code> to mean that the option takes an optional argument. You
          probably want to use the <code>--stuck-long</code> mode to be able to
          unambiguously parse the optional argument.
</p>
</li>
<li>
<p>
Use <code>*</code> to mean that this option should not be listed in the usage
          generated for the <code>-h</code> argument. It&#8217;s shown for <code>--help-all</code> as
          documented in <a href="gitcli.html">gitcli(7)</a>.
</p>
</li>
<li>
<p>
Use <code>!</code> to not make the corresponding negated long option available.
</p>
</li>
</ul></div>
</dd>
<dt class="hdlist1">
<code>&lt;arg-hint&gt;</code>
</dt>
<dd>
<p>
        <code>&lt;arg-hint&gt;</code>, if specified, is used as a name of the argument in the
        help output, for options that take arguments. <code>&lt;arg-hint&gt;</code> is
        terminated by the first whitespace.  It is customary to use a
        dash to separate words in a multi-word argument hint.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>The remainder of the line, after stripping the spaces, is used
as the help associated with the option.</p></div>
<div class="paragraph"><p>Blank lines are ignored, and lines that don&#8217;t match this specification are used
as option group headers (start the line with a space to create such
lines on purpose).</p></div>
</div>
<div class="sect2">
<h3 id="_example">Example</h3>
<div class="listingblock">
<div class="content">
<pre><code>OPTS_SPEC="\
some-command [&lt;options&gt;] &lt;args&gt;...

some-command does foo and bar!
--
h,help!   show the help

foo       some nifty option --foo
bar=      some cool option --bar with an argument
baz=arg   another cool option --baz with a named argument
qux?path  qux may take a path argument but has meaning by itself

  An option group Header
C?        option C with an optional argument"

eval "$(echo "$OPTS_SPEC" | git rev-parse --parseopt -- "$@" || echo exit $?)"</code></pre>
</div></div>
</div>
<div class="sect2">
<h3 id="_usage_text">Usage text</h3>
<div class="paragraph"><p>When <code>"$@"</code> is <code>-h</code> or <code>--help</code> in the above example, the following
usage text would be shown:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>usage: some-command [&lt;options&gt;] &lt;args&gt;...

    some-command does foo and bar!

    -h, --help            show the help
    --[no-]foo            some nifty option --foo
    --[no-]bar ...        some cool option --bar with an argument
    --[no-]baz &lt;arg&gt;      another cool option --baz with a named argument
    --[no-]qux[=&lt;path&gt;]   qux may take a path argument but has meaning by itself

An option group Header
    -C[...]               option C with an optional argument</code></pre>
</div></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_sq_quote">SQ-QUOTE</h2>
<div class="sectionbody">
<div class="paragraph"><p>In <code>--sq-quote</code> mode, <em>git rev-parse</em> echoes on the standard output a
single line suitable for <code>sh(1)</code> <code>eval</code>. This line is made by
normalizing the arguments following <code>--sq-quote</code>. Nothing other than
quoting the arguments is done.</p></div>
<div class="paragraph"><p>If you want command input to still be interpreted as usual by
<em>git rev-parse</em> before the output is shell quoted, see the <code>--sq</code>
option.</p></div>
<div class="sect2">
<h3 id="_example_2">Example</h3>
<div class="listingblock">
<div class="content">
<pre><code>$ cat &gt;your-git-script.sh &lt;&lt;\EOF
#!/bin/sh
args=$(git rev-parse --sq-quote "$@")   # quote user-supplied arguments
command="git frotz -n24 $args"          # and use it inside a handcrafted
                                        # command line
eval "$command"
EOF

$ sh your-git-script.sh "a b'c"</code></pre>
</div></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
Print the object name of the current commit:
</p>
<div class="listingblock">
<div class="content">
<pre><code>$ git rev-parse --verify HEAD</code></pre>
</div></div>
</li>
<li>
<p>
Print the commit object name from the revision in the $REV shell variable:
</p>
<div class="listingblock">
<div class="content">
<pre><code>$ git rev-parse --verify --end-of-options $REV^{commit}</code></pre>
</div></div>
<div class="paragraph"><p>This will error out if $REV is empty or not a valid revision.</p></div>
</li>
<li>
<p>
Similar to above:
</p>
<div class="listingblock">
<div class="content">
<pre><code>$ git rev-parse --default master --verify --end-of-options $REV</code></pre>
</div></div>
<div class="paragraph"><p>but if $REV is empty, the commit object name from master will be printed.</p></div>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
 2024-03-28 14:36:08 PDT
</div>
</div>
</body>
</html>