summaryrefslogtreecommitdiff
path: root/Documentation/pretty-options.txt
diff options
context:
space:
mode:
authorJohan Herland <johan@herland.net>2011-03-30 02:57:19 +0200
committerJunio C Hamano <gitster@pobox.com>2011-03-30 11:36:51 -0700
commitab18b2c0df93b518ff9591d69e5e607fee718814 (patch)
tree87e860d4ce24e785f49d21585f4a6fa315686810 /Documentation/pretty-options.txt
parent92e0d42539a34e90f5c9bf29eb741f0d87173027 (diff)
downloadgit-ab18b2c0df93b518ff9591d69e5e607fee718814.tar.gz
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: Johan Herland <johan@herland.net> Acked-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/pretty-options.txt')
-rw-r--r--Documentation/pretty-options.txt35
1 files changed, 25 insertions, 10 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 50923e2ce9..d5c977262a 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -30,19 +30,34 @@ people using 80-column terminals.
preferred by the user. For non plumbing commands this
defaults to UTF-8.
---no-notes::
---show-notes[=<ref>]::
+--notes[=<ref>]::
Show the notes (see linkgit:git-notes[1]) that annotate the
commit, when showing the commit log message. This is the default
for `git log`, `git show` and `git whatchanged` commands when
- there is no `--pretty`, `--format` nor `--oneline` option is
- given on the command line.
+ there is no `--pretty`, `--format` nor `--oneline` option given
+ 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
-is taken to be in `refs/notes/` if it is not qualified.
+Multiple --notes options can be combined to control which notes are
+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::
- Enable or disable populating the notes ref list from the
- 'core.notesRef' and 'notes.displayRef' variables (or
- corresponding environment overrides). Enabled by default.
- See linkgit:git-config[1].
+ These options are deprecated. Use the above --notes/--no-notes
+ options instead.