Documentation/notes: simplify treatment of default display refs
The main description of display refs for notes should be in git-log.1, where there is a chance to give a leisurely description of all the ways they can be set, what they are used for, and so on. The description in git-notes.1 is only meant to be a quick reminder of how notes are used. So simplify it. Also add an entry for GIT_NOTES_DISPLAY_REF to the environment section. Cc: Thomas Rast <trast@student.ethz.ch> Cc: Johan Herland <johan@herland.net> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
May 8, 2010 at 22:32 UTC
66c4c32d29de5d24161dc804197918453d9cd2d3
1 file changed
+19
-17
Documentation/git-notes.txt
+19
-17
@@ -35,8 +35,8 @@ message stored in the commit object, the notes are indented like the
35
message, after an unindented line saying "Notes (<refname>):" (or
36
"Notes:" for `refs/notes/commits`).
37
38
-To change which notes are shown by 'git-log', see the
39
-"notes.displayRef" configuration.
38
+To change which notes are shown by 'git log', see the
39
+"notes.displayRef" configuration in linkgit:git-log[1].
40
41
See the description of "notes.rewrite.<command>" in
42
linkgit:git-config[1] for a way of carrying your notes across commands
@@ -196,21 +196,13 @@ core.notesRef::
196
command line.
197
198
notes.displayRef::
199
- The (fully qualified) refname from which to show notes when
200
- showing commit messages. The value of this variable can be set
201
- to a glob, in which case notes from all matching refs will be
202
- shown. You may also specify this configuration variable
203
- several times. A warning will be issued for refs that do not
204
- exist, but a glob that does not match any refs is silently
205
- ignored.
206
-+
207
-This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
208
-environment variable, which must be a colon separated list of refs or
209
-globs.
210
-+
211
-The effective value of "core.notesRef" (possibly overridden by
212
-GIT_NOTES_REF) is also implicitly added to the list of refs to be
213
-displayed.
199
+ Which ref (or refs, if a glob or specified more than once), in
200
+ addition to the default set by `core.notesRef` or
201
+ 'GIT_NOTES_REF', to read notes from when showing commit
202
+ messages with the 'git log' family of commands.
203
+ This setting can be overridden on the command line or by the
204
+ 'GIT_NOTES_DISPLAY_REF' environment variable.
205
+ See linkgit:git-log[1].
206
207
notes.rewrite.<command>::
208
When rewriting commits with <command> (currently `amend` or
@@ -250,6 +242,16 @@ ENVIRONMENT
242
Which ref to manipulate notes from, instead of `refs/notes/commits`.
243
This overrides the `core.notesRef` setting.
244
245
+'GIT_NOTES_DISPLAY_REF'::
246
+ Colon-delimited list of refs or globs indicating which refs,
247
+ in addition to the default from `core.notesRef` or
248
+ 'GIT_NOTES_REF', to read notes from when showing commit
249
+ messages.
250
+ This overrides the `notes.displayRef` setting.
251
++
252
+A warning will be issued for refs that do not exist, but a glob that
253
+does not match any refs is silently ignored.
254
+
255
256
Author
257
------