提交 ab18b2c0 编写于 作者: J Johan Herland 提交者: Junio C Hamano

log/pretty-options: Document --[no-]notes and deprecate old notes options

Document the behavior or the new --notes, --notes=<ref> and --no-notes
options, and list --show-notes[=<ref>] and --[no-]standard-notes options
as deprecated.
Signed-off-by: NJohan Herland <johan@herland.net>
Acked-by: NJeff King <peff@peff.net>
Signed-off-by: NJunio C Hamano <gitster@pobox.com>
上级 92e0d425
...@@ -178,9 +178,9 @@ May be an unabbreviated ref name or a glob and may be specified ...@@ -178,9 +178,9 @@ May be an unabbreviated ref name or a glob and may be specified
multiple times. A warning will be issued for refs that do not exist, multiple times. A warning will be issued for refs that do not exist,
but a glob that does not match any refs is silently ignored. but a glob that does not match any refs is silently ignored.
+ +
This setting can be disabled by the `--no-standard-notes` option, This setting can be disabled by the `--no-notes` option,
overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable, overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
and supplemented by the `--show-notes` option. and overridden by the `--notes=<ref>` option.
GIT GIT
--- ---
......
...@@ -30,19 +30,34 @@ people using 80-column terminals. ...@@ -30,19 +30,34 @@ people using 80-column terminals.
preferred by the user. For non plumbing commands this preferred by the user. For non plumbing commands this
defaults to UTF-8. defaults to UTF-8.
--no-notes:: --notes[=<ref>]::
--show-notes[=<ref>]::
Show the notes (see linkgit:git-notes[1]) that annotate the Show the notes (see linkgit:git-notes[1]) that annotate the
commit, when showing the commit log message. This is the default commit, when showing the commit log message. This is the default
for `git log`, `git show` and `git whatchanged` commands when for `git log`, `git show` and `git whatchanged` commands when
there is no `--pretty`, `--format` nor `--oneline` option is there is no `--pretty`, `--format` nor `--oneline` option given
given on the command line. on the command line.
+
By default, the notes shown are from the notes refs listed in the
'core.notesRef' and 'notes.displayRef' variables (or corresponding
environment overrides). See linkgit:git-config[1] for more details.
+
With an optional '<ref>' argument, show this notes ref instead of the
default notes ref(s). The ref is taken to be in `refs/notes/` if it
is not qualified.
+ +
With an optional argument, add this ref to the list of notes. The ref Multiple --notes options can be combined to control which notes are
is taken to be in `refs/notes/` if it is not qualified. being displayed. Examples: "--notes=foo" will show only notes from
"refs/notes/foo"; "--notes=foo --notes" will show both notes from
"refs/notes/foo" and from the default notes ref(s).
--no-notes::
Do not show notes. This negates the above `--notes` option, by
resetting the list of notes refs from which notes are shown.
Options are parsed in the order given on the command line, so e.g.
"--notes --notes=foo --no-notes --notes=bar" will only show notes
from "refs/notes/bar".
--show-notes[=<ref>]::
--[no-]standard-notes:: --[no-]standard-notes::
Enable or disable populating the notes ref list from the These options are deprecated. Use the above --notes/--no-notes
'core.notesRef' and 'notes.displayRef' variables (or options instead.
corresponding environment overrides). Enabled by default.
See linkgit:git-config[1].
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册