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]
<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:".
</p></div>
342 <div class=
"para"><p>To disable notes, you have to set the config variable core.notesRef to
343 the empty string. Alternatively, you can set it to a different ref,
344 something like
"refs/notes/bugzilla". This setting can be overridden
345 by the environment variable
"GIT_NOTES_REF".
</p></div>
347 <h2 id=
"_subcommands">SUBCOMMANDS
</h2>
348 <div class=
"sectionbody">
349 <div class=
"vlist"><dl>
355 List the notes object for a given object. If no object is
356 given, show a list of all note objects and the objects they
357 annotate (in the format
"<note object> <annotated object>").
358 This is the default subcommand if no subcommand is given.
366 Add notes for a given object (defaults to HEAD). Abort if the
367 object already has notes (use
<tt>-f
</tt> to overwrite an
376 Copy the notes for the first object onto the second object.
377 Abort if the second object already has notes, or if the first
378 object has none (use -f to overwrite existing notes to the
379 second object). This subcommand is equivalent to:
380 <tt>git notes add [-f] -C $(git notes list
<from-object
>)
<to-object
></tt>
388 Append to the notes of an existing object (defaults to HEAD).
389 Creates a new notes object if needed.
397 Edit the notes for a given object (defaults to HEAD).
405 Show the notes for a given object (defaults to HEAD).
413 Remove the notes for a given object (defaults to HEAD).
414 This is equivalent to specifying an empty note message to
415 the
<tt>edit
</tt> subcommand.
423 Remove all notes for non-existing/unreachable objects.
428 <h2 id=
"_options">OPTIONS
</h2>
429 <div class=
"sectionbody">
430 <div class=
"vlist"><dl>
439 When adding notes to an object that already has notes,
440 overwrite the existing notes (instead of aborting).
447 --message=
<msg
>
451 Use the given note message (instead of prompting).
452 If multiple
<tt>-m
</tt> options are given, their values
453 are concatenated as separate paragraphs.
464 Take the note message from the given file. Use
<em>-
</em> to
465 read the note message from the standard input.
472 --reuse-message=
<object
>
476 Reuse the note message from the given note object.
483 --reedit-message=
<object
>
487 Like
<em>-C
</em>, but with
<em>-c
</em> the editor is invoked, so that
488 the user can further edit the note message.
493 <h2 id=
"_author">Author
</h2>
494 <div class=
"sectionbody">
495 <div class=
"para"><p>Written by Johannes Schindelin
<johannes.schindelin@gmx.de
> and
496 Johan Herland
<johan@herland.net
></p></div>
498 <h2 id=
"_documentation">Documentation
</h2>
499 <div class=
"sectionbody">
500 <div class=
"para"><p>Documentation by Johannes Schindelin and Johan Herland
</p></div>
502 <h2 id=
"_git">GIT
</h2>
503 <div class=
"sectionbody">
504 <div class=
"para"><p>Part of the
<a href=
"git.html">git(
7)
</a> suite
</p></div>
507 <div id=
"footer-text">
508 Last updated
2010-
03-
15 20:
32:
31 UTC