aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/pretty-options.txt
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2015-08-23 13:56:40 -0400
committerJunio C Hamano <gitster@pobox.com>2015-08-24 10:33:15 -0700
commit2aea7a51a11598427d5b57e4bc042930d592547f (patch)
tree51f04bb0b1edd9ae55407627736b7ee9dfa1510c /Documentation/pretty-options.txt
parent552a736de775994570570a0514f24e32686afbe0 (diff)
downloadgit-2aea7a51a11598427d5b57e4bc042930d592547f.tar.gz
rev-list: make it obvious that we do not support notes
The rev-list command does not have the internal infrastructure to display notes. Running: git rev-list --notes HEAD will silently ignore the "--notes" option. Running: git rev-list --notes --grep=. HEAD will crash on an assert. Running: git rev-list --format=%N HEAD will place a literal "%N" in the output (it does not even expand to an empty string). Let's have rev-list tell the user that it cannot fill the user's request, rather than silently producing wrong data. Likewise, let's remove mention of the notes options from the rev-list documentation. Signed-off-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.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 642af6e426..8d6c5cec4c 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -42,6 +42,7 @@ people using 80-column terminals.
verbatim; this means that invalid sequences in the original
commit may be copied to the output.
+ifndef::git-rev-list[]
--notes[=<ref>]::
Show the notes (see linkgit:git-notes[1]) that annotate the
commit, when showing the commit log message. This is the default
@@ -73,6 +74,7 @@ being displayed. Examples: "--notes=foo" will show only notes from
--[no-]standard-notes::
These options are deprecated. Use the above --notes/--no-notes
options instead.
+endif::git-rev-list[]
--show-signature::
Check the validity of a signed commit object by passing the signature