From: Mark Walters Date: Wed, 13 Feb 2013 07:51:19 +0000 (+0000) Subject: Re: [PATCH 0/6] notmuch cli config changes X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=563b35ee6a052e212c6e52c9619f1d65cd19feb6;p=notmuch-archives.git Re: [PATCH 0/6] notmuch cli config changes --- diff --git a/37/d3924a0534c64ab248dd1884e6069a3e3a17c8 b/37/d3924a0534c64ab248dd1884e6069a3e3a17c8 new file mode 100644 index 000000000..1ae9b8537 --- /dev/null +++ b/37/d3924a0534c64ab248dd1884e6069a3e3a17c8 @@ -0,0 +1,107 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 38751431FC9 + for ; Tue, 12 Feb 2013 23:51:23 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -1.098 +X-Spam-Level: +X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5 + tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001, + NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id HG5tcQjSoZXp for ; + Tue, 12 Feb 2013 23:51:22 -0800 (PST) +Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 86F5F431FC7 + for ; Tue, 12 Feb 2013 23:51:22 -0800 (PST) +Received: from smtp.qmul.ac.uk ([138.37.6.40]) + by mail2.qmul.ac.uk with esmtp (Exim 4.71) + (envelope-from ) + id 1U5X7a-0003mF-DM; Wed, 13 Feb 2013 07:51:15 +0000 +Received: from 93-97-24-31.zone5.bethere.co.uk ([93.97.24.31] helo=localhost) + by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71) + (envelope-from ) + id 1U5X7Y-00029S-Ng; Wed, 13 Feb 2013 07:51:14 +0000 +From: Mark Walters +To: David Bremner , + Jameson Graef Rollins , + Jani Nikula , notmuch@notmuchmail.org +Subject: Re: [PATCH 0/6] notmuch cli config changes +In-Reply-To: <87pq05icse.fsf@convex-new.cs.unb.ca> +References: + <871ucts54t.fsf@servo.finestructure.net> + <87y5f0fhtd.fsf@zancas.localnet> + <87fw12nf7w.fsf@servo.finestructure.net> + <87k3qd92sw.fsf@zancas.localnet> + <87a9r9o4ks.fsf@servo.finestructure.net> + <87pq05icse.fsf@convex-new.cs.unb.ca> +User-Agent: Notmuch/0.14+255~gff3cc55 (http://notmuchmail.org) Emacs/23.4.1 + (x86_64-pc-linux-gnu) +Date: Wed, 13 Feb 2013 07:51:19 +0000 +Message-ID: <87liaslki0.fsf@qmul.ac.uk> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +X-Sender-Host-Address: 93.97.24.31 +X-QM-SPAM-Info: Sender has good ham record. :) +X-QM-Body-MD5: 7dd74e3e182730a3e9dbc78d230f706c (of first 20000 bytes) +X-SpamAssassin-Score: -1.8 +X-SpamAssassin-SpamBar: - +X-SpamAssassin-Report: The QM spam filters have analysed this message to + determine if it is + spam. We require at least 5.0 points to mark a message as spam. + This message scored -1.8 points. + Summary of the scoring: + * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/, + * medium trust + * [138.37.6.40 listed in list.dnswl.org] + * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail + provider * (markwalters1009[at]gmail.com) + * 0.5 AWL AWL: From: address is in the auto white-list +X-QM-Scan-Virus: ClamAV says the message is clean +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Wed, 13 Feb 2013 07:51:23 -0000 + + +> Jameson Graef Rollins writes: +> +>> But don't get me wrong, the CLI is one of the things that makes notmuch +>> so incredibly awesome. It's an email swiss army knife that's there when +>> you need it. But given that even I often need to look at the man page +>> during my occasional CLI usage, I just don't want to see it get to +>> overcrowded. +> +> Well, maybe this should be a discussion about how to organize the CLI +> documentation so that more commonly used options are easy to find. That +> would indeed be a side effect of making less commonly used options +> controlled by environment variables, and documenting the environment +> variables at the bottom of the man pages as per tradition. But I don't +> think this is the only way or even the best way to achieve good +> documentation. + +I think one of the problems for documentation is that we have two +classes of "user" of the cli: one is actually people and one is front +ends (and yes scripting does blur the boundary). Would it be worth +splitting based on that. For example, the --format-version is really +only for front-end use. --format=text is for human use, whereas the +other options are mostly front-end (text0 might be an exception) + +Best wishes + +Mark