mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation/notes: simplify treatment of default display refs

Browse Source 
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>
This commit is contained in:
Jonathan Nieder
2010-05-08 22:32:24 -05:00
committed by Junio C Hamano
parent 59893a88f9
commit 66c4c32d29
1 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
Documentation/git-notes.txt
View File

@ -35,8 +35,8 @@ message stored in the commit object, the notes are indented like the
message, after an unindented line saying "Notes (<refname>):" (or message, after an unindented line saying "Notes (<refname>):" (or
"Notes:" for `refs/notes/commits`). "Notes:" for `refs/notes/commits`).
To change which notes are shown by 'git-log', see the To change which notes are shown by 'git log', see the
"notes.displayRef" configuration. "notes.displayRef" configuration in linkgit:git-log[1].
See the description of "notes.rewrite.<command>" in See the description of "notes.rewrite.<command>" in
linkgit:git-config[1] for a way of carrying your notes across commands linkgit:git-config[1] for a way of carrying your notes across commands
@ -196,21 +196,13 @@ core.notesRef::
command line. command line.
notes.displayRef:: notes.displayRef::
The (fully qualified) refname from which to show notes when Which ref (or refs, if a glob or specified more than once), in
showing commit messages. The value of this variable can be set addition to the default set by `core.notesRef` or
to a glob, in which case notes from all matching refs will be 'GIT_NOTES_REF', to read notes from when showing commit
shown. You may also specify this configuration variable messages with the 'git log' family of commands.
several times. A warning will be issued for refs that do not This setting can be overridden on the command line or by the
exist, but a glob that does not match any refs is silently 'GIT_NOTES_DISPLAY_REF' environment variable.
ignored. See linkgit:git-log[1].
+
This setting can be overridden with the `GIT_NOTES_DISPLAY_REF`
environment variable, which must be a colon separated list of refs or
globs.
+
The effective value of "core.notesRef" (possibly overridden by
GIT_NOTES_REF) is also implicitly added to the list of refs to be
displayed.
notes.rewrite.<command>:: notes.rewrite.<command>::
When rewriting commits with <command> (currently `amend` or When rewriting commits with <command> (currently `amend` or
@ -250,6 +242,16 @@ ENVIRONMENT
Which ref to manipulate notes from, instead of `refs/notes/commits`. Which ref to manipulate notes from, instead of `refs/notes/commits`.
This overrides the `core.notesRef` setting. This overrides the `core.notesRef` setting.
'GIT_NOTES_DISPLAY_REF'::
Colon-delimited list of refs or globs indicating which refs,
in addition to the default from `core.notesRef` or
'GIT_NOTES_REF', to read notes from when showing commit
messages.
This overrides the `notes.displayRef` setting.
+
A warning will be issued for refs that do not exist, but a glob that
does not match any refs is silently ignored.
Author Author
------ ------