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/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
</div></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 (<refname>):" (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.<command>" 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>
351 <h2 id=
"_subcommands">SUBCOMMANDS
</h2>
352 <div class=
"sectionbody">
353 <div class=
"vlist"><dl>
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
"<note object> <annotated object>").
362 This is the default subcommand if no subcommand is given.
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
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
<from-object
>)
<to-object
></tt>
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><from-object
> SP
<to-object
> [ SP
<rest
> ] LF
</tt></pre>
391 <div class=
"para"><p>on standard input, and copy the notes from each
<from-object
> to its
392 corresponding
<to-object
>. (The optional
<tt><rest
></tt> is ignored so that
393 the command can read the input given to the
<tt>post-rewrite
</tt> hook.)
</p></div>
400 Append to the notes of an existing object (defaults to HEAD).
401 Creates a new notes object if needed.
409 Edit the notes for a given object (defaults to HEAD).
417 Show the notes for a given object (defaults to HEAD).
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.
435 Remove all notes for non-existing/unreachable objects.
440 <h2 id=
"_options">OPTIONS
</h2>
441 <div class=
"sectionbody">
442 <div class=
"vlist"><dl>
451 When adding notes to an object that already has notes,
452 overwrite the existing notes (instead of aborting).
459 --message=
<msg
>
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.
476 Take the note message from the given file. Use
<em>-
</em> to
477 read the note message from the standard input.
484 --reuse-message=
<object
>
488 Reuse the note message from the given note object.
495 --reedit-message=
<object
>
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.
508 Manipulate the notes tree in
<ref
>. 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.
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>
525 <h2 id=
"_author">Author
</h2>
526 <div class=
"sectionbody">
527 <div class=
"para"><p>Written by Johannes Schindelin
<johannes.schindelin@gmx.de
> and
528 Johan Herland
<johan@herland.net
></p></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>
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>
539 <div id=
"footer-text">
540 Last updated
2010-
04-
24 02:
56:
02 UTC