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