Re: [PATCH v4 13/16] add indexopts to notmuch python bindings.
[notmuch-archives.git] / 56 / d4529cac683dd0b3459ff0d5c75daa7dffd343
1 Return-Path: <amdragon@mit.edu>\r
2 X-Original-To: notmuch@notmuchmail.org\r
3 Delivered-To: notmuch@notmuchmail.org\r
4 Received: from localhost (localhost [127.0.0.1])\r
5         by olra.theworths.org (Postfix) with ESMTP id 4CDB1431FAF\r
6         for <notmuch@notmuchmail.org>; Sun, 22 Jul 2012 09:36:32 -0700 (PDT)\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
8 X-Spam-Flag: NO\r
9 X-Spam-Score: -0.7\r
10 X-Spam-Level: \r
11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
12         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
13 Received: from olra.theworths.org ([127.0.0.1])\r
14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
15         with ESMTP id uWR2QAkWfEMn for <notmuch@notmuchmail.org>;\r
16         Sun, 22 Jul 2012 09:36:31 -0700 (PDT)\r
17 Received: from dmz-mailsec-scanner-5.mit.edu (DMZ-MAILSEC-SCANNER-5.MIT.EDU\r
18         [18.7.68.34])\r
19         by olra.theworths.org (Postfix) with ESMTP id A39FD431FAE\r
20         for <notmuch@notmuchmail.org>; Sun, 22 Jul 2012 09:36:31 -0700 (PDT)\r
21 X-AuditID: 12074422-b7f1f6d00000090b-5a-500c2c0f20b6\r
22 Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
23         by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
24         id E0.1E.02315.F0C2C005; Sun, 22 Jul 2012 12:36:31 -0400 (EDT)\r
25 Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
26         by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id q6MGaUSd009081; \r
27         Sun, 22 Jul 2012 12:36:31 -0400\r
28 Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
29         (authenticated bits=0)\r
30         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
31         by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q6MGaTtk006761\r
32         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
33         Sun, 22 Jul 2012 12:36:30 -0400 (EDT)\r
34 Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
35         (envelope-from <amdragon@mit.edu>)\r
36         id 1Ssz8u-0007M5-V7; Sun, 22 Jul 2012 12:36:29 -0400\r
37 Date: Sun, 22 Jul 2012 12:36:28 -0400\r
38 From: Austin Clements <amdragon@MIT.EDU>\r
39 To: Mark Walters <markwalters1009@gmail.com>\r
40 Subject: Re: [PATCH] man: show: update man page for entire-thread and json.\r
41 Message-ID: <20120722163628.GE31834@mit.edu>\r
42 References: <1342852448-8917-1-git-send-email-markwalters1009@gmail.com>\r
43 MIME-Version: 1.0\r
44 Content-Type: text/plain; charset=us-ascii\r
45 Content-Disposition: inline\r
46 In-Reply-To: <1342852448-8917-1-git-send-email-markwalters1009@gmail.com>\r
47 User-Agent: Mutt/1.5.21 (2010-09-15)\r
48 X-Brightmail-Tracker:\r
49  H4sIAAAAAAAAA+NgFupjleLIzCtJLcpLzFFi42IRYrdT1+XX4QkwaNrCbbF6Lo/F9ZszmR2Y\r
50         PHbOusvu8WzVLeYApigum5TUnMyy1CJ9uwSujA3v/rAXXBKquLloFXsD4wS+LkZODgkBE4n+\r
51         tUtYIGwxiQv31rN1MXJxCAnsY5SYd/MhI4SzgVFi0b3XzBDOSSaJOQ1PoZwljBLrL89jBeln\r
52         EVCVWPrhDRuIzSagIbFt/3JGEFtEQEfi9qEF7CA2s4C0xLffzUxdjBwcwgLeEjsmC4OEeYFK\r
53         Nm/aygxiCwl4SBztX8sCEReUODnzCQtEq5bEjX8vwVpBxiz/xwES5hTwlPg2fRtYq6iAisSU\r
54         k9vYJjAKzULSPQtJ9yyE7gWMzKsYZVNyq3RzEzNzilOTdYuTE/PyUot0TfVyM0v0UlNKNzGC\r
55         g9pFaQfjz4NKhxgFOBiVeHgN3bkDhFgTy4orcw8xSnIwKYny7tXkCRDiS8pPqcxILM6ILyrN\r
56         SS0+xCjBwawkwnv5OlA5b0piZVVqUT5MSpqDRUmc91rKTX8hgfTEktTs1NSC1CKYrAwHh5IE\r
57         b7Y20FDBotT01Iq0zJwShDQTByfIcB6g4Y0gNbzFBYm5xZnpEPlTjLoc1x7eusUoxJKXn5cq\r
58         Jc4bC1IkAFKUUZoHNweWjF4xigO9JczbBVLFA0xkcJNeAS1hAloincUFsqQkESEl1cA4965E\r
59         v9Zzp7OTjr/cEGj4QJJz2uvU8wlzb9x0XVx0NWVeoc91jSJZvn6hk9qyZz9OO9P92bPzutiL\r
60         5ylK9V/CvN5cyTbZPHnPhWMvVBOfmmQcTL6WdGKzlsqiTVMc2ouiNPX2Gh7kmN598laE/wRH\r
61         1ZjVl698elTdJpL06my+2bedtTd/djqcVmIpzkg01GIuKk4EABkgYJkhAwAA\r
62 Cc: notmuch@notmuchmail.org\r
63 X-BeenThere: notmuch@notmuchmail.org\r
64 X-Mailman-Version: 2.1.13\r
65 Precedence: list\r
66 List-Id: "Use and development of the notmuch mail system."\r
67         <notmuch.notmuchmail.org>\r
68 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
69         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
70 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
71 List-Post: <mailto:notmuch@notmuchmail.org>\r
72 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
73 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
74         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
75 X-List-Received-Date: Sun, 22 Jul 2012 16:36:32 -0000\r
76 \r
77 Quoth Mark Walters on Jul 21 at  7:34 am:\r
78 > Previously in notmuch show --format=json implied --entire-thread. This\r
79 > is still the default but it is now possible to disable this. Update\r
80 > the manpage to reflect this.\r
81 > ---\r
82\r
83 > I didn't update the manpage in the recent patch series. This corrects\r
84 > that omission. (Less cumbersome wording gratefully received)\r
85\r
86 > Best wishes\r
87 >                                                                                                                              \r
88 > Mark    man/man1/notmuch-show.1 |   16 +++++++++-------\r
89 >  1 files changed, 9 insertions(+), 7 deletions(-)\r
90\r
91 > diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
92 > index b51a54c..5fa590e 100644\r
93 > --- a/man/man1/notmuch-show.1\r
94 > +++ b/man/man1/notmuch-show.1\r
95 > @@ -26,9 +26,9 @@ include\r
96 >  .TP 4\r
97 >  .B \-\-entire\-thread\r
98 >  \r
99 > -By default only those messages that match the search terms will be\r
100 > -displayed. With this option, all messages in the same thread as any\r
101 > -matched message will be displayed.\r
102 > +By default (except when format=json) only those messages that match\r
103 > +the search terms will be displayed. With this option, all messages in\r
104 > +the same thread as any matched message will be displayed.\r
105 \r
106 I think stating this in terms of defaults that aren't really defaults\r
107 is what makes this cumbersome.  What about something like\r
108 \r
109 .B \-\-entire\-thread=(true|false)\r
110 \r
111 If true, \r
112 .B notmuch show\r
113 returns all messages in the thread of any message matching the search\r
114 terms, rather than returning only the matching messages.  For\r
115 .B --format=json\r
116 this defaults to true.  For other formats, this defaults to false.\r
117 \r
118 >  .RE\r
119 >  \r
120 >  .RS 4\r
121 > @@ -55,11 +55,13 @@ be nested.\r
122 >  The output is formatted with Javascript Object Notation (JSON). This\r
123 >  format is more robust than the text format for automated\r
124 >  processing. The nested structure of multipart MIME messages is\r
125 > -reflected in nested JSON output. JSON output always includes all\r
126 > -messages in a matching thread; in effect\r
127 > +reflected in nested JSON output. By default JSON output includes all\r
128 > +messages in a matching thread; that is, by default,\r
129 >  .B \-\-format=json\r
130 > -implies\r
131 > -.B \-\-entire\-thread\r
132 > +sets\r
133 > +.B "\-\-entire\-thread"\r
134 > +The caller can disable this behaviour by setting\r
135 > +.B \-\-entire\-thread=false\r
136 >  \r
137 >  .RE\r
138 >  .RS 4\r