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">
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">
9 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
11 border: 1px solid red;
16 margin: 1em 5% 1em 5%;
21 text-decoration: underline
;
39 h1
, h2
, h3
, h4
, h5
, h6
{
41 font-family: sans-serif
;
48 border-bottom: 2px solid silver
;
66 border: 1px solid silver
;
81 font-family: sans-serif
;
88 font-family: sans-serif
;
92 font-family: sans-serif
;
94 border-top: 2px solid silver
;
100 padding-bottom: 0.5em;
104 padding-bottom: 0.5em;
108 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
109 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
110 div
.admonitionblock
{
113 margin-bottom: 1.5em;
115 div
.admonitionblock
{
117 margin-bottom: 2.5em;
120 div
.content
{ /* Block element content. */
124 /* Block element titles. */
125 div
.title
, caption
.title
{
126 font-family: sans-serif
;
130 margin-bottom: 0.5em;
136 td div
.title:first-child
{
139 div
.content div
.title:first-child
{
142 div
.content
+ div
.title
{
146 div
.sidebarblock
> div
.content
{
148 border: 1px solid silver
;
155 div
.listingblock
> div
.content
{
156 border: 1px solid silver
;
161 div
.quoteblock
> div
.content
{
168 div
.verseblock
+ div
.attribution
{
172 div
.admonitionblock
.icon
{
176 text-decoration: underline
;
178 padding-right: 0.5em;
180 div
.admonitionblock td
.content
{
182 border-left: 2px solid silver
;
185 div
.exampleblock
> div
.content
{
186 border-left: 2px solid silver
;
190 div
.verseblock div
.content
{
194 div
.imageblock div
.content
{ padding-left: 0; }
195 div
.imageblock img
{ border: 1px solid silver
; }
196 span
.image img
{ border-style: none
; }
200 margin-bottom: 0.8em;
212 list-style-position: outside
;
215 list-style-type: lower-alpha
;
218 div
.tableblock
> table
{
219 border: 3px solid
#527bbd;
222 font-family: sans-serif
;
231 margin-bottom: 0.8em;
239 padding-right: 0.8em;
246 div#footer-badges
{ display: none
; }
251 font-family: sans-serif
;
255 margin-bottom: 0.1em;
258 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
274 include1::./stylesheets
/xhtml11-manpage
.css
[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div
.sidebar-content
{
279 border: 1px solid silver
;
282 div
.sidebar-title
, div
.image-title
{
283 font-family: sans-serif
;
286 margin-bottom: 0.5em;
289 div
.listingblock div
.content
{
290 border: 1px solid silver
;
295 div
.quoteblock-content
{
299 div
.exampleblock-content
{
300 border-left: 2px solid silver
;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc
a:visited
{ color: blue
; }
307 <title>git-notes(
1)
</title>
312 git-notes(
1) Manual Page
315 <div class=
"sectionbody">
317 Add or inspect object notes
322 <div class=
"sectionbody">
323 <div class=
"verseblock">
324 <div class=
"content"><em>git notes
</em> [list [
<object
>]]
325 <em>git notes
</em> add [-f] [-F
<file
> | -m
<msg
> | (-c | -C)
<object
>] [
<object
>]
326 <em>git notes
</em> copy [-f] ( --stdin |
<from-object
> <to-object
> )
327 <em>git notes
</em> append [-F
<file
> | -m
<msg
> | (-c | -C)
<object
>] [
<object
>]
328 <em>git notes
</em> edit [
<object
>]
329 <em>git notes
</em> show [
<object
>]
330 <em>git notes
</em> remove [
<object
>]
331 <em>git notes
</em> prune [-n | -v]
</div></div>
333 <h2 id=
"_description">DESCRIPTION
</h2>
334 <div class=
"sectionbody">
335 <div class=
"para"><p>Adds, removes, or reads notes attached to objects, without touching
336 the objects themselves.
</p></div>
337 <div class=
"para"><p>By default, notes are saved to and read from
<tt>refs/notes/commits
</tt>, but
338 this default can be overridden. See the OPTIONS, CONFIGURATION, and
339 ENVIRONMENT sections below. If this ref does not exist, it will be
340 quietly created when it is first needed to store a note.
</p></div>
341 <div class=
"para"><p>A typical use of notes is to supplement a commit message without
342 changing the commit itself. Notes can be shown by
<em>git log
</em> along with
343 the original commit message. To distinguish these notes from the
344 message stored in the commit object, the notes are indented like the
345 message, after an unindented line saying
"Notes (<refname>):" (or
346 "Notes:" for
<tt>refs/notes/commits
</tt>).
</p></div>
347 <div class=
"para"><p>To change which notes are shown by
<em>git log
</em>, see the
348 "notes.displayRef" configuration in
<a href=
"git-log.html">git-log(
1)
</a>.
</p></div>
349 <div class=
"para"><p>See the
"notes.rewrite.<command>" configuration for a way to carry
350 notes across commands that rewrite commits.
</p></div>
352 <h2 id=
"_subcommands">SUBCOMMANDS
</h2>
353 <div class=
"sectionbody">
354 <div class=
"vlist"><dl>
360 List the notes object for a given object. If no object is
361 given, show a list of all note objects and the objects they
362 annotate (in the format
"<note object> <annotated object>").
363 This is the default subcommand if no subcommand is given.
371 Add notes for a given object (defaults to HEAD). Abort if the
372 object already has notes (use
<tt>-f
</tt> to overwrite an
381 Copy the notes for the first object onto the second object.
382 Abort if the second object already has notes, or if the first
383 object has none (use -f to overwrite existing notes to the
384 second object). This subcommand is equivalent to:
385 <tt>git notes add [-f] -C $(git notes list
<from-object
>)
<to-object
></tt>
387 <div class=
"para"><p>In
<tt>--stdin
</tt> mode, take lines in the format
</p></div>
388 <div class=
"listingblock">
389 <div class=
"content">
390 <pre><tt><from-object
> SP
<to-object
> [ SP
<rest
> ] LF
</tt></pre>
392 <div class=
"para"><p>on standard input, and copy the notes from each
<from-object
> to its
393 corresponding
<to-object
>. (The optional
<tt><rest
></tt> is ignored so that
394 the command can read the input given to the
<tt>post-rewrite
</tt> hook.)
</p></div>
401 Append to the notes of an existing object (defaults to HEAD).
402 Creates a new notes object if needed.
410 Edit the notes for a given object (defaults to HEAD).
418 Show the notes for a given object (defaults to HEAD).
426 Remove the notes for a given object (defaults to HEAD).
427 This is equivalent to specifying an empty note message to
428 the
<tt>edit
</tt> subcommand.
436 Remove all notes for non-existing/unreachable objects.
441 <h2 id=
"_options">OPTIONS
</h2>
442 <div class=
"sectionbody">
443 <div class=
"vlist"><dl>
452 When adding notes to an object that already has notes,
453 overwrite the existing notes (instead of aborting).
460 --message=
<msg
>
464 Use the given note message (instead of prompting).
465 If multiple
<tt>-m
</tt> options are given, their values
466 are concatenated as separate paragraphs.
467 Lines starting with
<tt>#
</tt> and empty lines other than a
468 single line between paragraphs will be stripped out.
479 Take the note message from the given file. Use
<em>-
</em> to
480 read the note message from the standard input.
481 Lines starting with
<tt>#
</tt> and empty lines other than a
482 single line between paragraphs will be stripped out.
489 --reuse-message=
<object
>
493 Take the note message from the given blob object (for
494 example, another note).
501 --reedit-message=
<object
>
505 Like
<em>-C
</em>, but with
<em>-c
</em> the editor is invoked, so that
506 the user can further edit the note message.
514 Manipulate the notes tree in
<ref
>. This overrides
515 <em>GIT_NOTES_REF
</em> and the
"core.notesRef" configuration. The ref
516 is taken to be in
<tt>refs/notes/
</tt> if it is not qualified.
527 Do not remove anything; just report the object names whose notes
539 Report all object names whose notes are removed.
544 <h2 id=
"_discussion">DISCUSSION
</h2>
545 <div class=
"sectionbody">
546 <div class=
"para"><p>Commit notes are blobs containing extra information about an object
547 (usually information to supplement a commit's message). These blobs
548 are taken from notes refs. A notes ref is usually a branch which
549 contains
"files" whose paths are the object names for the objects
550 they describe, with some directory separators included for performance
551 reasons
<br />[Permitted pathnames have the form
552 <em>ab
</em><tt>/
</tt><em>cd
</em><tt>/
</tt><em>ef
</em><tt>/
</tt><em>…</em><tt>/
</tt><em>abcdef
…</em>: a sequence of directory
553 names of two hexadecimal digits each followed by a filename with the
554 rest of the object ID.]
<br />.
</p></div>
555 <div class=
"para"><p>Every notes change creates a new commit at the specified notes ref.
556 You can therefore inspect the history of the notes by invoking, e.g.,
557 <tt>git log -p notes/commits
</tt>. Currently the commit message only records
558 which operation triggered the update, and the commit authorship is
559 determined according to the usual rules (see
<a href=
"git-commit.html">git-commit(
1)
</a>).
560 These details may change in the future.
</p></div>
561 <div class=
"para"><p>It is also permitted for a notes ref to point directly to a tree
562 object, in which case the history of the notes can be read with
563 <tt>git log -p -g
<refname
></tt>.
</p></div>
565 <h2 id=
"_examples">EXAMPLES
</h2>
566 <div class=
"sectionbody">
567 <div class=
"para"><p>You can use notes to add annotations with information that was not
568 available at the time a commit was written.
</p></div>
569 <div class=
"listingblock">
570 <div class=
"content">
571 <pre><tt>$ git notes add -m 'Tested-by: Johannes Sixt
<j6t@kdbg.org
>'
72a144e2
572 $ git show -s
72a144e
574 Signed-off-by: Junio C Hamano
<gitster@pobox.com
>
577 Tested-by: Johannes Sixt
<j6t@kdbg.org
></tt></pre>
579 <div class=
"para"><p>In principle, a note is a regular Git blob, and any kind of
580 (non-)format is accepted. You can binary-safely create notes from
581 arbitrary files using
<em>git hash-object
</em>:
</p></div>
582 <div class=
"listingblock">
583 <div class=
"content">
585 $ blob=$(git hash-object -w a.out)
586 $ git notes --ref=built add -C
"$blob" HEAD
</tt></pre>
588 <div class=
"para"><p>Of course, it doesn't make much sense to display non-text-format notes
589 with
<em>git log
</em>, so if you use such notes, you'll probably need to write
590 some special-purpose tools to do something useful with them.
</p></div>
592 <h2 id=
"_configuration">CONFIGURATION
</h2>
593 <div class=
"sectionbody">
594 <div class=
"vlist"><dl>
600 Notes ref to read and manipulate instead of
601 <tt>refs/notes/commits
</tt>. Must be an unabbreviated ref name.
602 This setting can be overridden through the environment and
611 Which ref (or refs, if a glob or specified more than once), in
612 addition to the default set by
<tt>core.notesRef
</tt> or
613 <em>GIT_NOTES_REF
</em>, to read notes from when showing commit
614 messages with the
<em>git log
</em> family of commands.
615 This setting can be overridden on the command line or by the
616 <em>GIT_NOTES_DISPLAY_REF
</em> environment variable.
617 See
<a href=
"git-log.html">git-log(
1)
</a>.
621 notes.rewrite.
<command
>
625 When rewriting commits with
<command
> (currently
<tt>amend
</tt> or
626 <tt>rebase
</tt>), if this variable is
<tt>false
</tt>, git will not copy
627 notes from the original to the rewritten commit. Defaults to
628 <tt>true
</tt>. See also
"<tt>notes.rewriteRef</tt>" below.
630 <div class=
"para"><p>This setting can be overridden by the
<em>GIT_NOTES_REWRITE_REF
</em>
631 environment variable.
</p></div>
638 When copying notes during a rewrite, what to do if the target
639 commit already has a note. Must be one of
<tt>overwrite
</tt>,
640 <tt>concatenate
</tt>, and
<tt>ignore
</tt>. Defaults to
<tt>concatenate
</tt>.
642 <div class=
"para"><p>This setting can be overridden with the
<tt>GIT_NOTES_REWRITE_MODE
</tt>
643 environment variable.
</p></div>
650 When copying notes during a rewrite, specifies the (fully
651 qualified) ref whose notes should be copied. May be a glob,
652 in which case notes in all matching refs will be copied. You
653 may also specify this configuration several times.
655 <div class=
"para"><p>Does not have a default value; you must configure this variable to
656 enable note rewriting.
</p></div>
657 <div class=
"para"><p>Can be overridden with the
<em>GIT_NOTES_REWRITE_REF
</em> environment variable.
</p></div>
661 <h2 id=
"_environment">ENVIRONMENT
</h2>
662 <div class=
"sectionbody">
663 <div class=
"vlist"><dl>
665 <em>GIT_NOTES_REF
</em>
669 Which ref to manipulate notes from, instead of
<tt>refs/notes/commits
</tt>.
670 This overrides the
<tt>core.notesRef
</tt> setting.
674 <em>GIT_NOTES_DISPLAY_REF
</em>
678 Colon-delimited list of refs or globs indicating which refs,
679 in addition to the default from
<tt>core.notesRef
</tt> or
680 <em>GIT_NOTES_REF
</em>, to read notes from when showing commit
682 This overrides the
<tt>notes.displayRef
</tt> setting.
684 <div class=
"para"><p>A warning will be issued for refs that do not exist, but a glob that
685 does not match any refs is silently ignored.
</p></div>
688 <em>GIT_NOTES_REWRITE_MODE
</em>
692 When copying notes during a rewrite, what to do if the target
693 commit already has a note.
694 Must be one of
<tt>overwrite
</tt>,
<tt>concatenate
</tt>, and
<tt>ignore
</tt>.
695 This overrides the
<tt>core.rewriteMode
</tt> setting.
699 <em>GIT_NOTES_REWRITE_REF
</em>
703 When rewriting commits, which notes to copy from the original
704 to the rewritten commit. Must be a colon-delimited list of
707 <div class=
"para"><p>If not set in the environment, the list of notes to copy depends
708 on the
<tt>notes.rewrite.
<command
></tt> and
<tt>notes.rewriteRef
</tt> settings.
</p></div>
712 <h2 id=
"_author">Author
</h2>
713 <div class=
"sectionbody">
714 <div class=
"para"><p>Written by Johannes Schindelin
<johannes.schindelin@gmx.de
> and
715 Johan Herland
<johan@herland.net
></p></div>
717 <h2 id=
"_documentation">Documentation
</h2>
718 <div class=
"sectionbody">
719 <div class=
"para"><p>Documentation by Johannes Schindelin and Johan Herland
</p></div>
721 <h2 id=
"_git">GIT
</h2>
722 <div class=
"sectionbody">
723 <div class=
"para"><p>Part of the
<a href=
"git.html">git(
7)
</a> suite
</p></div>
726 <div id=
"footer-text">
727 Last updated
2010-
09-
03 21:
30:
24 UTC