| blob | 7db58b5449583052ddb32fef6af9d8a0e75fbb69 |
4 <head>
8 /* Debug borders */
10 /*
11 border: 1px solid red;
12 */
13 }
15 body {
17 }
19 a {
22 }
25 }
27 em {
29 }
31 strong {
33 }
35 tt {
37 }
45 }
49 }
50 h2 {
52 }
53 h3 {
55 }
56 h3 + * {
58 }
63 }
65 hr {
67 }
69 p {
72 }
74 pre {
77 }
79 span#author {
84 }
85 span#email {
86 }
87 span#revision {
89 }
91 div#footer {
97 }
98 div#footer-text {
101 }
102 div#footer-badges {
105 }
107 div#preamble,
114 }
118 }
122 }
124 /* Block element titles. */
131 }
134 }
138 }
141 }
144 }
150 }
154 }
159 }
163 }
167 }
170 }
179 }
183 }
188 }
192 }
198 dl {
201 }
202 dt {
206 }
209 }
213 }
216 }
220 }
221 thead {
224 }
225 tfoot {
227 }
232 }
235 }
240 }
243 }
247 }
249 div#toctitle {
256 }
261 }
265 }
269 }
273 }
275 /* Workarounds for IE6's broken and incomplete CSS2. */
281 }
287 }
293 }
297 }
302 }
304 /* IE6 sets dynamically generated links as visited. */
306 </style>
308 </head>
309 <body>
311 <h1>
312 git-describe(1) Manual Page
313 </h1>
316 <p>git-describe -
317 Show the most recent tag that is reachable from a commit
318 </p>
319 </div>
320 </div>
324 <div class="content"><em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] <committish>…
325 <em>git describe</em> [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]</div></div>
326 </div>
330 commit. If the tag points to the commit, then only the tag is
331 shown. Otherwise, it suffixes the tag name with the number of
332 additional commits on top of the tagged object and the
333 abbreviated object name of the most recent commit.</p></div>
335 annotated tags. For more information about creating annotated tags
337 </div>
341 <dt>
343 </dt>
344 <dd>
345 <p>
346 Committish object names to describe.
347 </p>
348 </dd>
349 <dt>
351 </dt>
352 <dd>
353 <p>
354 Describe the working tree.
356 default) if the working tree is dirty.
357 </p>
358 </dd>
359 <dt>
360 --all
361 </dt>
362 <dd>
363 <p>
364 Instead of using only the annotated tags, use any ref
366 any known branch, remote branch, or lightweight tag.
367 </p>
368 </dd>
369 <dt>
370 --tags
371 </dt>
372 <dd>
373 <p>
374 Instead of using only the annotated tags, use any tag
376 a lightweight (non-annotated) tag.
377 </p>
378 </dd>
379 <dt>
380 --contains
381 </dt>
382 <dd>
383 <p>
384 Instead of finding the tag that predates the commit, find
385 the tag that comes after the commit, and thus contains it.
386 Automatically implies --tags.
387 </p>
388 </dd>
389 <dt>
391 </dt>
392 <dd>
393 <p>
394 Instead of using the default 7 hexadecimal digits as the
397 will suppress long format, only showing the closest tag.
398 </p>
399 </dd>
400 <dt>
402 </dt>
403 <dd>
404 <p>
405 Instead of considering only the 10 most recent tags as
406 candidates to describe the input committish consider
408 slightly longer but may produce a more accurate result.
410 </p>
411 </dd>
412 <dt>
413 --exact-match
414 </dt>
415 <dd>
416 <p>
417 Only output exact matches (a tag directly references the
418 supplied commit). This is a synonym for --candidates=0.
419 </p>
420 </dd>
421 <dt>
422 --debug
423 </dt>
424 <dd>
425 <p>
426 Verbosely display information about the searching strategy
427 being employed to standard error. The tag name will still
428 be printed to standard out.
429 </p>
430 </dd>
431 <dt>
432 --long
433 </dt>
434 <dd>
435 <p>
436 Always output the long format (the tag, the number of commits
437 and the abbreviated commit name) even when it matches a tag.
438 This is useful when you want to see parts of the commit object name
439 in "describe" output, even when the commit in question happens to be
440 a tagged version. Instead of just emitting the tag name, it will
442 that points at object deadbee….).
443 </p>
444 </dd>
445 <dt>
447 </dt>
448 <dd>
449 <p>
450 Only consider tags matching the given pattern (can be used to avoid
451 leaking private tags made from the repository).
452 </p>
453 </dd>
454 <dt>
455 --always
456 </dt>
457 <dd>
458 <p>
459 Show uniquely abbreviated commit object as fallback.
460 </p>
461 </dd>
462 </dl></div>
463 </div>
469 <pre><tt>[torvalds@g5 git]$ git describe parent
471 </div></div>
473 but since it has a few commits on top of that,
474 describe has added the number of additional commits ("14") and
475 an abbreviated object name for the commit itself ("2414721")
476 at the end.</p></div>
478 of commits which would be displayed by "git log v1.0.4..parent".
482 a software depending on the SCM the software is managed with. This is useful
483 in an environment where people may use different SCMs.</p></div>
484 <div class="para"><p>Doing a <em>git describe</em> on a tag-name will just show the tag name:</p></div>
489 </div></div>
491 the output shows the reference path as well:</p></div>
496 </div></div>
501 </div></div>
503 closest tagname without any suffix:</p></div>
508 </div></div>
510 longer than what Linus saw above when he ran these commands, as your
511 git repository may have new commits whose object names begin with
513 be sufficient to disambiguate these commits.</p></div>
514 </div>
518 a tag which tags exactly that commit. Annotated tags will always
519 be preferred over lightweight tags, and tags with newer dates will
520 always be preferred over tags with older dates. If an exact match
521 is found, its name will be output and searching will stop.</p></div>
523 through the commit history to locate an ancestor commit which
524 has been tagged. The ancestor's tag will be output along with an
525 abbreviation of the input committish's SHA1.</p></div>
527 has the fewest commits different from the input committish will be
528 selected and output. Here fewest commits different is defined as
530 will be the smallest number of commits possible.</p></div>
531 </div>
537 </div>
540 <div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.</p></div>
541 </div>
545 </div>
549 </div>
550 </div>
551 </body>
552 </html>