Google Git
Sign in
chromium / external / gitster / git-htmldocs / cbe0eb29622a497f18818e4481f27636446b86d7 / . / git-describe.html
blob: a86e0495eb3bbb060ac94c3ea8e1148dba577b20 [file] [log] [blame]
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]7<title>git-describe(1)</title>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]37
38em {
39 font-style: italic;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]40 color: navy;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]41}
42
43strong {
44 font-weight: bold;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]45 color: #083194;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]46}
47
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]55h1, h2, h3 {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]56 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]59 padding-top: 0.5em;
60}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]70
71div.sectionbody {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]72 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]89
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]102 color: #527bbd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]103 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]104 font-size: 1.1em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]117#footer-text {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]121#footer-badges {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]126#preamble {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]133 margin-top: 1.0em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]149 color: #527bbd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]189}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]190
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]193 text-align: right;
194}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]195
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]219 border-left: 3px solid #dddddd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]225}
226
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]229a.image:visited { color: white; }
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]238 font-style: normal;
239 color: navy;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]240}
241dd > *:first-child {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]242 margin-top: 0.1em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]252 list-style-type: lower-alpha;
253}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]270
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]271tfoot {
272 font-weight: bold;
273}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]277
278div.hdlist {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]284}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]289 vertical-align: top;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]290 font-style: normal;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]291 padding-right: 0.8em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]292 color: navy;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]293}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]294td.hdlist2 {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]295 vertical-align: top;
296}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]305
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]340}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]341
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]350#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]374
375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
427}
428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
432 font-weight: bold;
433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
449}
450
451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
480}
481
482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
501 text-align: right;
502}
503
504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
506}
507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
512}
513
514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]526body.manpage h2 {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]527 border-style: none;
528}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]531}
532
533@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]534 body.manpage div#toc { display: none; }
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]536
537
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]731/*]]>*/
732</script>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="manpage">
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]735<div id="header">
736<h1>
737git-describe(1) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>git-describe -
Junio C Hamano2f797822015-07-01 22:26:23[diff] [blame]742 Describe a commit using the most recent tag reachable from it
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]743</p>
744</div>
745</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]746<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]747<div class="sect1">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]748<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]749<div class="sectionbody">
Junio C Hamano0ecfa0f2009-11-10 22:13:24[diff] [blame]750<div class="verseblock">
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]751<pre class="content"><em>git describe</em> [--all] [--tags] [--contains] [--abbrev=&lt;n&gt;] [&lt;commit-ish&gt;&#8230;]
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]752<em>git describe</em> [--all] [--tags] [--contains] [--abbrev=&lt;n&gt;] --dirty[=&lt;mark&gt;]</pre>
753<div class="attribution">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]754</div></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]755</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]756</div>
757<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]758<h2 id="_description">DESCRIPTION</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]759<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]760<div class="paragraph"><p>The command finds the most recent tag that is reachable from a
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]761commit. If the tag points to the commit, then only the tag is
762shown. Otherwise, it suffixes the tag name with the number of
763additional commits on top of the tagged object and the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]764abbreviated object name of the most recent commit.</p></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]765<div class="paragraph"><p>By default (without --all or --tags) <code>git describe</code> only shows
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]766annotated tags. For more information about creating annotated tags
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]767see the -a and -s options to <a href="git-tag.html">git-tag(1)</a>.</p></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]768</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]769</div>
770<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]771<h2 id="_options">OPTIONS</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]772<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]773<div class="dlist"><dl>
774<dt class="hdlist1">
Junio C Hamanoe6f28d02013-09-17 21:34:00[diff] [blame]775&lt;commit-ish&gt;&#8230;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]776</dt>
777<dd>
778<p>
Junio C Hamano3891e252015-08-31 23:06:13[diff] [blame]779 Commit-ish object names to describe. Defaults to HEAD if omitted.
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]780</p>
781</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]782<dt class="hdlist1">
Junio C Hamano446ed772009-11-10 22:02:20[diff] [blame]783--dirty[=&lt;mark&gt;]
784</dt>
785<dd>
786<p>
787 Describe the working tree.
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]788 It means describe HEAD and appends &lt;mark&gt; (<code>-dirty</code> by
Junio C Hamano446ed772009-11-10 22:02:20[diff] [blame]789 default) if the working tree is dirty.
790</p>
791</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]792<dt class="hdlist1">
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]793--all
794</dt>
795<dd>
796<p>
797 Instead of using only the annotated tags, use any ref
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]798 found in <code>refs/</code> namespace. This option enables matching
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]799 any known branch, remote-tracking branch, or lightweight tag.
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]800</p>
801</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]802<dt class="hdlist1">
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]803--tags
804</dt>
805<dd>
806<p>
807 Instead of using only the annotated tags, use any tag
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]808 found in <code>refs/tags</code> namespace. This option enables matching
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]809 a lightweight (non-annotated) tag.
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]810</p>
811</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]812<dt class="hdlist1">
Junio C Hamano5e284b42007-05-22 07:23:37[diff] [blame]813--contains
814</dt>
815<dd>
816<p>
817 Instead of finding the tag that predates the commit, find
818 the tag that comes after the commit, and thus contains it.
819 Automatically implies --tags.
820</p>
821</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]822<dt class="hdlist1">
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]823--abbrev=&lt;n&gt;
824</dt>
825<dd>
826<p>
Junio C Hamano22bcc112009-01-24 08:05:18[diff] [blame]827 Instead of using the default 7 hexadecimal digits as the
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]828 abbreviated object name, use &lt;n&gt; digits, or as many digits
829 as needed to form a unique object name. An &lt;n&gt; of 0
830 will suppress long format, only showing the closest tag.
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]831</p>
832</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]833<dt class="hdlist1">
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]834--candidates=&lt;n&gt;
835</dt>
836<dd>
837<p>
838 Instead of considering only the 10 most recent tags as
Junio C Hamanoe6f28d02013-09-17 21:34:00[diff] [blame]839 candidates to describe the input commit-ish consider
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]840 up to &lt;n&gt; candidates. Increasing &lt;n&gt; above 10 will take
841 slightly longer but may produce a more accurate result.
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]842 An &lt;n&gt; of 0 will cause only exact matches to be output.
843</p>
844</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]845<dt class="hdlist1">
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]846--exact-match
847</dt>
848<dd>
849<p>
850 Only output exact matches (a tag directly references the
851 supplied commit). This is a synonym for --candidates=0.
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]852</p>
853</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]854<dt class="hdlist1">
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]855--debug
856</dt>
857<dd>
858<p>
859 Verbosely display information about the searching strategy
860 being employed to standard error. The tag name will still
861 be printed to standard out.
862</p>
863</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]864<dt class="hdlist1">
Junio C Hamano4f1d8c42008-03-03 02:01:16[diff] [blame]865--long
866</dt>
867<dd>
868<p>
869 Always output the long format (the tag, the number of commits
870 and the abbreviated commit name) even when it matches a tag.
871 This is useful when you want to see parts of the commit object name
872 in "describe" output, even when the commit in question happens to be
873 a tagged version. Instead of just emitting the tag name, it will
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]874 describe such a commit as v1.2-0-gdeadbee (0th commit since tag v1.2
875 that points at object deadbee&#8230;.).
Junio C Hamano4f1d8c42008-03-03 02:01:16[diff] [blame]876</p>
877</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]878<dt class="hdlist1">
Junio C Hamano9c334152008-02-12 03:18:52[diff] [blame]879--match &lt;pattern&gt;
880</dt>
881<dd>
882<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]883 Only consider tags matching the given <code>glob(7)</code> pattern,
Junio C Hamano947ab822013-03-19 23:07:29[diff] [blame]884 excluding the "refs/tags/" prefix. This can be used to avoid
Junio C Hamanocbe0eb22017-02-27 23:37:49[diff] [blame^]885 leaking private tags from the repository. If given multiple times, a
886 list of patterns will be accumulated, and tags matching any of the
887 patterns will be considered. Use <code>--no-match</code> to clear and reset the
888 list of patterns.
889</p>
890</dd>
891<dt class="hdlist1">
892--exclude &lt;pattern&gt;
893</dt>
894<dd>
895<p>
896 Do not consider tags matching the given <code>glob(7)</code> pattern, excluding
897 the "refs/tags/" prefix. This can be used to narrow the tag space and
898 find only tags matching some meaningful criteria. If given multiple
899 times, a list of patterns will be accumulated and tags matching any
900 of the patterns will be excluded. When combined with --match a tag will
901 be considered when it matches at least one --match pattern and does not
902 match any of the --exclude patterns. Use <code>--no-exclude</code> to clear and
903 reset the list of patterns.
Junio C Hamano9c334152008-02-12 03:18:52[diff] [blame]904</p>
905</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]906<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]907--always
908</dt>
909<dd>
910<p>
911 Show uniquely abbreviated commit object as fallback.
912</p>
913</dd>
Junio C Hamano7e590a12013-06-02 23:46:52[diff] [blame]914<dt class="hdlist1">
915--first-parent
916</dt>
917<dd>
918<p>
919 Follow only the first parent commit upon seeing a merge commit.
920 This is useful when you wish to not match tags on branches merged
921 in the history of the target commit.
922</p>
923</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]924</dl></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]925</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]926</div>
927<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]928<h2 id="_examples">EXAMPLES</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]929<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]930<div class="paragraph"><p>With something like git.git current tree, I get:</p></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]931<div class="literalblock">
932<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]933<pre><code>[torvalds@g5 git]$ git describe parent
934v1.0.4-14-g2414721</code></pre>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]935</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]936<div class="paragraph"><p>i.e. the current head of my "parent" branch is based on v1.0.4,
Junio C Hamano6efe3022009-01-13 16:47:56[diff] [blame]937but since it has a few commits on top of that,
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]938describe has added the number of additional commits ("14") and
939an abbreviated object name for the commit itself ("2414721")
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]940at the end.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]941<div class="paragraph"><p>The number of additional commits is the number
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]942of commits which would be displayed by "git log v1.0.4..parent".
943The hash suffix is "-g" + 7-char abbreviation for the tip commit
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]944of parent (which was <code>2414721b194453f058079d897d13c4e377f92dc6</code>).
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]945The "g" prefix stands for "git" and is used to allow describing the version of
946a software depending on the SCM the software is managed with. This is useful
947in an environment where people may use different SCMs.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]948<div class="paragraph"><p>Doing a <em>git describe</em> on a tag-name will just show the tag name:</p></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]949<div class="literalblock">
950<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]951<pre><code>[torvalds@g5 git]$ git describe v1.0.4
952v1.0.4</code></pre>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]953</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]954<div class="paragraph"><p>With --all, the command can use branch heads as references, so
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]955the output shows the reference path as well:</p></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]956<div class="literalblock">
957<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]958<pre><code>[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2
959tags/v1.0.0-21-g975b</code></pre>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]960</div></div>
961<div class="literalblock">
962<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]963<pre><code>[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^
964heads/lt/describe-7-g975b</code></pre>
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]965</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]966<div class="paragraph"><p>With --abbrev set to 0, the command can be used to find the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]967closest tagname without any suffix:</p></div>
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]968<div class="literalblock">
969<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]970<pre><code>[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
971tags/v1.0.0</code></pre>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]972</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]973<div class="paragraph"><p>Note that the suffix you get if you type these commands today may be
Junio C Hamanoa1f86332009-11-05 05:28:43[diff] [blame]974longer than what Linus saw above when he ran these commands, as your
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]975Git repository may have new commits whose object names begin with
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]976975b that did not exist back then, and "-g975b" suffix alone may not
977be sufficient to disambiguate these commits.</p></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]978</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]979</div>
980<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]981<h2 id="_search_strategy">SEARCH STRATEGY</h2>
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]982<div class="sectionbody">
Junio C Hamanoe6f28d02013-09-17 21:34:00[diff] [blame]983<div class="paragraph"><p>For each commit-ish supplied, <em>git describe</em> will first look for
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]984a tag which tags exactly that commit. Annotated tags will always
985be preferred over lightweight tags, and tags with newer dates will
986always be preferred over tags with older dates. If an exact match
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]987is found, its name will be output and searching will stop.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]988<div class="paragraph"><p>If an exact match was not found, <em>git describe</em> will walk back
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]989through the commit history to locate an ancestor commit which
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]990has been tagged. The ancestor&#8217;s tag will be output along with an
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]991abbreviation of the input commit-ish&#8217;s SHA-1. If <code>--first-parent</code> was
Junio C Hamano7e590a12013-06-02 23:46:52[diff] [blame]992specified then the walk will only consider the first parent of each
993commit.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]994<div class="paragraph"><p>If multiple tags were found during the walk then the tag which
Junio C Hamanoe6f28d02013-09-17 21:34:00[diff] [blame]995has the fewest commits different from the input commit-ish will be
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]996selected and output. Here fewest commits different is defined as
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]997the number of commits which would be shown by <code>git log tag..input</code>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]998will be the smallest number of commits possible.</p></div>
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]999</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1000</div>
1001<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1002<h2 id="_git">GIT</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]1003<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1004<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]1005</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1006</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1007</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1008<div id="footnotes"><hr /></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]1009<div id="footer">
1010<div id="footer-text">
Junio C Hamanocbe0eb22017-02-27 23:37:49[diff] [blame^]1011Last updated 2017-02-27 15:37:25 PST
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]1012</div>
1013</div>
1014</body>
1015</html>