[PATCH v2] man: show: update man page for entire-thread and json.

diff --git a/33/8dcb0886c7ebad1a8dccc049cbc696797473fc b/33/8dcb0886c7ebad1a8dccc049cbc696797473fc
new file mode 100644 (file)
index 0000000..c9953cc
--- /dev/null
+++ b/33/8dcb0886c7ebad1a8dccc049cbc696797473fc
@@ -0,0 +1,121 @@
+Return-Path: <markwalters1009@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id A6B02431FBD\r
+       for <notmuch@notmuchmail.org>; Tue, 24 Jul 2012 11:58:13 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.201\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.201 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001,\r
+       RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id KCeG9HQnIuml for <notmuch@notmuchmail.org>;\r
+       Tue, 24 Jul 2012 11:58:13 -0700 (PDT)\r
+Received: from mail-wg0-f45.google.com (mail-wg0-f45.google.com\r
+ [74.125.82.45])       (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
+ certificate requested)        by olra.theworths.org (Postfix) with ESMTPS id\r
+ 0E06E431FAE   for <notmuch@notmuchmail.org>; Tue, 24 Jul 2012 11:58:12 -0700\r
+ (PDT)\r
+Received: by wgbdt14 with SMTP id dt14so6019116wgb.2\r
+       for <notmuch@notmuchmail.org>; Tue, 24 Jul 2012 11:58:11 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references;\r
+       bh=JUuaDzfoWOrmpkJhxZ6wdy/YG3/IcXG74OOITvXEIYQ=;\r
+       b=WHJIsyeY9hT85201Ag4LY0u949FB/PenGkububHsXgv/X0Rjh9SEXH7O5ax5gsBicE\r
+       K6v1c9eQ9pV/zGjFbTWWqxd4aDuibjbtNo1ZqLdrUrIGRfoM5OMJODNxcfqnDM7Vgneq\r
+       whAcrmmXQIAQuJh3B8Jb+B58eKGWnGxbBbd0M4b4zQ/9Iu12Ht3qhdxNZNDteCkXRQUa\r
+       QhfkTQYWkvAegBnxnPXs/nE/AAoYyhRvuMHf30+mM0P2UsmBBLB1ze4KawqjHa5Z9iZb\r
+       hFzBHb8uC3k+zPGajwdw8/B9x1hjsXFcANNtvo0I7/Ds8CiLP0YN5MeDfV+JJ68Vr6xl\r
+       dbeA==\r
+Received: by 10.180.76.36 with SMTP id h4mr2354934wiw.13.1343156291779;\r
+       Tue, 24 Jul 2012 11:58:11 -0700 (PDT)\r
+Received: from localhost (94-192-233-223.zone6.bethere.co.uk.\r
+ [94.192.233.223])     by mx.google.com with ESMTPS id\r
+ t8sm5650295wiy.3.2012.07.24.11.58.09  (version=TLSv1/SSLv3 cipher=OTHER);     Tue,\r
+ 24 Jul 2012 11:58:10 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2] man: show: update man page for entire-thread and json.\r
+Date: Tue, 24 Jul 2012 19:57:57 +0100\r
+Message-Id: <1343156277-28146-1-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\r
+In-Reply-To: <20120722163628.GE31834@mit.edu>\r
+References: <20120722163628.GE31834@mit.edu>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Tue, 24 Jul 2012 18:58:13 -0000\r
+\r
+Previously in notmuch show --format=json implied --entire-thread. This\r
+is still the default but it is now possible to disable this. Update\r
+the manpage to reflect this.\r
+---\r
+\r
+Update the manpage since --format=json and --entire-thread=false is\r
+now supported. Reworded as Austin suggested.\r
+\r
+Best wishes\r
+\r
+Mark \r
+\r
+ man/man1/notmuch-show.1 |   21 +++++++++++++--------\r
+ 1 files changed, 13 insertions(+), 8 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
+index 506583a..765b22c 100644\r
+--- a/man/man1/notmuch-show.1\r
++++ b/man/man1/notmuch-show.1\r
+@@ -24,11 +24,14 @@ Supported options for\r
+ include\r
+ .RS 4\r
+ .TP 4\r
+-.B \-\-entire\-thread\r
++.B \-\-entire\-thread=(true|false)\r
+ \r
+-By default only those messages that match the search terms will be\r
+-displayed. With this option, all messages in the same thread as any\r
+-matched message will be displayed.\r
++If true,\r
++.B notmuch show\r
++outputs all messages in the thread of any message matching the search\r
++terms; if false, it outputs only the matching messages. For\r
++.B --format=json\r
++this defaults to true.  For other formats, this defaults to false.\r
+ .RE\r
+ \r
+ .RS 4\r
+@@ -55,11 +58,13 @@ be nested.\r
+ The output is formatted with Javascript Object Notation (JSON). This\r
+ format is more robust than the text format for automated\r
+ processing. The nested structure of multipart MIME messages is\r
+-reflected in nested JSON output. JSON output always includes all\r
+-messages in a matching thread; in effect\r
++reflected in nested JSON output. By default JSON output includes all\r
++messages in a matching thread; that is, by default,\r
+ .B \-\-format=json\r
+-implies\r
+-.B \-\-entire\-thread\r
++sets\r
++.B "\-\-entire\-thread"\r
++The caller can disable this behaviour by setting\r
++.B \-\-entire\-thread=false\r
+ \r
+ .RE\r
+ .RS 4\r
+-- \r
+1.7.9.1\r
+\r