Re: [PATCH 0/2] cli: Parsing. Add option NOTMUCH_OPT_INT_OR_BOOLEAN
authorMark Walters <markwalters1009@gmail.com>
Fri, 9 Mar 2012 05:11:54 +0000 (05:11 +0000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:45:20 +0000 (09:45 -0800)
c3/2050071ba5db157a3716db15b9246a0678a62f [new file with mode: 0644]

diff --git a/c3/2050071ba5db157a3716db15b9246a0678a62f b/c3/2050071ba5db157a3716db15b9246a0678a62f
new file mode 100644 (file)
index 0000000..164d946
--- /dev/null
@@ -0,0 +1,141 @@
+Return-Path: <m.walters@qmul.ac.uk>\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 5117C431FB6\r
+       for <notmuch@notmuchmail.org>; Thu,  8 Mar 2012 21:12:00 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+       tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+       NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] 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 wBVw3qVaO9qL for <notmuch@notmuchmail.org>;\r
+       Thu,  8 Mar 2012 21:11:59 -0800 (PST)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 738C7431FAE\r
+       for <notmuch@notmuchmail.org>; Thu,  8 Mar 2012 21:11:59 -0800 (PST)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+       by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1S5s7O-0003sj-FA; Fri, 09 Mar 2012 05:11:54 +0000\r
+Received: from 94-192-233-223.zone6.bethere.co.uk ([94.192.233.223]\r
+       helo=localhost)\r
+       by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1S5s7O-00035u-5D; Fri, 09 Mar 2012 05:11:54 +0000\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 0/2] cli: Parsing. Add option NOTMUCH_OPT_INT_OR_BOOLEAN\r
+In-Reply-To: <87lina8uqk.fsf@nikula.org>\r
+References: <1331244944-7960-1-git-send-email-markwalters1009@gmail.com>\r
+       <87lina8uqk.fsf@nikula.org>\r
+User-Agent: Notmuch/0.11.1+309~g045f9e7 (http://notmuchmail.org) Emacs/23.3.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Fri, 09 Mar 2012 05:11:54 +0000\r
+Message-ID: <87399iicit.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Sender-Host-Address: 94.192.233.223\r
+X-QM-SPAM-Info: Sender has good ham record.  :)\r
+X-QM-Body-MD5: b5e51a92b3f65372ef49311528464ee2 (of first 20000 bytes)\r
+X-SpamAssassin-Score: -1.8\r
+X-SpamAssassin-SpamBar: -\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+       determine if it is\r
+       spam. We require at least 5.0 points to mark a message as spam.\r
+       This message scored -1.8 points.\r
+       Summary of the scoring: \r
+       * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
+       *      medium trust\r
+       *      [138.37.6.40 listed in list.dnswl.org]\r
+       * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+       provider *      (markwalters1009[at]gmail.com)\r
+       * -0.0 T_RP_MATCHES_RCVD Envelope sender domain matches handover relay\r
+       *      domain\r
+       *  0.5 AWL AWL: From: address is in the auto white-list\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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: Fri, 09 Mar 2012 05:12:00 -0000\r
+\r
+\r
+Hi\r
+\r
+On Fri, 09 Mar 2012 02:48:35 +0200, Jani Nikula <jani@nikula.org> wrote:\r
+> On Thu,  8 Mar 2012 22:15:42 +0000, Mark Walters <markwalters1009@gmail.com> wrote:\r
+> > The first patch adds a new command line parsing option\r
+> > NOTMUCH_OPT_INT_OR_BOOLEAN for command line parsing which accepts\r
+> > --verbose=3 and --verbose with the latter setting verbose to 1. It\r
+> > also allows --verbose=0 so (with a little caller support) the user can\r
+> > turn off boolean options.\r
+> > \r
+> > It also means that extra options can be added to the command line\r
+> > programs in a backwards compatible manner (e.g. if --verbose already\r
+> > exists we could add --verbose=2).\r
+> > \r
+> > The second patch uses this to make the --entire-thread option to\r
+> > notmuch-show a NOTMUCH_OPT_INT_OR_BOOLEAN. In particular this allows\r
+> > the caller to disable --entire-thread (with --entire-thread=0) when\r
+> > format=json.\r
+> \r
+> I'm afraid I find both of the patches a bit hacky. The first because\r
+> it's more about optional arguments to options than int-or-bool. The\r
+> second because it's more about detecting whether the user has provided\r
+> an option than int-or-bool.\r
+\r
+Yes to both of these (although I don't think of it has hacky). The\r
+second of these is the important consideration.\r
+\r
+> For booleans, I think the notmuch style would be to allow --foo=true and\r
+> --foo=false in addition to just --foo (which implies true) so you could\r
+> also disable booleans. I think this would be fairly simple to implement,\r
+> and would require no changes to option parser users.\r
+>\r
+> With --entire-thread the bigger problem is detecting whether the option\r
+> was specified by the user or not. It would be great if the option parser\r
+> could provide this information, but it might take a while to get\r
+> there... In the mean time, I think I would rather see a well commented\r
+> local hack here initializing the notmuch_bool_t params.entire_thread to\r
+> -1, and changing it to TRUE or FALSE if not already done so by\r
+> parse_arguments().\r
+\r
+I think these need to be considered together. There are three important\r
+possibilities for a boolean option foo: 1) foo not mentioned 2)\r
+--foo=false and 3) --foo=true (--foo as an alias) but the parser only\r
+has a boolean to store this in. We could overload the boolean as you\r
+suggest (it is really an int so should be safe) but that does seem\r
+hacky. \r
+\r
+That was why I decided to make the parser set an int rather than a\r
+boolean. Since there are not very many OPT_BOOLEANs currently in the\r
+code I think my decision to allow general ints to be returned is a\r
+needless extension, but I do think we wish to allow the 3 states of\r
+UNSET, FALSE and TRUE. Otherwise we limit any future boolean options to\r
+always have the same default regardless of other settings.\r
+\r
+If people are happy with setting a notmuch_bool_t to -1 (for unset) then\r
+that is definitely the simplest option. Or if people think that default\r
+boolean options should not depend on other options then we can just add\r
+this hack for --entire-thread.\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r
+\r