git-notes.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-notes(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-notes(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-notes -
 317    Add/inspect object notes
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="verseblock">
 324 <div class="content"><em>git notes</em> [list [&lt;object&gt;]]
 325 <em>git notes</em> add [-f] [-F &lt;file&gt; | -m &lt;msg&gt; | (-c | -C) &lt;object&gt;] [&lt;object&gt;]
 326 <em>git notes</em> copy [-f] ( --stdin | &lt;from-object&gt; &lt;to-object&gt; )
 327 <em>git notes</em> append [-F &lt;file&gt; | -m &lt;msg&gt; | (-c | -C) &lt;object&gt;] [&lt;object&gt;]
 328 <em>git notes</em> edit [&lt;object&gt;]
 329 <em>git notes</em> show [&lt;object&gt;]
 330 <em>git notes</em> remove [&lt;object&gt;]
 331 <em>git notes</em> prune</div></div>
 332 </div>
 333 <h2 id="_description">DESCRIPTION</h2>
 334 <div class="sectionbody">
 335 <div class="para"><p>This command allows you to add/remove notes to/from objects, without
 336 changing the objects themselves.</p></div>
 337 <div class="para"><p>A typical use of notes is to extend a commit message without having
 338 to change the commit itself. Such commit notes can be shown by <tt>git log</tt>
 339 along with the original commit message. To discern these notes from the
 340 message stored in the commit object, the notes are indented like the
 341 message, after an unindented line saying "Notes (&lt;refname&gt;):" (or
 342 "Notes:" for the default setting).</p></div>
 343 <div class="para"><p>This command always manipulates the notes specified in "core.notesRef"
 344 (see <a href="git-config.html">git-config(1)</a>), which can be overridden by GIT_NOTES_REF.
 345 To change which notes are shown by <em>git-log</em>, see the
 346 "notes.displayRef" configuration.</p></div>
 347 <div class="para"><p>See the description of "notes.rewrite.&lt;command&gt;" in
 348 <a href="git-config.html">git-config(1)</a> for a way of carrying your notes across commands
 349 that rewrite commits.</p></div>
 350 </div>
 351 <h2 id="_subcommands">SUBCOMMANDS</h2>
 352 <div class="sectionbody">
 353 <div class="vlist"><dl>
 354 <dt>
 355 list
 356 </dt>
 357 <dd>
 358 <p>
 359         List the notes object for a given object. If no object is
 360         given, show a list of all note objects and the objects they
 361         annotate (in the format "&lt;note object&gt; &lt;annotated object&gt;").
 362         This is the default subcommand if no subcommand is given.
 363 </p>
 364 </dd>
 365 <dt>
 366 add
 367 </dt>
 368 <dd>
 369 <p>
 370         Add notes for a given object (defaults to HEAD). Abort if the
 371         object already has notes (use <tt>-f</tt> to overwrite an
 372         existing note).
 373 </p>
 374 </dd>
 375 <dt>
 376 copy
 377 </dt>
 378 <dd>
 379 <p>
 380         Copy the notes for the first object onto the second object.
 381         Abort if the second object already has notes, or if the first
 382         object has none (use -f to overwrite existing notes to the
 383         second object). This subcommand is equivalent to:
 384         <tt>git notes add [-f] -C $(git notes list &lt;from-object&gt;) &lt;to-object&gt;</tt>
 385 </p>
 386 <div class="para"><p>In <tt>--stdin</tt> mode, take lines in the format</p></div>
 387 <div class="listingblock">
 388 <div class="content">
 389 <pre><tt>&lt;from-object&gt; SP &lt;to-object&gt; [ SP &lt;rest&gt; ] LF</tt></pre>
 390 </div></div>
 391 <div class="para"><p>on standard input, and copy the notes from each &lt;from-object&gt; to its
 392 corresponding &lt;to-object&gt;.  (The optional <tt>&lt;rest&gt;</tt> is ignored so that
 393 the command can read the input given to the <tt>post-rewrite</tt> hook.)</p></div>
 394 </dd>
 395 <dt>
 396 append
 397 </dt>
 398 <dd>
 399 <p>
 400         Append to the notes of an existing object (defaults to HEAD).
 401         Creates a new notes object if needed.
 402 </p>
 403 </dd>
 404 <dt>
 405 edit
 406 </dt>
 407 <dd>
 408 <p>
 409         Edit the notes for a given object (defaults to HEAD).
 410 </p>
 411 </dd>
 412 <dt>
 413 show
 414 </dt>
 415 <dd>
 416 <p>
 417         Show the notes for a given object (defaults to HEAD).
 418 </p>
 419 </dd>
 420 <dt>
 421 remove
 422 </dt>
 423 <dd>
 424 <p>
 425         Remove the notes for a given object (defaults to HEAD).
 426         This is equivalent to specifying an empty note message to
 427         the <tt>edit</tt> subcommand.
 428 </p>
 429 </dd>
 430 <dt>
 431 prune
 432 </dt>
 433 <dd>
 434 <p>
 435         Remove all notes for non-existing/unreachable objects.
 436 </p>
 437 </dd>
 438 </dl></div>
 439 </div>
 440 <h2 id="_options">OPTIONS</h2>
 441 <div class="sectionbody">
 442 <div class="vlist"><dl>
 443 <dt>
 444 -f
 445 </dt>
 446 <dt>
 447 --force
 448 </dt>
 449 <dd>
 450 <p>
 451         When adding notes to an object that already has notes,
 452         overwrite the existing notes (instead of aborting).
 453 </p>
 454 </dd>
 455 <dt>
 456 -m &lt;msg&gt;
 457 </dt>
 458 <dt>
 459 --message=&lt;msg&gt;
 460 </dt>
 461 <dd>
 462 <p>
 463         Use the given note message (instead of prompting).
 464         If multiple <tt>-m</tt> options are given, their values
 465         are concatenated as separate paragraphs.
 466 </p>
 467 </dd>
 468 <dt>
 469 -F &lt;file&gt;
 470 </dt>
 471 <dt>
 472 --file=&lt;file&gt;
 473 </dt>
 474 <dd>
 475 <p>
 476         Take the note message from the given file.  Use <em>-</em> to
 477         read the note message from the standard input.
 478 </p>
 479 </dd>
 480 <dt>
 481 -C &lt;object&gt;
 482 </dt>
 483 <dt>
 484 --reuse-message=&lt;object&gt;
 485 </dt>
 486 <dd>
 487 <p>
 488         Reuse the note message from the given note object.
 489 </p>
 490 </dd>
 491 <dt>
 492 -c &lt;object&gt;
 493 </dt>
 494 <dt>
 495 --reedit-message=&lt;object&gt;
 496 </dt>
 497 <dd>
 498 <p>
 499         Like <em>-C</em>, but with <em>-c</em> the editor is invoked, so that
 500         the user can further edit the note message.
 501 </p>
 502 </dd>
 503 <dt>
 504 --ref &lt;ref&gt;
 505 </dt>
 506 <dd>
 507 <p>
 508         Manipulate the notes tree in &lt;ref&gt;.  This overrides both
 509         GIT_NOTES_REF and the "core.notesRef" configuration.  The ref
 510         is taken to be in <tt>refs/notes/</tt> if it is not qualified.
 511 </p>
 512 </dd>
 513 </dl></div>
 514 </div>
 515 <h2 id="_notes">NOTES</h2>
 516 <div class="sectionbody">
 517 <div class="para"><p>Every notes change creates a new commit at the specified notes ref.
 518 You can therefore inspect the history of the notes by invoking, e.g.,
 519 <tt>git log -p notes/commits</tt>.</p></div>
 520 <div class="para"><p>Currently the commit message only records which operation triggered
 521 the update, and the commit authorship is determined according to the
 522 usual rules (see <a href="git-commit.html">git-commit(1)</a>).  These details may change in
 523 the future.</p></div>
 524 </div>
 525 <h2 id="_author">Author</h2>
 526 <div class="sectionbody">
 527 <div class="para"><p>Written by Johannes Schindelin &lt;johannes.schindelin@gmx.de&gt; and
 528 Johan Herland &lt;johan@herland.net&gt;</p></div>
 529 </div>
 530 <h2 id="_documentation">Documentation</h2>
 531 <div class="sectionbody">
 532 <div class="para"><p>Documentation by Johannes Schindelin and Johan Herland</p></div>
 533 </div>
 534 <h2 id="_git">GIT</h2>
 535 <div class="sectionbody">
 536 <div class="para"><p>Part of the <a href="git.html">git(7)</a> suite</p></div>
 537 </div>
 538 <div id="footer">
 539 <div id="footer-text">
 540 Last updated 2010-04-24 02:56:02 UTC
 541 </div>
 542 </div>
 543 </body>
 544 </html>