aboutsummaryrefslogtreecommitdiff
path: root/Documentation/git-notes.txt
diff options
context:
space:
mode:
authorThomas Rast <trast@student.ethz.ch>2010-03-12 18:04:26 +0100
committerJunio C Hamano <gitster@pobox.com>2010-03-12 21:55:39 -0800
commit894a9d333e9e2015cad00d95250b7c5d3acea8b6 (patch)
tree2bab79483f959c7661e87ef70b1976ab9aa65bdb /Documentation/git-notes.txt
parent6ceeaee7ea5bb754c76ce93c5b289f72d69fdb92 (diff)
downloadgit-894a9d333e9e2015cad00d95250b7c5d3acea8b6.tar.gz
git-894a9d333e9e2015cad00d95250b7c5d3acea8b6.tar.xz
Support showing notes from more than one notes tree
With this patch, you can set notes.displayRef to a glob that points at your favourite notes refs, e.g., [notes] displayRef = refs/notes/* Then git-log and friends will show notes from all trees. Thanks to Junio C Hamano for lots of feedback, which greatly influenced the design of the entire series and this commit in particular. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Acked-by: Johan Herland <johan@herland.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-notes.txt')
-rw-r--r--Documentation/git-notes.txt11
1 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 14f73b988..7abd0fbd2 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -27,12 +27,13 @@ A typical use of notes is to extend a commit message without having
to change the commit itself. Such commit notes can be shown by `git log`
along with the original commit message. 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:".
+message, after an unindented line saying "Notes (<refname>):" (or
+"Notes:" for the default setting).
-To disable 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".
+This command always manipulates the notes specified in "core.notesRef"
+(see linkgit:git-config[1]), which can be overridden by GIT_NOTES_REF.
+To change which notes are shown by 'git-log', see the
+"notes.displayRef" configuration.
SUBCOMMANDS