Re: [PATCH] man: show: update man page for entire-thread and json.
authorAustin Clements <amdragon@MIT.EDU>
Sun, 22 Jul 2012 16:36:28 +0000 (12:36 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:48:28 +0000 (09:48 -0800)
56/d4529cac683dd0b3459ff0d5c75daa7dffd343 [new file with mode: 0644]

diff --git a/56/d4529cac683dd0b3459ff0d5c75daa7dffd343 b/56/d4529cac683dd0b3459ff0d5c75daa7dffd343
new file mode 100644 (file)
index 0000000..8468897
--- /dev/null
@@ -0,0 +1,138 @@
+Return-Path: <amdragon@mit.edu>\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 4CDB1431FAF\r
+       for <notmuch@notmuchmail.org>; Sun, 22 Jul 2012 09:36:32 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[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 uWR2QAkWfEMn for <notmuch@notmuchmail.org>;\r
+       Sun, 22 Jul 2012 09:36:31 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-5.mit.edu (DMZ-MAILSEC-SCANNER-5.MIT.EDU\r
+       [18.7.68.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id A39FD431FAE\r
+       for <notmuch@notmuchmail.org>; Sun, 22 Jul 2012 09:36:31 -0700 (PDT)\r
+X-AuditID: 12074422-b7f1f6d00000090b-5a-500c2c0f20b6\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id E0.1E.02315.F0C2C005; Sun, 22 Jul 2012 12:36:31 -0400 (EDT)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id q6MGaUSd009081; \r
+       Sun, 22 Jul 2012 12:36:31 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q6MGaTtk006761\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Sun, 22 Jul 2012 12:36:30 -0400 (EDT)\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1Ssz8u-0007M5-V7; Sun, 22 Jul 2012 12:36:29 -0400\r
+Date: Sun, 22 Jul 2012 12:36:28 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Mark Walters <markwalters1009@gmail.com>\r
+Subject: Re: [PATCH] man: show: update man page for entire-thread and json.\r
+Message-ID: <20120722163628.GE31834@mit.edu>\r
+References: <1342852448-8917-1-git-send-email-markwalters1009@gmail.com>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <1342852448-8917-1-git-send-email-markwalters1009@gmail.com>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFupjleLIzCtJLcpLzFFi42IRYrdT1+XX4QkwaNrCbbF6Lo/F9ZszmR2Y\r
+       PHbOusvu8WzVLeYApigum5TUnMyy1CJ9uwSujA3v/rAXXBKquLloFXsD4wS+LkZODgkBE4n+\r
+       tUtYIGwxiQv31rN1MXJxCAnsY5SYd/MhI4SzgVFi0b3XzBDOSSaJOQ1PoZwljBLrL89jBeln\r
+       EVCVWPrhDRuIzSagIbFt/3JGEFtEQEfi9qEF7CA2s4C0xLffzUxdjBwcwgLeEjsmC4OEeYFK\r
+       Nm/aygxiCwl4SBztX8sCEReUODnzCQtEq5bEjX8vwVpBxiz/xwES5hTwlPg2fRtYq6iAisSU\r
+       k9vYJjAKzULSPQtJ9yyE7gWMzKsYZVNyq3RzEzNzilOTdYuTE/PyUot0TfVyM0v0UlNKNzGC\r
+       g9pFaQfjz4NKhxgFOBiVeHgN3bkDhFgTy4orcw8xSnIwKYny7tXkCRDiS8pPqcxILM6ILyrN\r
+       SS0+xCjBwawkwnv5OlA5b0piZVVqUT5MSpqDRUmc91rKTX8hgfTEktTs1NSC1CKYrAwHh5IE\r
+       b7Y20FDBotT01Iq0zJwShDQTByfIcB6g4Y0gNbzFBYm5xZnpEPlTjLoc1x7eusUoxJKXn5cq\r
+       Jc4bC1IkAFKUUZoHNweWjF4xigO9JczbBVLFA0xkcJNeAS1hAloincUFsqQkESEl1cA4965E\r
+       v9Zzp7OTjr/cEGj4QJJz2uvU8wlzb9x0XVx0NWVeoc91jSJZvn6hk9qyZz9OO9P92bPzutiL\r
+       5ylK9V/CvN5cyTbZPHnPhWMvVBOfmmQcTL6WdGKzlsqiTVMc2ouiNPX2Gh7kmN598laE/wRH\r
+       1ZjVl698elTdJpL06my+2bedtTd/djqcVmIpzkg01GIuKk4EABkgYJkhAwAA\r
+Cc: notmuch@notmuchmail.org\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: Sun, 22 Jul 2012 16:36:32 -0000\r
+\r
+Quoth Mark Walters on Jul 21 at  7:34 am:\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
+> I didn't update the manpage in the recent patch series. This corrects\r
+> that omission. (Less cumbersome wording gratefully received)\r
+> \r
+> Best wishes\r
+>                                                                                                                              \r
+> Mark    man/man1/notmuch-show.1 |   16 +++++++++-------\r
+>  1 files changed, 9 insertions(+), 7 deletions(-)\r
+> \r
+> diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
+> index b51a54c..5fa590e 100644\r
+> --- a/man/man1/notmuch-show.1\r
+> +++ b/man/man1/notmuch-show.1\r
+> @@ -26,9 +26,9 @@ include\r
+>  .TP 4\r
+>  .B \-\-entire\-thread\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
+> +By default (except when format=json) only those messages that match\r
+> +the search terms will be displayed. With this option, all messages in\r
+> +the same thread as any matched message will be displayed.\r
+\r
+I think stating this in terms of defaults that aren't really defaults\r
+is what makes this cumbersome.  What about something like\r
+\r
+.B \-\-entire\-thread=(true|false)\r
+\r
+If true, \r
+.B notmuch show\r
+returns all messages in the thread of any message matching the search\r
+terms, rather than returning only the matching messages.  For\r
+.B --format=json\r
+this defaults to true.  For other formats, this defaults to false.\r
+\r
+>  .RE\r
+>  \r
+>  .RS 4\r
+> @@ -55,11 +55,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