Re: [PATCH] cli: make the command line parser's errors more informative.
authorMark Walters <markwalters1009@gmail.com>
Tue, 5 Jun 2012 14:34:19 +0000 (15:34 +0100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:47:37 +0000 (09:47 -0800)
2f/daf00aff5424ae7b22c8852f0699624c86d714 [new file with mode: 0644]

diff --git a/2f/daf00aff5424ae7b22c8852f0699624c86d714 b/2f/daf00aff5424ae7b22c8852f0699624c86d714
new file mode 100644 (file)
index 0000000..df78234
--- /dev/null
@@ -0,0 +1,146 @@
+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 F089E431FAF\r
+       for <notmuch@notmuchmail.org>; Tue,  5 Jun 2012 07:34:21 -0700 (PDT)\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 338a2AplJeSk for <notmuch@notmuchmail.org>;\r
+       Tue,  5 Jun 2012 07:34:21 -0700 (PDT)\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 4CFDB431FAE\r
+       for <notmuch@notmuchmail.org>; Tue,  5 Jun 2012 07:34:21 -0700 (PDT)\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 1Sbupt-00063f-9m; Tue, 05 Jun 2012 15:34:17 +0100\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 1Sbups-0007lf-Vv; Tue, 05 Jun 2012 15:34:17 +0100\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: Peter Wang <novalazy@gmail.com>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH] cli: make the command line parser's errors more\r
+       informative.\r
+In-Reply-To: <20120605184037.GB14297@hili.localdomain>\r
+References: <1338723972-13063-1-git-send-email-markwalters1009@gmail.com>\r
+       <1338724128-13158-1-git-send-email-markwalters1009@gmail.com>\r
+       <20120605184037.GB14297@hili.localdomain>\r
+User-Agent: Notmuch/0.13+55~g992aa73 (http://notmuchmail.org) Emacs/23.3.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Tue, 05 Jun 2012 15:34:19 +0100\r
+Message-ID: <87oboxakus.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: a79baf0f0899e319b14bb1c657376935 (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: Tue, 05 Jun 2012 14:34:22 -0000\r
+\r
+\r
+On Tue, 05 Jun 2012, Peter Wang <novalazy@gmail.com> wrote:\r
+> On Sun,  3 Jun 2012 12:48:48 +0100, Mark Walters <markwalters1009@gmail.com> wrote:\r
+>>  \r
+>> +static notmuch_bool_t\r
+>> +_process_int_arg (const notmuch_opt_desc_t *arg_desc, char next, const char *arg_str) {\r
+>> +\r
+>> +    char *endptr;\r
+>> +    if (next == 0 || arg_str[0] == 0) {\r
+>> +   fprintf (stderr, "Option \"%s\" needs an integer argument.\n", arg_desc->name);\r
+>> +   return FALSE;\r
+>> +    }\r
+>> +\r
+>> +    *((int *)arg_desc->output_var) = strtol (arg_str, &endptr, 10);\r
+>> +    if (*endptr == 0)\r
+>> +   return TRUE;\r
+>\r
+> It's usually clearer to write '\0' for the null character.\r
+\r
+Yes I agree: fixed. I also changed the other instances.\r
+\r
+>> @@ -99,20 +133,13 @@ parse_option (const char *arg,\r
+>>         char next = arg[strlen (try->name)];\r
+>>         const char *value= arg+strlen(try->name)+1;\r
+>>  \r
+>> -       char *endptr;\r
+>> -\r
+>> -       /* Everything but boolean arguments (switches) needs a\r
+>> -        * delimiter, and a non-zero length value. Boolean\r
+>> -        * arguments may take an optional =true or =false value.\r
+>> -        */\r
+>> -       if (next != '=' && next != ':' && next != 0) return FALSE;\r
+>> -       if (next == 0) {\r
+>> -           if (try->opt_type != NOTMUCH_OPT_BOOLEAN &&\r
+>> -               try->opt_type != NOTMUCH_OPT_KEYWORD)\r
+>> -               return FALSE;\r
+>> -       } else {\r
+>> -           if (value[0] == 0) return FALSE;\r
+>> -       }\r
+>> +       /* If this is not the end of the argument (i.e. the next\r
+>> +        * character is not a space or a delimiter) we stop\r
+>> +        * parsing for this option but allow the parsing to\r
+>> +        * continue to for other options. This should allow\r
+>> +        * options to be initial segments of other options. */\r
+>\r
+> It took me a little while to figure out what the last sentence was\r
+> about.  Perhaps:\r
+>\r
+>     If we have not reached the end of the argument (i.e. the next\r
+>     character is not a space or delimiter) then the argument could\r
+>     still match a longer option name later in the option table.\r
+\r
+This is much clearer, thanks!\r
+\r
+> (otherwise, "continue to for other")\r
+>\r
+>> +       if (next != '=' && next != ':' && next != 0)\r
+>> +           goto DONE_THIS_OPTION;\r
+>\r
+> The `goto' could be expressed as a `continue' in a `for' loop, AFAICS.\r
+\r
+This is also much nicer. Updated patch follows\r
+\r
+Thanks for the review!\r
+\r
+Best wishes\r
+\r
+Mark\r