Google Git
Sign in
chromium / external / gitster / git-htmldocs / 02194af879b3d6ac73715fc296d5d9d68b7f8610 / . / git-describe.html
blob: 0be5291d9a8bb5d923507bde37e6e98a05d5c3ce [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>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
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">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]30 color: navy;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]35 color: #083194;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]91}
92span#email {
93}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]137 color: #527bbd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]180 text-align: right;
181}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]182
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]211}
212
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]215a.image:visited { color: white; }
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]228 margin-top: 0.1em;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]285
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]286
287div.hdlist {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]293}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]298 vertical-align: top;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]299 font-style: normal;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]301 color: navy;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]302}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]303td.hdlist2 {
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]402 color: #527bbd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-describe(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-describe -
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]578 Show the most recent tag that is reachable from a commit
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]584<div class="sectionbody">
Junio C Hamano0ecfa0f2009-11-10 22:13:24[diff] [blame]585<div class="verseblock">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]586<div class="verseblock-content"><em>git describe</em> [--all] [--tags] [--contains] [--abbrev=&lt;n&gt;] &lt;committish&gt;&#8230;
587<em>git describe</em> [--all] [--tags] [--contains] [--abbrev=&lt;n&gt;] --dirty[=&lt;mark&gt;]</div>
588<div class="verseblock-attribution">
589</div></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]590</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]591<h2 id="_description">DESCRIPTION</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]592<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]593<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]594commit. If the tag points to the commit, then only the tag is
595shown. Otherwise, it suffixes the tag name with the number of
596additional commits on top of the tagged object and the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]597abbreviated object name of the most recent commit.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]598<div class="paragraph"><p>By default (without --all or --tags) <tt>git describe</tt> only shows
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]599annotated tags. For more information about creating annotated tags
600see 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]601</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]602<h2 id="_options">OPTIONS</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]603<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]604<div class="dlist"><dl>
605<dt class="hdlist1">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]606&lt;committish&gt;&#8230;
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]607</dt>
608<dd>
609<p>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]610 Committish object names to describe.
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]611</p>
612</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]613<dt class="hdlist1">
Junio C Hamano446ed772009-11-10 22:02:20[diff] [blame]614--dirty[=&lt;mark&gt;]
615</dt>
616<dd>
617<p>
618 Describe the working tree.
619 It means describe HEAD and appends &lt;mark&gt; (<tt>-dirty</tt> by
620 default) if the working tree is dirty.
621</p>
622</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]623<dt class="hdlist1">
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]624--all
625</dt>
626<dd>
627<p>
628 Instead of using only the annotated tags, use any ref
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]629 found in <tt>.git/refs/</tt>. This option enables matching
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]630 any known branch, remote-tracking branch, or lightweight tag.
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]631</p>
632</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]633<dt class="hdlist1">
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]634--tags
635</dt>
636<dd>
637<p>
638 Instead of using only the annotated tags, use any tag
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]639 found in <tt>.git/refs/tags</tt>. This option enables matching
640 a lightweight (non-annotated) tag.
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]641</p>
642</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]643<dt class="hdlist1">
Junio C Hamano5e284b42007-05-22 07:23:37[diff] [blame]644--contains
645</dt>
646<dd>
647<p>
648 Instead of finding the tag that predates the commit, find
649 the tag that comes after the commit, and thus contains it.
650 Automatically implies --tags.
651</p>
652</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]653<dt class="hdlist1">
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]654--abbrev=&lt;n&gt;
655</dt>
656<dd>
657<p>
Junio C Hamano22bcc112009-01-24 08:05:18[diff] [blame]658 Instead of using the default 7 hexadecimal digits as the
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]659 abbreviated object name, use &lt;n&gt; digits, or as many digits
660 as needed to form a unique object name. An &lt;n&gt; of 0
661 will suppress long format, only showing the closest tag.
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]662</p>
663</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]664<dt class="hdlist1">
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]665--candidates=&lt;n&gt;
666</dt>
667<dd>
668<p>
669 Instead of considering only the 10 most recent tags as
670 candidates to describe the input committish consider
671 up to &lt;n&gt; candidates. Increasing &lt;n&gt; above 10 will take
672 slightly longer but may produce a more accurate result.
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]673 An &lt;n&gt; of 0 will cause only exact matches to be output.
674</p>
675</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]676<dt class="hdlist1">
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]677--exact-match
678</dt>
679<dd>
680<p>
681 Only output exact matches (a tag directly references the
682 supplied commit). This is a synonym for --candidates=0.
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]683</p>
684</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]685<dt class="hdlist1">
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]686--debug
687</dt>
688<dd>
689<p>
690 Verbosely display information about the searching strategy
691 being employed to standard error. The tag name will still
692 be printed to standard out.
693</p>
694</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]695<dt class="hdlist1">
Junio C Hamano4f1d8c42008-03-03 02:01:16[diff] [blame]696--long
697</dt>
698<dd>
699<p>
700 Always output the long format (the tag, the number of commits
701 and the abbreviated commit name) even when it matches a tag.
702 This is useful when you want to see parts of the commit object name
703 in "describe" output, even when the commit in question happens to be
704 a tagged version. Instead of just emitting the tag name, it will
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]705 describe such a commit as v1.2-0-gdeadbee (0th commit since tag v1.2
706 that points at object deadbee&#8230;.).
Junio C Hamano4f1d8c42008-03-03 02:01:16[diff] [blame]707</p>
708</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]709<dt class="hdlist1">
Junio C Hamano9c334152008-02-12 03:18:52[diff] [blame]710--match &lt;pattern&gt;
711</dt>
712<dd>
713<p>
714 Only consider tags matching the given pattern (can be used to avoid
715 leaking private tags made from the repository).
716</p>
717</dd>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]718<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]719--always
720</dt>
721<dd>
722<p>
723 Show uniquely abbreviated commit object as fallback.
724</p>
725</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]726</dl></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]727</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]728<h2 id="_examples">EXAMPLES</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]729<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]730<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]731<div class="literalblock">
732<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]733<pre><tt>[torvalds@g5 git]$ git describe parent
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]734v1.0.4-14-g2414721</tt></pre>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]735</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]736<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]737but since it has a few commits on top of that,
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]738describe has added the number of additional commits ("14") and
739an abbreviated object name for the commit itself ("2414721")
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]740at the end.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]741<div class="paragraph"><p>The number of additional commits is the number
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]742of commits which would be displayed by "git log v1.0.4..parent".
743The hash suffix is "-g" + 7-char abbreviation for the tip commit
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]744of parent (which was <tt>2414721b194453f058079d897d13c4e377f92dc6</tt>).
745The "g" prefix stands for "git" and is used to allow describing the version of
746a software depending on the SCM the software is managed with. This is useful
747in an environment where people may use different SCMs.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]748<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]749<div class="literalblock">
750<div class="content">
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]751<pre><tt>[torvalds@g5 git]$ git describe v1.0.4
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]752v1.0.4</tt></pre>
753</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]754<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]755the output shows the reference path as well:</p></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]756<div class="literalblock">
757<div class="content">
758<pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]759tags/v1.0.0-21-g975b</tt></pre>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]760</div></div>
761<div class="literalblock">
762<div class="content">
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]763<pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]764heads/lt/describe-7-g975b</tt></pre>
765</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]766<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]767closest tagname without any suffix:</p></div>
Junio C Hamanoa890c4f2007-01-28 10:29:21[diff] [blame]768<div class="literalblock">
769<div class="content">
770<pre><tt>[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
771tags/v1.0.0</tt></pre>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]772</div></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]773<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]774longer than what Linus saw above when he ran these commands, as your
Junio C Hamanoc21ab052009-10-31 04:03:55[diff] [blame]775git repository may have new commits whose object names begin with
776975b that did not exist back then, and "-g975b" suffix alone may not
777be sufficient to disambiguate these commits.</p></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]778</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]779<h2 id="_search_strategy">SEARCH STRATEGY</h2>
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]780<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]781<div class="paragraph"><p>For each committish supplied, <em>git describe</em> will first look for
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]782a tag which tags exactly that commit. Annotated tags will always
783be preferred over lightweight tags, and tags with newer dates will
784always be preferred over tags with older dates. If an exact match
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]785is found, its name will be output and searching will stop.</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]786<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]787through the commit history to locate an ancestor commit which
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]788has been tagged. The ancestor&#8217;s tag will be output along with an
789abbreviation of the input committish&#8217;s SHA1.</p></div>
790<div class="paragraph"><p>If multiple tags were found during the walk then the tag which
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]791has the fewest commits different from the input committish will be
792selected and output. Here fewest commits different is defined as
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]793the number of commits which would be shown by <tt>git log tag..input</tt>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]794will be the smallest number of commits possible.</p></div>
Junio C Hamanoedd2b0a2007-01-15 06:12:45[diff] [blame]795</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]796<h2 id="_git">GIT</h2>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]797<div class="sectionbody">
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]798<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]799</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]800</div>
801<div id="footnotes"><hr /></div>
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]802<div id="footer">
803<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame^]804Last updated 2011-11-15 13:45:02 PDT
Junio C Hamanoab008762005-12-28 02:33:00[diff] [blame]805</div>
806</div>
807</body>
808</html>