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) [commit] 12 13DESCRIPTION 14----------- 15This command allows you to add notes to commit messages, without 16changing the commit. To discern these notes from the message stored 17in the commit object, the notes are indented like the message, after 18an 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 35 36OPTIONS 37------- 38-m <msg>:: 39 Use the given note message (instead of prompting). 40 If multiple `-m` (or `-F`) options are given, their 41 values are concatenated as separate paragraphs. 42 43-F <file>:: 44 Take the note message from the given file. Use '-' to 45 read the note message from the standard input. 46 If multiple `-F` (or `-m`) options are given, their 47 values are concatenated as separate paragraphs. 48 49 50Author 51------ 52Written by Johannes Schindelin <johannes.schindelin@gmx.de> 53 54Documentation 55------------- 56Documentation by Johannes Schindelin 57 58GIT 59--- 60Part of the linkgit:git[7] suite