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