git-name-rev.html

   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" />
   6 <meta name="generator" content="AsciiDoc 8.2.5" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-name-rev(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-name-rev(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-name-rev -
 317    Find symbolic names for given revs
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="verseblock">
 324 <div class="content"><em>git name-rev</em> [--tags] [--refs=&lt;pattern&gt;]
 325                ( --all | --stdin | &lt;committish&gt;&#8230; )</div></div>
 326 </div>
 327 <h2 id="_description">DESCRIPTION</h2>
 328 <div class="sectionbody">
 329 <div class="para"><p>Finds symbolic names suitable for human digestion for revisions given in any
 330 format parsable by <em>git rev-parse</em>.</p></div>
 331 </div>
 332 <h2 id="_options">OPTIONS</h2>
 333 <div class="sectionbody">
 334 <div class="vlist"><dl>
 335 <dt>
 336 --tags
 337 </dt>
 338 <dd>
 339 <p>
 340         Do not use branch names, but only tags to name the commits
 341 </p>
 342 </dd>
 343 <dt>
 344 --refs=&lt;pattern&gt;
 345 </dt>
 346 <dd>
 347 <p>
 348         Only use refs whose names match a given shell pattern.
 349 </p>
 350 </dd>
 351 <dt>
 352 --all
 353 </dt>
 354 <dd>
 355 <p>
 356         List all commits reachable from all refs
 357 </p>
 358 </dd>
 359 <dt>
 360 --stdin
 361 </dt>
 362 <dd>
 363 <p>
 364         Read from stdin, append "(&lt;rev_name&gt;)" to all sha1's of nameable
 365         commits, and pass to stdout
 366 </p>
 367 </dd>
 368 <dt>
 369 --name-only
 370 </dt>
 371 <dd>
 372 <p>
 373         Instead of printing both the SHA-1 and the name, print only
 374         the name.  If given with --tags the usual tag prefix of
 375         "tags/" is also omitted from the name, matching the output
 376         of <tt>git-describe</tt> more closely.
 377 </p>
 378 </dd>
 379 <dt>
 380 --no-undefined
 381 </dt>
 382 <dd>
 383 <p>
 384         Die with error code != 0 when a reference is undefined,
 385         instead of printing <tt>undefined</tt>.
 386 </p>
 387 </dd>
 388 <dt>
 389 --always
 390 </dt>
 391 <dd>
 392 <p>
 393         Show uniquely abbreviated commit object as fallback.
 394 </p>
 395 </dd>
 396 </dl></div>
 397 </div>
 398 <h2 id="_example">EXAMPLE</h2>
 399 <div class="sectionbody">
 400 <div class="para"><p>Given a commit, find out where it is relative to the local refs. Say somebody
 401 wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
 402 Of course, you look into the commit, but that only tells you what happened, but
 403 not the context.</p></div>
 404 <div class="para"><p>Enter <em>git name-rev</em>:</p></div>
 405 <div class="listingblock">
 406 <div class="content">
 407 <pre><tt>% git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
 408 33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0.99~940</tt></pre>
 409 </div></div>
 410 <div class="para"><p>Now you are wiser, because you know that it happened 940 revisions before v0.99.</p></div>
 411 <div class="para"><p>Another nice thing you can do is:</p></div>
 412 <div class="listingblock">
 413 <div class="content">
 414 <pre><tt>% git log | git name-rev --stdin</tt></pre>
 415 </div></div>
 416 </div>
 417 <h2 id="_author">Author</h2>
 418 <div class="sectionbody">
 419 <div class="para"><p>Written by Johannes Schindelin &lt;Johannes.Schindelin@gmx.de&gt;</p></div>
 420 </div>
 421 <h2 id="_documentation">Documentation</h2>
 422 <div class="sectionbody">
 423 <div class="para"><p>Documentation by Johannes Schindelin.</p></div>
 424 </div>
 425 <h2 id="_git">GIT</h2>
 426 <div class="sectionbody">
 427 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 428 </div>
 429 <div id="footer">
 430 <div id="footer-text">
 431 Last updated 2010-09-18 23:56:50 UTC
 432 </div>
 433 </div>
 434 </body>
 435 </html>