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