diff options
| author | Jonathan Nieder <jrnieder@gmail.com> | 2010-05-09 03:32:24 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-05-09 05:30:03 (GMT) |
| commit | 66c4c32d29de5d24161dc804197918453d9cd2d3 (patch) | |
| tree | 6346d46a7355a5508baedb20f1379ac4825e9b07 /Documentation/git-notes.txt | |
| parent | 59893a88f96b3ed4223c20942fd3db5d8c43f7c0 (diff) | |
| download | git-66c4c32d29de5d24161dc804197918453d9cd2d3.zip git-66c4c32d29de5d24161dc804197918453d9cd2d3.tar.gz git-66c4c32d29de5d24161dc804197918453d9cd2d3.tar.bz2 | |
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>
Diffstat (limited to 'Documentation/git-notes.txt')
| -rw-r--r-- | Documentation/git-notes.txt | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 28ac862..7856b28 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -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 "Notes:" for `refs/notes/commits`). -To change which notes are shown by 'git-log', see the -"notes.displayRef" configuration. +To change which notes are shown by 'git log', see the +"notes.displayRef" configuration in linkgit:git-log[1]. See the description of "notes.rewrite.<command>" in linkgit:git-config[1] for a way of carrying your notes across commands @@ -196,21 +196,13 @@ core.notesRef:: command line. notes.displayRef:: - The (fully qualified) refname from which to show notes when - showing commit messages. The value of this variable can be set - to a glob, in which case notes from all matching refs will be - shown. You may also specify this configuration variable - several times. A warning will be issued for refs that do not - exist, but a glob that does not match any refs is silently - ignored. -+ -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. + Which ref (or refs, if a glob or specified more than once), in + addition to the default set by `core.notesRef` or + 'GIT_NOTES_REF', to read notes from when showing commit + messages with the 'git log' family of commands. + This setting can be overridden on the command line or by the + 'GIT_NOTES_DISPLAY_REF' environment variable. + See linkgit:git-log[1]. notes.rewrite.<command>:: When rewriting commits with <command> (currently `amend` or @@ -250,6 +242,16 @@ ENVIRONMENT Which ref to manipulate notes from, instead of `refs/notes/commits`. 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 ------ |