1git-notes(1) 2============ 3 4NAME 5---- 6git-notes - Add/inspect object notes 7 8SYNOPSIS 9-------- 10[verse] 11'git notes' (edit [-F <file> | -m <msg>] | show | remove | prune) [object] 12 13DESCRIPTION 14----------- 15This command allows you to add/remove notes to/from objects, without 16changing the objects themselves. 17 18A typical use of notes is to extend a commit message without having 19to change the commit itself. Such commit notes can be shown by `git log` 20along with the original commit message. To discern these notes from the 21message stored in the commit object, the notes are indented like the 22message, after an unindented line saying "Notes:". 23 24To disable notes, you have to set the config variable core.notesRef to 25the empty string. Alternatively, you can set it to a different ref, 26something like "refs/notes/bugzilla". This setting can be overridden 27by the environment variable "GIT_NOTES_REF". 28 29 30SUBCOMMANDS 31----------- 32 33edit:: 34 Edit the notes for a given object (defaults to HEAD). 35 36show:: 37 Show the notes for a given object (defaults to HEAD). 38 39remove:: 40 Remove the notes for a given object (defaults to HEAD). 41 This is equivalent to specifying an empty note message to 42 the `edit` subcommand. 43 44prune:: 45 Remove all notes for non-existing/unreachable objects. 46 47OPTIONS 48------- 49-m <msg>:: 50 Use the given note message (instead of prompting). 51 If multiple `-m` options are given, their values 52 are concatenated as separate paragraphs. 53 54-F <file>:: 55 Take the note message from the given file. Use '-' to 56 read the note message from the standard input. 57 58 59Author 60------ 61Written by Johannes Schindelin <johannes.schindelin@gmx.de> and 62Johan Herland <johan@herland.net> 63 64Documentation 65------------- 66Documentation by Johannes Schindelin and Johan Herland 67 68GIT 69--- 70Part of the linkgit:git[7] suite