1git-notes(1) 2============ 3 4NAME 5---- 6git-notes - Add/inspect object notes 7 8SYNOPSIS 9-------- 10[verse] 11'git notes' [list [<object>]] 12'git notes' add [-f] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>] 13'git notes' copy [-f] <from-object> <to-object> 14'git notes' append [-F <file> | -m <msg> | (-c | -C) <object>] [<object>] 15'git notes' edit [<object>] 16'git notes' show [<object>] 17'git notes' remove [<object>] 18'git notes' prune 19 20 21DESCRIPTION 22----------- 23This command allows you to add/remove notes to/from objects, without 24changing the objects themselves. 25 26A typical use of notes is to extend a commit message without having 27to change the commit itself. Such commit notes can be shown by `git log` 28along with the original commit message. To discern these notes from the 29message stored in the commit object, the notes are indented like the 30message, after an unindented line saying "Notes (<refname>):" (or 31"Notes:" for the default setting). 32 33This command always manipulates the notes specified in "core.notesRef" 34(see linkgit:git-config[1]), which can be overridden by GIT_NOTES_REF. 35To change which notes are shown by 'git-log', see the 36"notes.displayRef" configuration. 37 38 39SUBCOMMANDS 40----------- 41 42list:: 43 List the notes object for a given object. If no object is 44 given, show a list of all note objects and the objects they 45 annotate (in the format "<note object> <annotated object>"). 46 This is the default subcommand if no subcommand is given. 47 48add:: 49 Add notes for a given object (defaults to HEAD). Abort if the 50 object already has notes, abort. (use `-f` to overwrite an 51 existing note). 52 53copy:: 54 Copy the notes for the first object onto the second object. 55 Abort if the second object already has notes, or if the first 56 objects has none. (use -f to overwrite existing notes to the 57 second object). This subcommand is equivalent to: 58 `git notes add [-f] -C $(git notes list <from-object>) <to-object>` 59 60append:: 61 Append to the notes of an existing object (defaults to HEAD). 62 Creates a new notes object if needed. 63 64edit:: 65 Edit the notes for a given object (defaults to HEAD). 66 67show:: 68 Show the notes for a given object (defaults to HEAD). 69 70remove:: 71 Remove the notes for a given object (defaults to HEAD). 72 This is equivalent to specifying an empty note message to 73 the `edit` subcommand. 74 75prune:: 76 Remove all notes for non-existing/unreachable objects. 77 78OPTIONS 79------- 80-f:: 81--force:: 82 When adding notes to an object that already has notes, 83 overwrite the existing notes (instead of aborting). 84 85-m <msg>:: 86--message=<msg>:: 87 Use the given note message (instead of prompting). 88 If multiple `-m` options are given, their values 89 are concatenated as separate paragraphs. 90 91-F <file>:: 92--file=<file>:: 93 Take the note message from the given file. Use '-' to 94 read the note message from the standard input. 95 96-C <object>:: 97--reuse-message=<object>:: 98 Reuse the note message from the given note object. 99 100-c <object>:: 101--reedit-message=<object>:: 102 Like '-C', but with '-c' the editor is invoked, so that 103 the user can further edit the note message. 104 105Author 106------ 107Written by Johannes Schindelin <johannes.schindelin@gmx.de> and 108Johan Herland <johan@herland.net> 109 110Documentation 111------------- 112Documentation by Johannes Schindelin and Johan Herland 113 114GIT 115--- 116Part of the linkgit:git[7] suite