From: Mark Walters <markwalters1009@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH v2] man: show: update man page for entire-thread and json.
Date: Tue, 24 Jul 2012 19:57:57 +0100 [thread overview]
Message-ID: <1343156277-28146-1-git-send-email-markwalters1009@gmail.com> (raw)
In-Reply-To: <20120722163628.GE31834@mit.edu>
Previously in notmuch show --format=json implied --entire-thread. This
is still the default but it is now possible to disable this. Update
the manpage to reflect this.
---
Update the manpage since --format=json and --entire-thread=false is
now supported. Reworded as Austin suggested.
Best wishes
Mark
man/man1/notmuch-show.1 | 21 +++++++++++++--------
1 files changed, 13 insertions(+), 8 deletions(-)
diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1
index 506583a..765b22c 100644
--- a/man/man1/notmuch-show.1
+++ b/man/man1/notmuch-show.1
@@ -24,11 +24,14 @@ Supported options for
include
.RS 4
.TP 4
-.B \-\-entire\-thread
+.B \-\-entire\-thread=(true|false)
-By default only those messages that match the search terms will be
-displayed. With this option, all messages in the same thread as any
-matched message will be displayed.
+If true,
+.B notmuch show
+outputs all messages in the thread of any message matching the search
+terms; if false, it outputs only the matching messages. For
+.B --format=json
+this defaults to true. For other formats, this defaults to false.
.RE
.RS 4
@@ -55,11 +58,13 @@ be nested.
The output is formatted with Javascript Object Notation (JSON). This
format is more robust than the text format for automated
processing. The nested structure of multipart MIME messages is
-reflected in nested JSON output. JSON output always includes all
-messages in a matching thread; in effect
+reflected in nested JSON output. By default JSON output includes all
+messages in a matching thread; that is, by default,
.B \-\-format=json
-implies
-.B \-\-entire\-thread
+sets
+.B "\-\-entire\-thread"
+The caller can disable this behaviour by setting
+.B \-\-entire\-thread=false
.RE
.RS 4
--
1.7.9.1
next prev parent reply other threads:[~2012-07-24 18:58 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-07-21 6:34 [PATCH] man: show: update man page for entire-thread and json Mark Walters
2012-07-22 16:36 ` Austin Clements
2012-07-24 18:57 ` Mark Walters [this message]
2012-07-25 3:12 ` [PATCH v2] " Austin Clements
2012-07-25 11:21 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1343156277-28146-1-git-send-email-markwalters1009@gmail.com \
--to=markwalters1009@gmail.com \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).