summaryrefslogtreecommitdiff
path: root/Documentation/pretty-formats.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-formats.txt
parent552a736de775994570570a0514f24e32686afbe0 (diff)
downloadgit-2aea7a51a11598427d5b57e4bc042930d592547f.tar.gz
rev-list: make it obvious that we do not support notesjk/rev-list-has-no-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-formats.txt')
-rw-r--r--Documentation/pretty-formats.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index dc865cbb27..671cebd95c 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -139,7 +139,9 @@ The placeholders are:
- '%f': sanitized subject line, suitable for a filename
- '%b': body
- '%B': raw body (unwrapped subject and body)
+ifndef::git-rev-list[]
- '%N': commit notes
+endif::git-rev-list[]
- '%GG': raw verification message from GPG for a signed commit
- '%G?': show "G" for a Good signature, "B" for a Bad signature, "U" for a good,
untrusted signature and "N" for no signature