Re: [PATCH 4/5] cli: move show to the new --exclude= option naming scheme.

diff --git a/63/8530b6255e70bbd7c0d43599525eb8782ed716 b/63/8530b6255e70bbd7c0d43599525eb8782ed716
new file mode 100644 (file)
index 0000000..1f0f316
--- /dev/null
+++ b/63/8530b6255e70bbd7c0d43599525eb8782ed716
@@ -0,0 +1,283 @@
+Return-Path: <amdragon@mit.edu>\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 C43AF431FB6\r
+       for <notmuch@notmuchmail.org>; Sat, 17 Mar 2012 09:51:23 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 NvAj79+wpn3Q for <notmuch@notmuchmail.org>;\r
+       Sat, 17 Mar 2012 09:51:23 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-5.mit.edu (DMZ-MAILSEC-SCANNER-5.MIT.EDU\r
+       [18.7.68.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id DA6D2431FAE\r
+       for <notmuch@notmuchmail.org>; Sat, 17 Mar 2012 09:51:22 -0700 (PDT)\r
+X-AuditID: 12074422-b7fd66d0000008f9-d3-4f64c10a1ec3\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+       by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 03.7B.02297.A01C46F4; Sat, 17 Mar 2012 12:51:22 -0400 (EDT)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id q2HGpLmA013802; \r
+       Sat, 17 Mar 2012 12:51:22 -0400\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q2HGpKaZ012098\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Sat, 17 Mar 2012 12:51:21 -0400 (EDT)\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1S8wqe-000476-95; Sat, 17 Mar 2012 12:51:20 -0400\r
+Date: Sat, 17 Mar 2012 12:51:20 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Mark Walters <markwalters1009@gmail.com>\r
+Subject: Re: [PATCH 4/5] cli: move show to the new --exclude= option naming\r
+       scheme.\r
+Message-ID: <20120317165119.GI2670@mit.edu>\r
+References: <1331836925-31437-1-git-send-email-markwalters1009@gmail.com>\r
+       <1331836925-31437-5-git-send-email-markwalters1009@gmail.com>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <1331836925-31437-5-git-send-email-markwalters1009@gmail.com>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFupjleLIzCtJLcpLzFFi42IR4hRV1uU6mOJvsP6psMXquTwW12/OZHZg\r
+       8tg56y67x7NVt5gDmKK4bFJSczLLUov07RK4MuZ/6GUv2GRTsfNCJ2MD4z/dLkZODgkBE4lF\r
+       29cyQdhiEhfurWfrYuTiEBLYxyhxqOE0C4SzgVHi8s11zBDOSSaJUy2boDJLGCWmfpnHBtLP\r
+       IqAqcWzBQrBZbAIaEtv2L2cEsUUEdCRuH1rADmIzC0hLfPvdDFYjLBAq0fZuHVAvBwevgLbE\r
+       jCYxiJmdjBK33k0Cq+cVEJQ4OfMJC0SvlsSNfy+ZQOpB5iz/xwFicgp4SUz9oAJSISqgIjHl\r
+       5Da2CYxCs5A0z0LSPAuheQEj8ypG2ZTcKt3cxMyc4tRk3eLkxLy81CJdU73czBK91JTSTYyg\r
+       oGZ3UdrB+POg0iFGAQ5GJR5ejgnJ/kKsiWXFlbmHGCU5mJREeRkPpPgL8SXlp1RmJBZnxBeV\r
+       5qQWH2KU4GBWEuGVWg6U401JrKxKLcqHSUlzsCiJ86prvfMTEkhPLEnNTk0tSC2CycpwcChJ\r
+       8PqADBUsSk1PrUjLzClBSDNxcIIM5wEa7gpSw1tckJhbnJkOkT/FqMvRPfXRJUYhlrz8vFQp\r
+       cV5TkCIBkKKM0jy4ObBk9IpRHOgtYd44kCoeYCKDm/QKaAkT0JKZZckgS0oSEVJSDYyzV7Ww\r
+       S+zQmG2l03jspfwURdt/Ag4h+yas/XL1C7vL/wd6ddrBS65dNudp55fkLefdqz/h69WXQW8M\r
+       BCYIZH640vVxmbWW7ZxFe0IuzLrqdIY7Iv7UyStOrS9XfTWNWyW9+LDXbe+cnwvfr4rcmH7g\r
+       nWmABHtb8pRszRtSCl1skXe51/WlP9ukxFKckWioxVxUnAgAFMAwgCEDAAA=\r
+Cc: notmuch@notmuchmail.org\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: Sat, 17 Mar 2012 16:51:23 -0000\r
+\r
+Quoth Mark Walters on Mar 15 at  6:42 pm:\r
+> This moves show to the --exclude=(true|false|flag) naming\r
+> scheme. When `exclude' is false or flag show returns all threads\r
+> that match including those that only match in an excluded message, the\r
+> difference being whether excluded messages are flagged excluded.\r
+> \r
+> When exclude=true the behaviour depends on whether --entire-threads\r
+\r
+s/--entire-threads/--entire-thread/\r
+\r
+> is set. If it is not set then show only returns the messages which\r
+> match and are not excluded. If it is set then show returns all\r
+> messages in these threads flagging the excluded messages. The\r
+\r
+Parse error.\r
+\r
+> rationale is that it is awkward to use a thread with some missing\r
+> messages.\r
+> ---\r
+>  man/man1/notmuch-show.1 |   16 ++++++++++++++--\r
+>  notmuch-client.h        |    1 +\r
+>  notmuch-show.c          |   39 +++++++++++++++++++++++++++++----------\r
+>  3 files changed, 44 insertions(+), 12 deletions(-)\r
+> \r
+> diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1\r
+> index d75d971..801b7f1 100644\r
+> --- a/man/man1/notmuch-show.1\r
+> +++ b/man/man1/notmuch-show.1\r
+> @@ -130,9 +130,21 @@ content.\r
+>  \r
+>  .RS 4\r
+>  .TP 4\r
+> -.B \-\-no-exclude\r
+> +.BR \-\-exclude=(true|false|flag)\r
+> +\r
+> +Specify whether to omit threads only matching search.tag_exclude from\r
+> +the search results (the default) or not. The extra option\r
+> +.B flag\r
+> +includes these messages but marks them with the excluded flag.\r
+> +\r
+> +If --entire-thread is specified then complete threads are returned\r
+> +regardless (with the excluded flag being set when appropriate) but\r
+> +threads that only match in an excluded message are not returned when\r
+> +.B --exclude=true.\r
+\r
+I found this a bit confusing.  There are two orthogonal things going\r
+on here: what happens to excluded messages and what happens to\r
+fully-excluded threads.  Is the following table accurate?\r
+\r
+         --entire-thread=false\r
+      excl. messages   excl. threads\r
+true       omit            omit\r
+false    include         include\r
+flag   include,flag      include\r
+\r
+         --entire-thread=true\r
+      excl. messages   excl. threads\r
+true   include,flag        omit\r
+false    include         include\r
+flag   include,flag      include\r
+\r
+(My reasoning: --exclude=false is equivalent to not having any\r
+excludes configured, --exclude=true omits excluded messages from the\r
+seed set and filters them in show_messages, --exclude=flag does not\r
+exclude messages from the seed set nor filter them in show_messages.)\r
+\r
+If this is right, then what's the point of having both false and flag\r
+for show?  I'm pretty sure their performance will be\r
+indistinguishable.\r
+\r
+> +\r
+> +The default is\r
+> +.B --exclude=true.\r
+>  \r
+> -Do not exclude the messages matching search.exclude_tags in the config file.\r
+>  .RE\r
+>  \r
+>  A common use of\r
+> diff --git a/notmuch-client.h b/notmuch-client.h\r
+> index f4a62cc..e36148b 100644\r
+> --- a/notmuch-client.h\r
+> +++ b/notmuch-client.h\r
+> @@ -99,6 +99,7 @@ typedef struct notmuch_show_format {\r
+>  \r
+>  typedef struct notmuch_show_params {\r
+>      notmuch_bool_t entire_thread;\r
+> +    notmuch_bool_t omit_excluded;\r
+>      notmuch_bool_t raw;\r
+>      int part;\r
+>  #ifdef GMIME_ATLEAST_26\r
+> diff --git a/notmuch-show.c b/notmuch-show.c\r
+> index 05d51b2..20d6635 100644\r
+> --- a/notmuch-show.c\r
+> +++ b/notmuch-show.c\r
+> @@ -812,6 +812,7 @@ show_messages (void *ctx,\r
+>  {\r
+>      notmuch_message_t *message;\r
+>      notmuch_bool_t match;\r
+> +    notmuch_bool_t excluded;\r
+>      int first_set = 1;\r
+>      int next_indent;\r
+>  \r
+> @@ -830,10 +831,11 @@ show_messages (void *ctx,\r
+>      message = notmuch_messages_get (messages);\r
+>  \r
+>      match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);\r
+> +    excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);\r
+>  \r
+>      next_indent = indent;\r
+>  \r
+> -    if (match || params->entire_thread) {\r
+> +    if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {\r
+>          show_message (ctx, format, message, indent, params);\r
+>          next_indent = indent + 1;\r
+>  \r
+> @@ -974,6 +976,12 @@ enum {\r
+>      NOTMUCH_FORMAT_RAW\r
+>  };\r
+>  \r
+> +enum {\r
+> +    EXCLUDE_TRUE,\r
+> +    EXCLUDE_FALSE,\r
+> +    EXCLUDE_FLAG,\r
+> +};\r
+> +\r
+>  int\r
+>  notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+>  {\r
+> @@ -983,10 +991,10 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+>      char *query_string;\r
+>      int opt_index, ret;\r
+>      const notmuch_show_format_t *format = &format_text;\r
+> -    notmuch_show_params_t params = { .part = -1 };\r
+> +    notmuch_show_params_t params = { .part = -1, .omit_excluded = TRUE };\r
+>      int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;\r
+>      notmuch_bool_t verify = FALSE;\r
+> -    notmuch_bool_t no_exclude = FALSE;\r
+> +    int exclude = EXCLUDE_TRUE;\r
+>  \r
+>      notmuch_opt_desc_t options[] = {\r
+>      { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',\r
+> @@ -995,11 +1003,15 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+>                                { "mbox", NOTMUCH_FORMAT_MBOX },\r
+>                                { "raw", NOTMUCH_FORMAT_RAW },\r
+>                                { 0, 0 } } },\r
+> +        { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',\r
+> +          (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },\r
+> +                                  { "false", EXCLUDE_FALSE },\r
+> +                                  { "flag", EXCLUDE_FLAG },\r
+> +                                  { 0, 0 } } },\r
+>      { NOTMUCH_OPT_INT, &params.part, "part", 'p', 0 },\r
+>      { NOTMUCH_OPT_BOOLEAN, &params.entire_thread, "entire-thread", 't', 0 },\r
+>      { NOTMUCH_OPT_BOOLEAN, &params.decrypt, "decrypt", 'd', 0 },\r
+>      { NOTMUCH_OPT_BOOLEAN, &verify, "verify", 'v', 0 },\r
+> -    { NOTMUCH_OPT_BOOLEAN, &no_exclude, "no-exclude", 'n', 0 },\r
+>      { 0, 0, 0, 0, 0 }\r
+>      };\r
+>  \r
+> @@ -1088,16 +1100,18 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+>      return 1;\r
+>      }\r
+>  \r
+> -    /* if format=mbox then we can not output excluded messages as\r
+> -     * there is no way to make the exclude flag available */\r
+> -    if (format_sel == NOTMUCH_FORMAT_MBOX)\r
+> -    notmuch_query_set_omit_excluded_messages (query, TRUE);\r
+> -\r
+>      /* If a single message is requested we do not use search_excludes. */\r
+>      if (params.part >= 0)\r
+>      ret = do_show_single (ctx, query, format, &params);\r
+>      else {\r
+> -    if (!no_exclude) {\r
+> +    if (format == &format_mbox && exclude == EXCLUDE_FLAG) {\r
+> +        /* there is no where to mark flagged messages so fall back on\r
+\r
+s/no where/nowhere/  Also, s/there/There/ for style consistency.\r
+\r
+> +         * including the excluded messages */\r
+> +        fprintf (stderr, "Cannot flag excluded messages with format=mbox: fall back on just including them\n");\r
+\r
+This is a bit verbose.  How about just "Warning: mbox cannot flag\r
+excluded messages"?  Flag already means that the messages should be\r
+included, so this message states exactly what mbox isn't doing that\r
+you might expect it to.\r
+\r
+> +        exclude = EXCLUDE_FALSE;\r
+> +    }\r
+> +\r
+> +    if (exclude != EXCLUDE_FALSE) {\r
+>          const char **search_exclude_tags;\r
+>          size_t search_exclude_tags_length;\r
+>          unsigned int i;\r
+> @@ -1106,7 +1120,12 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))\r
+>              (config, &search_exclude_tags_length);\r
+>          for (i = 0; i < search_exclude_tags_length; i++)\r
+>              notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);\r
+> +        if (exclude == EXCLUDE_FLAG) {\r
+> +            notmuch_query_set_omit_excluded_messages(query, FALSE);\r
+> +            params.omit_excluded = FALSE;\r
+> +        }\r
+>      }\r
+> +\r
+>      ret = do_show (ctx, query, format, &params);\r
+>      }\r
+>  \r