| blob | 850dff9be6fc286e2492da17030a36c60ff1bfa6 |
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
473 existing note).
474 </p>
475 </dd>
477 copy
478 </dt>
479 <dd>
480 <p>
481 Copy the notes for the first object onto the second object.
482 Abort if the second object already has notes, or if the first
483 object has none (use -f to overwrite existing notes to the
484 second object). This subcommand is equivalent to:
486 </p>
491 </div></div>
492 <div class="paragraph"><p>on standard input, and copy the notes from each <from-object> to its
495 </dd>
497 append
498 </dt>
499 <dd>
500 <p>
501 Append to the notes of an existing object (defaults to HEAD).
502 Creates a new notes object if needed.
503 </p>
504 </dd>
506 edit
507 </dt>
508 <dd>
509 <p>
510 Edit the notes for a given object (defaults to HEAD).
511 </p>
512 </dd>
514 show
515 </dt>
516 <dd>
517 <p>
518 Show the notes for a given object (defaults to HEAD).
519 </p>
520 </dd>
522 merge
523 </dt>
524 <dd>
525 <p>
526 Merge the given notes ref into the current notes ref.
527 This will try to merge the changes made by the given
528 notes ref (called "remote") since the merge-base (if
529 any) into the current notes ref (called "local").
530 </p>
532 conflicting notes (see the -s/--strategy option) is not given,
533 the "manual" resolver is used. This resolver checks out the
535 and instructs the user to manually resolve the conflicts there.
536 When done, the user can either finalize the merge with
539 </dd>
541 remove
542 </dt>
543 <dd>
544 <p>
545 Remove the notes for a given object (defaults to HEAD).
546 This is equivalent to specifying an empty note message to
548 </p>
549 </dd>
551 prune
552 </dt>
553 <dd>
554 <p>
555 Remove all notes for non-existing/unreachable objects.
556 </p>
557 </dd>
559 get-ref
560 </dt>
561 <dd>
562 <p>
563 Print the current notes ref. This provides an easy way to
564 retrieve the current notes ref (e.g. from scripts).
565 </p>
566 </dd>
567 </dl></div>
568 </div>
573 -f
574 </dt>
576 --force
577 </dt>
578 <dd>
579 <p>
580 When adding notes to an object that already has notes,
581 overwrite the existing notes (instead of aborting).
582 </p>
583 </dd>
586 </dt>
589 </dt>
590 <dd>
591 <p>
592 Use the given note message (instead of prompting).
594 are concatenated as separate paragraphs.
596 single line between paragraphs will be stripped out.
597 </p>
598 </dd>
601 </dt>
604 </dt>
605 <dd>
606 <p>
608 read the note message from the standard input.
610 single line between paragraphs will be stripped out.
611 </p>
612 </dd>
615 </dt>
618 </dt>
619 <dd>
620 <p>
621 Take the note message from the given blob object (for
622 example, another note).
623 </p>
624 </dd>
627 </dt>
630 </dt>
631 <dd>
632 <p>
634 the user can further edit the note message.
635 </p>
636 </dd>
639 </dt>
640 <dd>
641 <p>
645 </p>
646 </dd>
648 -n
649 </dt>
651 --dry-run
652 </dt>
653 <dd>
654 <p>
655 Do not remove anything; just report the object names whose notes
656 would be removed.
657 </p>
658 </dd>
661 </dt>
664 </dt>
665 <dd>
666 <p>
667 When merging notes, resolve notes conflicts using the given
668 strategy. The following strategies are recognized: "manual"
670 See the "NOTES MERGE STRATEGIES" section below for more
671 information on each notes merge strategy.
672 </p>
673 </dd>
675 --commit
676 </dt>
677 <dd>
678 <p>
681 stored in .git/NOTES_MERGE_WORKTREE. This amends the partial
683 .git/NOTES_MERGE_PARTIAL) by adding the notes in
684 .git/NOTES_MERGE_WORKTREE. The notes ref stored in the
685 .git/NOTES_MERGE_REF symref is updated to the resulting commit.
686 </p>
687 </dd>
689 --abort
690 </dt>
691 <dd>
692 <p>
694 with conflicts. This simply removes all files related to the
695 notes merge.
696 </p>
697 </dd>
699 -q
700 </dt>
702 --quiet
703 </dt>
704 <dd>
705 <p>
706 When merging notes, operate quietly.
707 </p>
708 </dd>
710 -v
711 </dt>
713 --verbose
714 </dt>
715 <dd>
716 <p>
717 When merging notes, be more verbose.
718 When pruning notes, report all object names whose notes are
719 removed.
720 </p>
721 </dd>
722 </dl></div>
723 </div>
727 (usually information to supplement a commit’s message). These blobs
728 are taken from notes refs. A notes ref is usually a branch which
729 contains "files" whose paths are the object names for the objects
730 they describe, with some directory separators included for performance
731 reasons <br />[Permitted pathnames have the form
732 <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
733 names of two hexadecimal digits each followed by a filename with the
736 You can therefore inspect the history of the notes by invoking, e.g.,
738 which operation triggered the update, and the commit authorship is
740 These details may change in the future.</p></div>
742 object, in which case the history of the notes can be read with
744 </div>
748 conflicting notes in a special work tree for resolving notes conflicts
750 conflicts in that work tree.
751 When done, the user can either finalize the merge with
755 version (i.e. the current notes ref).</p></div>
756 <div class="paragraph"><p>"theirs" automatically resolves notes conflicts in favor of the remote
757 version (i.e. the given notes ref being merged into the current notes
758 ref).</p></div>
760 local and remote versions.</p></div>
761 <div class="paragraph"><p>"cat_sort_uniq" is similar to "union", but in addition to concatenating
762 the local and remote versions, this strategy also sorts the resulting
763 lines, and removes duplicate lines from the result. This is equivalent
764 to applying the "cat | sort | uniq" shell pipeline to the local and
765 remote versions. This strategy is useful if the notes follow a line-based
766 format where one wants to avoid duplicated lines in the merge result.
767 Note that if either the local or remote version contain duplicate lines
768 prior to the merge, these will also be removed by this notes merge
769 strategy.</p></div>
770 </div>
774 available at the time a commit was written.</p></div>
778 $ git show -s 72a144e
779 [...]
782 Notes:
784 </div></div>
786 (non-)format is accepted. You can binary-safely create notes from
790 <pre><tt>$ cc *.c
791 $ blob=$(git hash-object -w a.out)
793 </div></div>
794 <div class="paragraph"><p>Of course, it doesn’t make much sense to display non-text-format notes
796 some special-purpose tools to do something useful with them.</p></div>
797 </div>
802 core.notesRef
803 </dt>
804 <dd>
805 <p>
806 Notes ref to read and manipulate instead of
808 This setting can be overridden through the environment and
809 command line.
810 </p>
811 </dd>
813 notes.displayRef
814 </dt>
815 <dd>
816 <p>
817 Which ref (or refs, if a glob or specified more than once), in
821 This setting can be overridden on the command line or by the
824 </p>
825 </dd>
828 </dt>
829 <dd>
830 <p>
833 notes from the original to the rewritten commit. Defaults to
835 </p>
837 environment variable.</p></div>
838 </dd>
840 notes.rewriteMode
841 </dt>
842 <dd>
843 <p>
844 When copying notes during a rewrite, what to do if the target
847 </p>
848 <div class="paragraph"><p>This setting can be overridden with the <tt>GIT_NOTES_REWRITE_MODE</tt>
849 environment variable.</p></div>
850 </dd>
852 notes.rewriteRef
853 </dt>
854 <dd>
855 <p>
856 When copying notes during a rewrite, specifies the (fully
857 qualified) ref whose notes should be copied. May be a glob,
858 in which case notes in all matching refs will be copied. You
859 may also specify this configuration several times.
860 </p>
862 enable note rewriting.</p></div>
863 <div class="paragraph"><p>Can be overridden with the <em>GIT_NOTES_REWRITE_REF</em> environment variable.</p></div>
864 </dd>
865 </dl></div>
866 </div>
872 </dt>
873 <dd>
874 <p>
877 </p>
878 </dd>
881 </dt>
882 <dd>
883 <p>
884 Colon-delimited list of refs or globs indicating which refs,
887 messages.
889 </p>
891 does not match any refs is silently ignored.</p></div>
892 </dd>
895 </dt>
896 <dd>
897 <p>
898 When copying notes during a rewrite, what to do if the target
899 commit already has a note.
902 </p>
903 </dd>
906 </dt>
907 <dd>
908 <p>
909 When rewriting commits, which notes to copy from the original
910 to the rewritten commit. Must be a colon-delimited list of
911 refs or globs.
912 </p>
915 </dd>
916 </dl></div>
917 </div>
920 <div class="paragraph"><p>Written by Johannes Schindelin <<a href="mailto:johannes.schindelin@gmx.de">johannes.schindelin@gmx.de</a>> and
922 </div>
926 </div>
930 </div>
934 </div>
935 </div>
936 </body>
937 </html>