path: root/Documentation/git-notes.txt
diff options
authorJohannes Schindelin <>2009-10-09 10:21:58 (GMT)
committerJunio C Hamano <>2009-10-20 01:59:42 (GMT)
commit65d9fb487f36d4a12a169dc18cbbb5225337c085 (patch)
treed87d45648689a81389d0caa39bf8872d12d2e4f7 /Documentation/git-notes.txt
parenta97a74686d70a318cd802003498054cc1e8b0ae2 (diff)
Add a script to edit/inspect notes
The script 'git notes' allows you to edit and show commit notes, by calling either git notes show <commit> or git notes edit <commit> This patch has been improved by the following contributions: - Tor Arne Vestbø: fix printing of multi-line notes - Michael J Gruber: test and handle empty notes gracefully - Thomas Rast: - only clean up message file when editing - use GIT_EDITOR and core.editor over VISUAL/EDITOR - t3301: fix confusing quoting in test for valid notes ref - t3301: use test_must_fail instead of ! - refuse to edit notes outside refs/notes/ - Junio C Hamano: tests: fix "export var=val" - Christian Couder: documentation: fix 'linkgit' macro in "git-notes.txt" - Johan Herland: minor cleanup and bugfixing in (v2) Signed-off-by: Johannes Schindelin <> Signed-off-by: Tor Arne Vestbø <> Signed-off-by: Michael J Gruber <> Signed-off-by: Thomas Rast <> Signed-off-by: Christian Couder <> Signed-off-by: Johan Herland <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-notes.txt')
1 files changed, 46 insertions, 0 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
new file mode 100644
index 0000000..7136016
--- /dev/null
+++ b/Documentation/git-notes.txt
@@ -0,0 +1,46 @@
+git-notes - Add/inspect commit notes
+'git-notes' (edit | show) [commit]
+This command allows you to add notes to commit messages, without
+changing the commit. To discern these notes from the message stored
+in the commit object, the notes are indented like the message, after
+an unindented line saying "Notes:".
+To disable commit notes, you have to set the config variable
+core.notesRef to the empty string. Alternatively, you can set it
+to a different ref, something like "refs/notes/bugzilla". This setting
+can be overridden by the environment variable "GIT_NOTES_REF".
+ Edit the notes for a given commit (defaults to HEAD).
+ Show the notes for a given commit (defaults to HEAD).
+Written by Johannes Schindelin <>
+Documentation by Johannes Schindelin
+Part of the linkgit:git[7] suite