| blob | 0eff85ea2ded92dfed34e5c44f1bd854ae3f0810 |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-notes(1) Manual Page
407 </h1>
410 <p>git-notes -
411 Add or inspect object notes
412 </p>
413 </div>
414 </div>
419 <em>git notes</em> add [-f] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
421 <em>git notes</em> append [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
431 </div></div>
432 </div>
436 the objects themselves.</p></div>
437 <div class="paragraph"><p>By default, notes are saved to and read from <tt>refs/notes/commits</tt>, but
438 this default can be overridden. See the OPTIONS, CONFIGURATION, and
439 ENVIRONMENT sections below. If this ref does not exist, it will be
440 quietly created when it is first needed to store a note.</p></div>
443 the original commit message. To distinguish these notes from the
444 message stored in the commit object, the notes are indented like the
445 message, after an unindented line saying "Notes (<refname>):" (or
449 <div class="paragraph"><p>See the "notes.rewrite.<command>" configuration for a way to carry
450 notes across commands that rewrite commits.</p></div>
451 </div>
456 list
457 </dt>
458 <dd>
459 <p>
460 List the notes object for a given object. If no object is
461 given, show a list of all note objects and the objects they
462 annotate (in the format "<note object> <annotated object>").
463 This is the default subcommand if no subcommand is given.
464 </p>
465 </dd>
467 add
468 </dt>
469 <dd>
470 <p>
471 Add notes for a given object (defaults to HEAD). Abort if the
474 to supply the notes contents), then - instead of aborting -
476 subcommand).
477 </p>
478 </dd>
480 copy
481 </dt>
482 <dd>
483 <p>
484 Copy the notes for the first object onto the second object.
485 Abort if the second object already has notes, or if the first
486 object has none (use -f to overwrite existing notes to the
487 second object). This subcommand is equivalent to:
489 </p>
494 </div></div>
495 <div class="paragraph"><p>on standard input, and copy the notes from each <from-object> to its
498 </dd>
500 append
501 </dt>
502 <dd>
503 <p>
504 Append to the notes of an existing object (defaults to HEAD).
505 Creates a new notes object if needed.
506 </p>
507 </dd>
509 edit
510 </dt>
511 <dd>
512 <p>
513 Edit the notes for a given object (defaults to HEAD).
514 </p>
515 </dd>
517 show
518 </dt>
519 <dd>
520 <p>
521 Show the notes for a given object (defaults to HEAD).
522 </p>
523 </dd>
525 merge
526 </dt>
527 <dd>
528 <p>
529 Merge the given notes ref into the current notes ref.
530 This will try to merge the changes made by the given
531 notes ref (called "remote") since the merge-base (if
532 any) into the current notes ref (called "local").
533 </p>
535 conflicting notes (see the -s/--strategy option) is not given,
536 the "manual" resolver is used. This resolver checks out the
538 and instructs the user to manually resolve the conflicts there.
539 When done, the user can either finalize the merge with
542 </dd>
544 remove
545 </dt>
546 <dd>
547 <p>
548 Remove the notes for given objects (defaults to HEAD). When
549 giving zero or one object from the command line, this is
550 equivalent to specifying an empty note message to
552 </p>
553 </dd>
555 prune
556 </dt>
557 <dd>
558 <p>
559 Remove all notes for non-existing/unreachable objects.
560 </p>
561 </dd>
563 get-ref
564 </dt>
565 <dd>
566 <p>
567 Print the current notes ref. This provides an easy way to
568 retrieve the current notes ref (e.g. from scripts).
569 </p>
570 </dd>
571 </dl></div>
572 </div>
577 -f
578 </dt>
580 --force
581 </dt>
582 <dd>
583 <p>
584 When adding notes to an object that already has notes,
585 overwrite the existing notes (instead of aborting).
586 </p>
587 </dd>
590 </dt>
593 </dt>
594 <dd>
595 <p>
596 Use the given note message (instead of prompting).
598 are concatenated as separate paragraphs.
600 single line between paragraphs will be stripped out.
601 </p>
602 </dd>
605 </dt>
608 </dt>
609 <dd>
610 <p>
612 read the note message from the standard input.
614 single line between paragraphs will be stripped out.
615 </p>
616 </dd>
619 </dt>
622 </dt>
623 <dd>
624 <p>
625 Take the note message from the given blob object (for
626 example, another note).
627 </p>
628 </dd>
631 </dt>
634 </dt>
635 <dd>
636 <p>
638 the user can further edit the note message.
639 </p>
640 </dd>
643 </dt>
644 <dd>
645 <p>
649 </p>
650 </dd>
652 --ignore-missing
653 </dt>
654 <dd>
655 <p>
656 Do not consider it an error to request removing notes from an
657 object that does not have notes attached to it.
658 </p>
659 </dd>
661 --stdin
662 </dt>
663 <dd>
664 <p>
665 Also read the object names to remove notes from from the standard
666 input (there is no reason you cannot combine this with object
667 names from the command line).
668 </p>
669 </dd>
671 -n
672 </dt>
674 --dry-run
675 </dt>
676 <dd>
677 <p>
678 Do not remove anything; just report the object names whose notes
679 would be removed.
680 </p>
681 </dd>
684 </dt>
687 </dt>
688 <dd>
689 <p>
690 When merging notes, resolve notes conflicts using the given
691 strategy. The following strategies are recognized: "manual"
693 See the "NOTES MERGE STRATEGIES" section below for more
694 information on each notes merge strategy.
695 </p>
696 </dd>
698 --commit
699 </dt>
700 <dd>
701 <p>
704 stored in .git/NOTES_MERGE_WORKTREE. This amends the partial
706 .git/NOTES_MERGE_PARTIAL) by adding the notes in
707 .git/NOTES_MERGE_WORKTREE. The notes ref stored in the
708 .git/NOTES_MERGE_REF symref is updated to the resulting commit.
709 </p>
710 </dd>
712 --abort
713 </dt>
714 <dd>
715 <p>
717 with conflicts. This simply removes all files related to the
718 notes merge.
719 </p>
720 </dd>
722 -q
723 </dt>
725 --quiet
726 </dt>
727 <dd>
728 <p>
729 When merging notes, operate quietly.
730 </p>
731 </dd>
733 -v
734 </dt>
736 --verbose
737 </dt>
738 <dd>
739 <p>
740 When merging notes, be more verbose.
741 When pruning notes, report all object names whose notes are
742 removed.
743 </p>
744 </dd>
745 </dl></div>
746 </div>
750 (usually information to supplement a commit’s message). These blobs
751 are taken from notes refs. A notes ref is usually a branch which
752 contains "files" whose paths are the object names for the objects
753 they describe, with some directory separators included for performance
754 reasons <br />[Permitted pathnames have the form
755 <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
756 names of two hexadecimal digits each followed by a filename with the
759 You can therefore inspect the history of the notes by invoking, e.g.,
761 which operation triggered the update, and the commit authorship is
763 These details may change in the future.</p></div>
765 object, in which case the history of the notes can be read with
767 </div>
771 conflicting notes in a special work tree for resolving notes conflicts
773 conflicts in that work tree.
774 When done, the user can either finalize the merge with
778 version (i.e. the current notes ref).</p></div>
779 <div class="paragraph"><p>"theirs" automatically resolves notes conflicts in favor of the remote
780 version (i.e. the given notes ref being merged into the current notes
781 ref).</p></div>
783 local and remote versions.</p></div>
784 <div class="paragraph"><p>"cat_sort_uniq" is similar to "union", but in addition to concatenating
785 the local and remote versions, this strategy also sorts the resulting
786 lines, and removes duplicate lines from the result. This is equivalent
787 to applying the "cat | sort | uniq" shell pipeline to the local and
788 remote versions. This strategy is useful if the notes follow a line-based
789 format where one wants to avoid duplicated lines in the merge result.
790 Note that if either the local or remote version contain duplicate lines
791 prior to the merge, these will also be removed by this notes merge
792 strategy.</p></div>
793 </div>
797 available at the time a commit was written.</p></div>
801 $ git show -s 72a144e
802 [...]
805 Notes:
807 </div></div>
809 (non-)format is accepted. You can binary-safely create notes from
813 <pre><tt>$ cc *.c
814 $ blob=$(git hash-object -w a.out)
816 </div></div>
817 <div class="paragraph"><p>Of course, it doesn’t make much sense to display non-text-format notes
819 some special-purpose tools to do something useful with them.</p></div>
820 </div>
825 core.notesRef
826 </dt>
827 <dd>
828 <p>
829 Notes ref to read and manipulate instead of
831 This setting can be overridden through the environment and
832 command line.
833 </p>
834 </dd>
836 notes.displayRef
837 </dt>
838 <dd>
839 <p>
840 Which ref (or refs, if a glob or specified more than once), in
844 This setting can be overridden on the command line or by the
847 </p>
848 </dd>
851 </dt>
852 <dd>
853 <p>
856 notes from the original to the rewritten commit. Defaults to
858 </p>
860 environment variable.</p></div>
861 </dd>
863 notes.rewriteMode
864 </dt>
865 <dd>
866 <p>
867 When copying notes during a rewrite, what to do if the target
870 </p>
871 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_MODE</tt>
872 environment variable.</p></div>
873 </dd>
875 notes.rewriteRef
876 </dt>
877 <dd>
878 <p>
879 When copying notes during a rewrite, specifies the (fully
880 qualified) ref whose notes should be copied. May be a glob,
881 in which case notes in all matching refs will be copied. You
882 may also specify this configuration several times.
883 </p>
885 enable note rewriting.</p></div>
886 <div class="paragraph"><p>Can be overridden with the <em>GIT_NOTES_REWRITE_REF</em> environment variable.</p></div>
887 </dd>
888 </dl></div>
889 </div>
895 </dt>
896 <dd>
897 <p>
900 </p>
901 </dd>
904 </dt>
905 <dd>
906 <p>
907 Colon-delimited list of refs or globs indicating which refs,
910 messages.
912 </p>
914 does not match any refs is silently ignored.</p></div>
915 </dd>
918 </dt>
919 <dd>
920 <p>
921 When copying notes during a rewrite, what to do if the target
922 commit already has a note.
925 </p>
926 </dd>
929 </dt>
930 <dd>
931 <p>
932 When rewriting commits, which notes to copy from the original
933 to the rewritten commit. Must be a colon-delimited list of
934 refs or globs.
935 </p>
938 </dd>
939 </dl></div>
940 </div>
943 <div class="paragraph"><p>Written by Johannes Schindelin <<a href="mailto:johannes.schindelin@gmx.de">johannes.schindelin@gmx.de</a>> and
945 </div>
949 </div>
953 </div>
957 </div>
958 </div>
959 </body>
960 </html>