1 Return-Path: <andreimpopescu@gmail.com>
\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 8D9B7431FAF
\r
6 for <notmuch@notmuchmail.org>; Fri, 16 Mar 2012 15:30:00 -0700 (PDT)
\r
7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
\r
11 X-Spam-Status: No, score=-0.798 tagged_above=-999 required=5
\r
12 tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,
\r
13 FAKE_REPLY_C=0.001, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7]
\r
15 Received: from olra.theworths.org ([127.0.0.1])
\r
16 by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
\r
17 with ESMTP id ATkBsrpkyCsm for <notmuch@notmuchmail.org>;
\r
18 Fri, 16 Mar 2012 15:29:58 -0700 (PDT)
\r
19 Received: from mail-wi0-f179.google.com (mail-wi0-f179.google.com
\r
20 [209.85.212.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
\r
21 (No client certificate requested)
\r
22 by olra.theworths.org (Postfix) with ESMTPS id 539CB431FAE
\r
23 for <notmuch@notmuchmail.org>; Fri, 16 Mar 2012 15:29:58 -0700 (PDT)
\r
24 Received: by wibhn6 with SMTP id hn6so1212008wib.2
\r
25 for <notmuch@notmuchmail.org>; Fri, 16 Mar 2012 15:29:55 -0700 (PDT)
\r
26 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;
\r
27 h=date:from:to:cc:subject:message-id:mime-version:content-type
\r
28 :content-disposition:in-reply-to:user-agent;
\r
29 bh=Q6/SBm0bUlgxQmez8TeE16jCQJUeN80HjUCfmY3YMGQ=;
\r
30 b=c3R9G3P/6EyMVIGag9gMgR8MXA00cTLxxC5FgqZRi8uhO+95ti1cOC9UpTAyjDD3zT
\r
31 SiYnusHaWqphsh2vwf32YK/RxKOlcI8pqxP9Wg6zrJIUl6VJ5RgiAiqRwkuqPUHxhHCp
\r
32 UbZSqIcPZ6022GJFAOhXCKfYzCPyoWXWR3oG7+ilALF7+qRwpxHwcb3mQ8QFVHHreH0F
\r
33 +6KsCa+CKpgWXwbPLqjT6nX376IEmSmefk6qW89Bu9eprTn7FH5GJpb0eeQvRRjXiSLM
\r
34 pZIdJYEcdvpZME3o8ZBbNdJ4584fbfXLf+gS2jz3lARy4PlbLO4xgrqW20+jm34CK43V
\r
36 Received: by 10.180.93.4 with SMTP id cq4mr1948907wib.21.1331936995808;
\r
37 Fri, 16 Mar 2012 15:29:55 -0700 (PDT)
\r
38 Received: from sid.nuvreauspam ([92.86.142.199])
\r
39 by mx.google.com with ESMTPS id ff2sm3576533wib.9.2012.03.16.15.29.53
\r
40 (version=TLSv1/SSLv3 cipher=OTHER);
\r
41 Fri, 16 Mar 2012 15:29:54 -0700 (PDT)
\r
42 Received: by sid.nuvreauspam (Postfix, from userid 1077)
\r
43 id 64014C02EE; Sat, 17 Mar 2012 00:29:52 +0200 (EET)
\r
44 Date: Sat, 17 Mar 2012 00:29:52 +0200
\r
45 From: Andrei POPESCU <andreimpopescu@gmail.com>
\r
46 To: Austin Clements <amdragon@MIT.EDU>, David Bremner <david@tethera.net>
\r
47 Subject: Re: [RFC] http://notmuchmail.org/searching/ [was: Re: Improving
\r
48 notmuch query documentation]
\r
49 Message-ID: <20120316222952.GA4510@sid.nuvreauspam>
\r
51 Content-Type: multipart/signed; micalg=pgp-sha256;
\r
52 protocol="application/pgp-signature"; boundary="xHFwDpU9dbj6ez1V"
\r
53 Content-Disposition: inline
\r
54 In-Reply-To: <87r4wso5d8.fsf@convex-new.cs.unb.ca>
\r
55 <20120316021124.GD2670@mit.edu>
\r
56 User-Agent: Mutt/1.5.21 (2010-09-15)
\r
57 Cc: notmuch@notmuchmail.org
\r
58 X-BeenThere: notmuch@notmuchmail.org
\r
59 X-Mailman-Version: 2.1.13
\r
61 List-Id: "Use and development of the notmuch mail system."
\r
62 <notmuch.notmuchmail.org>
\r
63 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
\r
64 <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
\r
65 List-Archive: <http://notmuchmail.org/pipermail/notmuch>
\r
66 List-Post: <mailto:notmuch@notmuchmail.org>
\r
67 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
\r
68 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
\r
69 <mailto:notmuch-request@notmuchmail.org?subject=subscribe>
\r
70 X-List-Received-Date: Fri, 16 Mar 2012 22:30:00 -0000
\r
74 Content-Type: text/plain; charset=us-ascii
\r
75 Content-Disposition: inline
\r
76 Content-Transfer-Encoding: quoted-printable
\r
78 On Jo, 15 mar 12, 22:11:24, Austin Clements wrote:
\r
79 > Quoth Andrei POPESCU on Mar 16 at 2:30 am:
\r
81 > > $ notmuch help search-terms | wc -l
\r
84 > > IMHO that text is better suited for a manpage, the help should be just =
\r
86 > > (very short) reference to refresh ones memory. What do you think?
\r
88 > I'm not quite sure what you mean. That text is the man page. Though
\r
89 > it sounds like a great idea to have a quick syntax reference at the
\r
90 > top of the manpage so it's the first thing people see when they run
\r
91 > 'notmuch help search-terms' (and they can still scroll down to get the
\r
92 > details if they want).
\r
94 On Vi, 16 mar 12, 13:52:35, David Bremner wrote:
\r
95 > On Fri, 16 Mar 2012 02:30:53 +0200, Andrei POPESCU <andreimpopescu@gmail.=
\r
98 > I'm less worried about the length of the documentation than about
\r
99 > fragmentation. So I think if something is reference material, it should
\r
100 > go in the man pages, or at least ship with notmuch.
\r
102 What I mean is that 'notmuch help search-terms' is too verbose. IMHO=20
\r
103 there should be very good reasons to have it longer than 20 lines or so.=20
\r
104 Instead it's the entire section 'SEARCH SYNTAX' from the manpage.
\r
106 This opinion is based also on what I see around at other terminal=20
\r
107 applications. The '--help' is seldom longer than a few lines and just=20
\r
108 lists the available options and parameters (more like a refresher). The=20
\r
109 manpage then explains them in more detail.
\r
111 As I see it, the manpage (specifically section 'SEARCH SYNTAX' needs to=20
\r
112 be expanded somewhat and 'help search-terms' shortened (a lot).
\r
114 Does this make sense?
\r
119 If you can't explain it simply, you don't understand it well enough.
\r
123 Content-Type: application/pgp-signature; name="signature.asc"
\r
124 Content-Description: Digital signature
\r
126 -----BEGIN PGP SIGNATURE-----
\r
127 Version: GnuPG v1.4.12 (GNU/Linux)
\r
129 iQEcBAEBCAAGBQJPY77gAAoJEHNWs3jeoi3pHeEIAJXTx2q7Hi04Amibtq2VaRqS
\r
130 J6fDpTUVab8YJ3Ou8HFVDxN4KreCo+tOC9AD0ravVo/6qSzXG1U4vAmRNLbWkVRL
\r
131 yrY3BTrGOBUrFwMSsj3X2yY7BrCzkWp0vL/JcnnN/5D2wo5gUv7OU/B5k7vDlh4S
\r
132 G+YcwNy1KoGZaCPaFn1eDjYER9P0yzbyCFQMxc4ZlZbtfJBaY/UQU8F9/HaDXkX4
\r
133 +lwVOUVdkiX1JJedXevrI/NmlWer8QAeoptLavxTvWOaa/TrsuyRfppPPR3+Gexj
\r
134 eLmbSdM6fOy+lytumG7EakQ87m6+Q7vn6PerCcCmhPlxZ44ZQRdN43Jlz6V4EkQ=
\r
136 -----END PGP SIGNATURE-----
\r
138 --xHFwDpU9dbj6ez1V--
\r