git-describe.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
   6 <meta name="generator" content="AsciiDoc 7.0.2" />\r
   7 <style type="text/css">\r
   8 /* Debug borders */\r
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
  10 /*\r
  11   border: 1px solid red;\r
  12 */\r
  13 }\r
  14 \r
  15 body {\r
  16   margin: 1em 5% 1em 5%;\r
  17 }\r
  18 \r
  19 a { color: blue; }\r
  20 a:visited { color: fuchsia; }\r
  21 \r
  22 em {\r
  23   font-style: italic;\r
  24 }\r
  25 \r
  26 strong {\r
  27   font-weight: bold;\r
  28 }\r
  29 \r
  30 tt {\r
  31   color: navy;\r
  32 }\r
  33 \r
  34 h1, h2, h3, h4, h5, h6 {\r
  35   color: #527bbd;\r
  36   font-family: sans-serif;\r
  37   margin-top: 1.2em;\r
  38   margin-bottom: 0.5em;\r
  39   line-height: 1.3;\r
  40 }\r
  41 \r
  42 h1 {\r
  43   border-bottom: 2px solid silver;\r
  44 }\r
  45 h2 {\r
  46   border-bottom: 2px solid silver;\r
  47   padding-top: 0.5em;\r
  48 }\r
  49 \r
  50 div.sectionbody {\r
  51   font-family: serif;\r
  52   margin-left: 0;\r
  53 }\r
  54 \r
  55 hr {\r
  56   border: 1px solid silver;\r
  57 }\r
  58 \r
  59 p {\r
  60   margin-top: 0.5em;\r
  61   margin-bottom: 0.5em;\r
  62 }\r
  63 \r
  64 pre {\r
  65   padding: 0;\r
  66   margin: 0;\r
  67 }\r
  68 \r
  69 span#author {\r
  70   color: #527bbd;\r
  71   font-family: sans-serif;\r
  72   font-weight: bold;\r
  73   font-size: 1.2em;\r
  74 }\r
  75 span#email {\r
  76 }\r
  77 span#revision {\r
  78   font-family: sans-serif;\r
  79 }\r
  80 \r
  81 div#footer {\r
  82   font-family: sans-serif;\r
  83   font-size: small;\r
  84   border-top: 2px solid silver;\r
  85   padding-top: 0.5em;\r
  86   margin-top: 4.0em;\r
  87 }\r
  88 div#footer-text {\r
  89   float: left;\r
  90   padding-bottom: 0.5em;\r
  91 }\r
  92 div#footer-badges {\r
  93   float: right;\r
  94   padding-bottom: 0.5em;\r
  95 }\r
  96 \r
  97 div#preamble,\r
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
 100 div.admonitionblock {\r
 101   margin-right: 10%;\r
 102   margin-top: 1.5em;\r
 103   margin-bottom: 1.5em;\r
 104 }\r
 105 div.admonitionblock {\r
 106   margin-top: 2.5em;\r
 107   margin-bottom: 2.5em;\r
 108 }\r
 109 \r
 110 div.content { /* Block element content. */\r
 111   padding: 0;\r
 112 }\r
 113 \r
 114 /* Block element titles. */\r
 115 div.title, caption.title {\r
 116   font-family: sans-serif;\r
 117   font-weight: bold;\r
 118   text-align: left;\r
 119   margin-top: 1.0em;\r
 120   margin-bottom: 0.5em;\r
 121 }\r
 122 div.title + * {\r
 123   margin-top: 0;\r
 124 }\r
 125 \r
 126 td div.title:first-child {\r
 127   margin-top: 0.0em;\r
 128 }\r
 129 div.content div.title:first-child {\r
 130   margin-top: 0.0em;\r
 131 }\r
 132 div.content + div.title {\r
 133   margin-top: 0.0em;\r
 134 }\r
 135 \r
 136 div.sidebarblock > div.content {\r
 137   background: #ffffee;\r
 138   border: 1px solid silver;\r
 139   padding: 0.5em;\r
 140 }\r
 141 \r
 142 div.listingblock > div.content {\r
 143   border: 1px solid silver;\r
 144   background: #f4f4f4;\r
 145   padding: 0.5em;\r
 146 }\r
 147 \r
 148 div.quoteblock > div.content {\r
 149   padding-left: 2.0em;\r
 150 }\r
 151 div.quoteblock .attribution {\r
 152   text-align: right;\r
 153 }\r
 154 \r
 155 div.admonitionblock .icon {\r
 156   vertical-align: top;\r
 157   font-size: 1.1em;\r
 158   font-weight: bold;\r
 159   text-decoration: underline;\r
 160   color: #527bbd;\r
 161   padding-right: 0.5em;\r
 162 }\r
 163 div.admonitionblock td.content {\r
 164   padding-left: 0.5em;\r
 165   border-left: 2px solid silver;\r
 166 }\r
 167 \r
 168 div.exampleblock > div.content {\r
 169   border-left: 2px solid silver;\r
 170   padding: 0.5em;\r
 171 }\r
 172 \r
 173 div.verseblock div.content {\r
 174   white-space: pre;\r
 175 }\r
 176 \r
 177 div.imageblock div.content { padding-left: 0; }\r
 178 div.imageblock img { border: 1px solid silver; }\r
 179 span.image img { border-style: none; }\r
 180 \r
 181 dl {\r
 182   margin-top: 0.8em;\r
 183   margin-bottom: 0.8em;\r
 184 }\r
 185 dt {\r
 186   margin-top: 0.5em;\r
 187   margin-bottom: 0;\r
 188   font-style: italic;\r
 189 }\r
 190 dd > *:first-child {\r
 191   margin-top: 0;\r
 192 }\r
 193 \r
 194 ul, ol {\r
 195     list-style-position: outside;\r
 196 }\r
 197 ol.olist2 {\r
 198   list-style-type: lower-alpha;\r
 199 }\r
 200 \r
 201 div.tableblock > table {\r
 202   border-color: #527bbd;\r
 203   border-width: 3px;\r
 204 }\r
 205 thead {\r
 206   font-family: sans-serif;\r
 207   font-weight: bold;\r
 208 }\r
 209 tfoot {\r
 210   font-weight: bold;\r
 211 }\r
 212 \r
 213 div.hlist {\r
 214   margin-top: 0.8em;\r
 215   margin-bottom: 0.8em;\r
 216 }\r
 217 td.hlist1 {\r
 218   vertical-align: top;\r
 219   font-style: italic;\r
 220   padding-right: 0.8em;\r
 221 }\r
 222 td.hlist2 {\r
 223   vertical-align: top;\r
 224 }\r
 225 \r
 226 @media print {\r
 227   div#footer-badges { display: none; }\r
 228 }\r
 229 include::./stylesheets/xhtml11-manpage.css[]\r
 230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
 231 \r
 232 div.sidebar-content {\r
 233   background: #ffffee;\r
 234   border: 1px solid silver;\r
 235   padding: 0.5em;\r
 236 }\r
 237 div.sidebar-title, div.image-title {\r
 238   font-family: sans-serif;\r
 239   font-weight: bold;\r
 240   margin-top: 0.0em;\r
 241   margin-bottom: 0.5em;\r
 242 }\r
 243 \r
 244 div.listingblock div.content {\r
 245   border: 1px solid silver;\r
 246   background: #f4f4f4;\r
 247   padding: 0.5em;\r
 248 }\r
 249 \r
 250 div.quoteblock-content {\r
 251   padding-left: 2.0em;\r
 252 }\r
 253 \r
 254 div.exampleblock-content {\r
 255   border-left: 2px solid silver;\r
 256   padding-left: 0.5em;\r
 257 }\r
 258 </style>\r
 259 <title>git-describe(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-describe(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-describe -\r
 269    Show the most recent tag that is reachable from a commit\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <p><em>git-describe</em> [--all] [--tags] [--abbrev=&lt;n&gt;] &lt;committish&gt;&#8230;</p>\r
 276 </div>\r
 277 <h2>DESCRIPTION</h2>\r
 278 <div class="sectionbody">\r
 279 <p>The command finds the most recent tag that is reachable from a\r
 280 commit, and if the commit itself is pointed at by the tag, shows\r
 281 the tag.  Otherwise, it suffixes the tag name with abbreviated\r
 282 object name of the commit.</p>\r
 283 </div>\r
 284 <h2>OPTIONS</h2>\r
 285 <div class="sectionbody">\r
 286 <dl>\r
 287 <dt>\r
 288 &lt;committish&gt;\r
 289 </dt>\r
 290 <dd>\r
 291 <p>\r
 292         The object name of the comittish.\r
 293 </p>\r
 294 </dd>\r
 295 <dt>\r
 296 --all\r
 297 </dt>\r
 298 <dd>\r
 299 <p>\r
 300         Instead of using only the annotated tags, use any ref\r
 301         found in <tt>.git/refs/</tt>.\r
 302 </p>\r
 303 </dd>\r
 304 <dt>\r
 305 --tags\r
 306 </dt>\r
 307 <dd>\r
 308 <p>\r
 309         Instead of using only the annotated tags, use any tag\r
 310         found in <tt>.git/refs/tags</tt>.\r
 311 </p>\r
 312 </dd>\r
 313 <dt>\r
 314 --abbrev=&lt;n&gt;\r
 315 </dt>\r
 316 <dd>\r
 317 <p>\r
 318         Instead of using the default 8 hexadecimal digits as the\r
 319         abbreviated object name, use &lt;n&gt; digits.\r
 320 </p>\r
 321 </dd>\r
 322 </dl>\r
 323 </div>\r
 324 <h2>EXAMPLES</h2>\r
 325 <div class="sectionbody">\r
 326 <p>With something like git.git current tree, I get:</p>\r
 327 <div class="literalblock">\r
 328 <div class="content">\r
 329 <pre><tt>[torvalds@g5 git]$ git-describe parent\r
 330 v1.0.4-g2414721b</tt></pre>\r
 331 </div></div>\r
 332 <p>i.e. the current head of my "parent" branch is based on v1.0.4,\r
 333 but since it has a few commits on top of that, it has added the\r
 334 git hash of the thing to the end: "-g" + 8-char shorthand for\r
 335 the commit <tt>2414721b194453f058079d897d13c4e377f92dc6</tt>.</p>\r
 336 <p>Doing a "git-describe" on a tag-name will just show the tag name:</p>\r
 337 <div class="literalblock">\r
 338 <div class="content">\r
 339 <pre><tt>[torvalds@g5 git]$ git-describe v1.0.4\r
 340 v1.0.4</tt></pre>\r
 341 </div></div>\r
 342 <p>With --all, the command can use branch heads as references, so\r
 343 the output shows the reference path as well:</p>\r
 344 <div class="literalblock">\r
 345 <div class="content">\r
 346 <pre><tt>[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2\r
 347 tags/v1.0.0-g975b</tt></pre>\r
 348 </div></div>\r
 349 <div class="literalblock">\r
 350 <div class="content">\r
 351 <pre><tt>[torvalds@g5 git]$ git describe --all HEAD^\r
 352 heads/lt/describe-g975b</tt></pre>\r
 353 </div></div>\r
 354 </div>\r
 355 <h2>Author</h2>\r
 356 <div class="sectionbody">\r
 357 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;, but somewhat\r
 358 butchered by Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
 359 </div>\r
 360 <h2>Documentation</h2>\r
 361 <div class="sectionbody">\r
 362 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 363 </div>\r
 364 <h2>GIT</h2>\r
 365 <div class="sectionbody">\r
 366 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 367 </div>\r
 368 <div id="footer">\r
 369 <div id="footer-text">\r
 370 Last updated 10-Mar-2006 00:31:24 UTC\r
 371 </div>\r
 372 </div>\r
 373 </body>\r
 374 </html>\r