37/d3924a0534c64ab248dd1884e6069a3e3a17c8

   1 Return-Path: <m.walters@qmul.ac.uk>\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 38751431FC9\r
   6         for <notmuch@notmuchmail.org>; Tue, 12 Feb 2013 23:51:23 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -1.098\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
  12         tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
  13         NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
  14 Received: from olra.theworths.org ([127.0.0.1])\r
  15         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  16         with ESMTP id HG5tcQjSoZXp for <notmuch@notmuchmail.org>;\r
  17         Tue, 12 Feb 2013 23:51:22 -0800 (PST)\r
  18 Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
  19         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id 86F5F431FC7\r
  22         for <notmuch@notmuchmail.org>; Tue, 12 Feb 2013 23:51:22 -0800 (PST)\r
  23 Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
  24         by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
  25         (envelope-from <m.walters@qmul.ac.uk>)\r
  26         id 1U5X7a-0003mF-DM; Wed, 13 Feb 2013 07:51:15 +0000\r
  27 Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost)\r
  28         by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71)\r
  29         (envelope-from <m.walters@qmul.ac.uk>)\r
  30         id 1U5X7Y-00029S-Ng; Wed, 13 Feb 2013 07:51:14 +0000\r
  31 From: Mark Walters <markwalters1009@gmail.com>\r
  32 To: David Bremner <david@tethera.net>,\r
  33         Jameson Graef Rollins <jrollins@finestructure.net>,\r
  34         Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org\r
  35 Subject: Re: [PATCH 0/6] notmuch cli config changes\r
  36 In-Reply-To: <87pq05icse.fsf@convex-new.cs.unb.ca>\r
  37 References: <cover.1359495450.git.jani@nikula.org>\r
  38         <871ucts54t.fsf@servo.finestructure.net>\r
  39         <87y5f0fhtd.fsf@zancas.localnet>\r
  40         <87fw12nf7w.fsf@servo.finestructure.net>\r
  41         <87k3qd92sw.fsf@zancas.localnet>\r
  42         <87a9r9o4ks.fsf@servo.finestructure.net>\r
  43         <87pq05icse.fsf@convex-new.cs.unb.ca>\r
  44 User-Agent: Notmuch/0.14+255~gff3cc55 (http://notmuchmail.org) Emacs/23.4.1\r
  45         (x86_64-pc-linux-gnu)\r
  46 Date: Wed, 13 Feb 2013 07:51:19 +0000\r
  47 Message-ID: <87liaslki0.fsf@qmul.ac.uk>\r
  48 MIME-Version: 1.0\r
  49 Content-Type: text/plain; charset=us-ascii\r
  50 X-Sender-Host-Address: 93.97.24.31\r
  51 X-QM-SPAM-Info: Sender has good ham record.  :)\r
  52 X-QM-Body-MD5: 7dd74e3e182730a3e9dbc78d230f706c (of first 20000 bytes)\r
  53 X-SpamAssassin-Score: -1.8\r
  54 X-SpamAssassin-SpamBar: -\r
  55 X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
  56         determine if it is\r
  57         spam. We require at least 5.0 points to mark a message as spam.\r
  58         This message scored -1.8 points.\r
  59         Summary of the scoring: \r
  60         * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
  61         *      medium trust\r
  62         *      [138.37.6.40 listed in list.dnswl.org]\r
  63         * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
  64         provider *      (markwalters1009[at]gmail.com)\r
  65         *  0.5 AWL AWL: From: address is in the auto white-list\r
  66 X-QM-Scan-Virus: ClamAV says the message is clean\r
  67 X-BeenThere: notmuch@notmuchmail.org\r
  68 X-Mailman-Version: 2.1.13\r
  69 Precedence: list\r
  70 List-Id: "Use and development of the notmuch mail system."\r
  71         <notmuch.notmuchmail.org>\r
  72 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  73         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  74 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  75 List-Post: <mailto:notmuch@notmuchmail.org>\r
  76 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  77 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  78         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  79 X-List-Received-Date: Wed, 13 Feb 2013 07:51:23 -0000\r
  80 \r
  81 \r
  82 > Jameson Graef Rollins <jrollins@finestructure.net> writes:\r
  83 >\r
  84 >> But don't get me wrong, the CLI is one of the things that makes notmuch\r
  85 >> so incredibly awesome.  It's an email swiss army knife that's there when\r
  86 >> you need it.  But given that even I often need to look at the man page\r
  87 >> during my occasional CLI usage, I just don't want to see it get to\r
  88 >> overcrowded.\r
  89 >\r
  90 > Well, maybe this should be a discussion about how to organize the CLI\r
  91 > documentation so that more commonly used options are easy to find. That\r
  92 > would indeed be a side effect of making less commonly used options\r
  93 > controlled by environment variables, and documenting the environment\r
  94 > variables at the bottom of the man pages as per tradition. But I don't\r
  95 > think this is the only way or even the best way to achieve good\r
  96 > documentation.\r
  97 \r
  98 I think one of the problems for documentation is that we have two\r
  99 classes of "user" of the cli: one is actually people and one is front\r
 100 ends (and yes scripting does blur the boundary). Would it be worth\r
 101 splitting based on that. For example, the --format-version is really\r
 102 only for front-end use. --format=text is for human use, whereas the\r
 103 other options are mostly front-end (text0 might be an exception)\r
 104 \r
 105 Best wishes\r
 106 \r
 107 Mark\r