[PATCH] man: show: update man page for entire-thread and json.
authorMark Walters <markwalters1009@gmail.com>
Sat, 21 Jul 2012 06:34:08 +0000 (07:34 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:48:26 +0000 (09:48 -0800)
42/86b1cddde49d1126cefed55cd33c812c7b45a7 [new file with mode: 0644]

diff --git a/42/86b1cddde49d1126cefed55cd33c812c7b45a7 b/42/86b1cddde49d1126cefed55cd33c812c7b45a7
new file mode 100644 (file)
index 0000000..2edce03
--- /dev/null
@@ -0,0 +1,111 @@
+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 D8788431FAF\r
+       for <notmuch@notmuchmail.org>; Fri, 20 Jul 2012 23:34:21 -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 jIknp0qSr+nK for <notmuch@notmuchmail.org>;\r
+       Fri, 20 Jul 2012 23:34:21 -0700 (PDT)\r
+Received: from mail-we0-f181.google.com (mail-we0-f181.google.com\r
+       [74.125.82.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 3D156431FAE\r
+       for <notmuch@notmuchmail.org>; Fri, 20 Jul 2012 23:34:21 -0700 (PDT)\r
+Received: by weyt57 with SMTP id t57so3444218wey.26\r
+       for <notmuch@notmuchmail.org>; Fri, 20 Jul 2012 23:34:18 -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;\r
+       bh=5s4OhLfjh/Boq8tRfbWCLWyTAOZkEtw0L+VZ4KIQ7aw=;\r
+       b=EwsIFotH6cOv3gRbGpmR/fzPosYvQIAsBeU7ojJ8IfpSBmLcV0qLiCa9AmXNuqxtjl\r
+       nyxG9kvsPwR6WRY7BTWNbuU4WIiWVAhVRCHLguLA/KOJFRWWAJvmGMb8qYv38UoUwdER\r
+       kuWKiKU6KPpjfnpJUjYx6Ljz5+14HppuhN6LQT5uIBoUdNgGdhJEUHS+EyH1tv0UJCny\r
+       Kv1nfQjKNdFm4T5SUdjyF41m2NxpX+y9QPz8jsTZAtKIDn0Ct0NXyd8ebgSfCKRDIEng\r
+       2gWkIEfV3HM84YIa7XQ+PnthMtDkDjIg267c/nI6LfopDarq0a0p9WnT/k/kJCMJV7jB\r
+       faYg==\r
+Received: by 10.180.98.200 with SMTP id ek8mr12843187wib.0.1342852458382;\r
+       Fri, 20 Jul 2012 23:34:18 -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
+ t8sm2037305wiy.3.2012.07.20.23.34.16  (version=TLSv1/SSLv3 cipher=OTHER);     Fri,\r
+ 20 Jul 2012 23:34:17 -0700 (PDT)\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] man: show: update man page for entire-thread and json.\r
+Date: Sat, 21 Jul 2012 07:34:08 +0100\r
+Message-Id: <1342852448-8917-1-git-send-email-markwalters1009@gmail.com>\r
+X-Mailer: git-send-email 1.7.9.1\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: Sat, 21 Jul 2012 06:34:22 -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
+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
+ .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
+-- \r
+1.7.9.1\r
+\r