Re: [PATCH 8/8] emacs: Remove interactive behavior of `notmuch-tag'
authorAustin Clements <amdragon@MIT.EDU>
Tue, 12 Nov 2013 23:18:17 +0000 (18:18 +1900)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:58:15 +0000 (09:58 -0800)
74/7aadc0f76f7e2ee1e092ac46ebbf8ecb20cab9 [new file with mode: 0644]

diff --git a/74/7aadc0f76f7e2ee1e092ac46ebbf8ecb20cab9 b/74/7aadc0f76f7e2ee1e092ac46ebbf8ecb20cab9
new file mode 100644 (file)
index 0000000..8b5f758
--- /dev/null
@@ -0,0 +1,204 @@
+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 ACDFD431FD7\r
+       for <notmuch@notmuchmail.org>; Tue, 12 Nov 2013 15:18:26 -0800 (PST)\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 XmqYAmR2v1iX for <notmuch@notmuchmail.org>;\r
+       Tue, 12 Nov 2013 15:18:21 -0800 (PST)\r
+Received: from dmz-mailsec-scanner-6.mit.edu (dmz-mailsec-scanner-6.mit.edu\r
+       [18.7.68.35])\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 E1292431FCF\r
+       for <notmuch@notmuchmail.org>; Tue, 12 Nov 2013 15:18:20 -0800 (PST)\r
+X-AuditID: 12074423-b7f2b6d000000ce1-d9-5282b73c0979\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id D7.75.03297.C37B2825; Tue, 12 Nov 2013 18:18:20 -0500 (EST)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id rACNIIHa012266; \r
+       Tue, 12 Nov 2013 18:18:19 -0500\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.8/8.12.4) with ESMTP id rACNIHIZ001869\r
+       (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NOT);\r
+       Tue, 12 Nov 2013 18:18:18 -0500\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.80)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1VgNDt-0007DC-46; Tue, 12 Nov 2013 18:18:17 -0500\r
+Date: Tue, 12 Nov 2013 18:18:17 -0500\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Jameson Graef Rollins <jrollins@finestructure.net>\r
+Subject: Re: [PATCH 8/8] emacs: Remove interactive behavior of `notmuch-tag'\r
+Message-ID: <20131112231817.GE13399@mit.edu>\r
+References: <1382471457-26056-1-git-send-email-amdragon@mit.edu>\r
+       <1382471457-26056-9-git-send-email-amdragon@mit.edu>\r
+       <8761s9gfpm.fsf@servo.finestructure.net>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <8761s9gfpm.fsf@servo.finestructure.net>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFmpileLIzCtJLcpLzFFi42IR4hRV1rXZ3hRkMG8Or8WefV4W12/OZHZg\r
+       8rh7msvj2apbzAFMUVw2Kak5mWWpRfp2CVwZOz5/YC9o06mYd30uSwNjn3IXIyeHhICJxO1d\r
+       G5ggbDGJC/fWs3UxcnEICcxmkpi0+hM7hLORUeLfuh1QmdNMElseb2KGcJYAZY4eZQbpZxFQ\r
+       lfj+eTnYLDYBDYlt+5czgtgiAmYSPV/+gNnMAtIS3343A9VwcAgL+EhsmsQLEuYV0JE43b2b\r
+       CWLmIkaJM3+Xs0MkBCVOznzCAtGrJXHj30uwXpA5y/9xgIQ5BUwl9r7exgZiiwqoSEw5uY1t\r
+       AqPQLCTds5B0z0LoXsDIvIpRNiW3Sjc3MTOnODVZtzg5MS8vtUjXTC83s0QvNaV0EyMoqNld\r
+       lHcw/jmodIhRgINRiYfXIqYpSIg1say4MvcQoyQHk5Ior/xWoBBfUn5KZUZicUZ8UWlOavEh\r
+       RgkOZiUR3gMgOd6UxMqq1KJ8mJQ0B4uSOO8tDvsgIYH0xJLU7NTUgtQimKwMB4eSBG8KSKNg\r
+       UWp6akVaZk4JQpqJgxNkOA/Q8Daw4cUFibnFmekQ+VOMilLivEu3ASUEQBIZpXlwvbCk84pR\r
+       HOgVYV4GkCoeYMKC634FNJgJaLBFMdjgkkSElFQDI8tsv3aF7zW2Ow4qvlghNalK567jjkN2\r
+       IheDz6rOeMRgcOBY+cYrzDEuygduavzSEPi/LiHNJFnSXPpE77LLNgv0Cq7s+Ne7spKF477w\r
+       FTm+Zz+489livZb4XJ1wKk13Qkn6j+45x/Tnsds1Vhnzbi60tRFZk/Dq4uumVYVSd1X6ov+o\r
+       StmtVmIpzkg01GIuKk4EAAr6cJ0VAwAA\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: Tue, 12 Nov 2013 23:18:26 -0000\r
+\r
+Quoth Jameson Graef Rollins on Nov 03 at  4:42 pm:\r
+> On Tue, Oct 22 2013, Austin Clements <amdragon@MIT.EDU> wrote:\r
+> > We no longer use this, since we've lifted all interactive behavior to\r
+> > the appropriate interactive entry points.  Because of this,\r
+> > `notmuch-tag' also no longer needs to return the tag changes list,\r
+> > since the caller always passes it in.\r
+> > ---\r
+> >  emacs/notmuch-tag.el | 19 ++++---------------\r
+> >  1 file changed, 4 insertions(+), 15 deletions(-)\r
+> >\r
+> > diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el\r
+> > index f9c1740..feee17c 100644\r
+> > --- a/emacs/notmuch-tag.el\r
+> > +++ b/emacs/notmuch-tag.el\r
+> > @@ -249,27 +249,18 @@ from TAGS if present."\r
+> >       (error "Changed tag must be of the form `+this_tag' or `-that_tag'")))))\r
+> >      (sort result-tags 'string<)))\r
+> >  \r
+> > -(defun notmuch-tag (query &optional tag-changes)\r
+> > +(defun notmuch-tag (query tag-changes)\r
+> >    "Add/remove tags in TAG-CHANGES to messages matching QUERY.\r
+> >  \r
+> >  QUERY should be a string containing the search-terms.\r
+> > -TAG-CHANGES can take multiple forms.  If TAG-CHANGES is a list of\r
+> > -strings of the form \"+tag\" or \"-tag\" then those are the tag\r
+> > -changes applied.  If TAG-CHANGES is a string then it is\r
+> > -interpreted as a single tag change.  If TAG-CHANGES is the string\r
+> > -\"-\" or \"+\", or null, then the user is prompted to enter the\r
+> > -tag changes.\r
+> > +TAG-CHANGES is a list of strings of the form \"+tag\" or\r
+> > +\"-tag\" to add or remove tags, respectively.\r
+> >  \r
+> >  Note: Other code should always use this function alter tags of\r
+> >  messages instead of running (notmuch-call-notmuch-process \"tag\" ..)\r
+> >  directly, so that hooks specified in notmuch-before-tag-hook and\r
+> >  notmuch-after-tag-hook will be run."\r
+> >    ;; Perform some validation\r
+> > -  (if (string-or-null-p tag-changes)\r
+> > -      (if (or (string= tag-changes "-") (string= tag-changes "+") (null tag-changes))\r
+> > -    (setq tag-changes (notmuch-read-tag-changes\r
+> > -                       (notmuch-tag-completions query) nil tag-changes))\r
+> > -  (setq tag-changes (list tag-changes))))\r
+> \r
+> Hey folks.  After a recent upgrade to 0.16+120~gfd733a4+1 I found that\r
+> my custom tagging functions weren't working, which I traced back to the\r
+> removal of this section.\r
+> \r
+> Previously notmuch-tag accepted tag changes in two forms: as a list of\r
+> tag changes:\r
+> \r
+> (list "+foo" "-bar")\r
+> \r
+> or as a space-separated string:\r
+> \r
+> "+foo -bar"\r
+> \r
+> This removed section is what would turn the space-separated string into\r
+> a list.\r
+> \r
+> I have custom tagging functions that were written like this:\r
+> \r
+> (notmuch-search-tag "+spam")\r
+> \r
+> notmuch-search-tag passes the TAG-CHANGES to notmuch-tag, which was\r
+> changing it to a list in this removed section.  Since its removal, all\r
+> of my custom functions started throwing the following error:\r
+> \r
+> Wrong type argument: stringp, 43\r
+> \r
+> I didn't pay super close attention to the rest of the patch series, but\r
+> From a backwards compatibility point of view, do we really need to\r
+> remove this section?  Is there a problem with specifying tag changes as\r
+> a string?  I think it was actually me that last modified notmuch-tag,\r
+> and I vaguely remember spending time thinking about how to preserve that\r
+> particular way to specify the changes, so that things would be simpler\r
+> for simple tag operations.\r
+\r
+The difficulty is that notmuch-tag used to play a dual role of both\r
+parsing the space-separated string into a list of tag changes and\r
+actually performing the tagging operation and, as a result, other\r
+functions that were rooted in notmuch-tag also accepted both (though\r
+functions that weren't, like notmuch-update-tags, required the list\r
+form).  This dual role was strange from an API perspective, but also,\r
+because of other restructuring, notmuch-tag is no longer at the core\r
+of many operations, so it's not in a good position to be a parser.\r
+\r
+Hence, while we could make `notmuch-tag' itself support the string\r
+form, if we wanted this to work from other tagging entry-points, we'd\r
+need to support both forms in all of the tagging functions.  This\r
+would be doable, but it would be messy, and without the single parsing\r
+point it would be difficult to maintain.\r
+\r
+> In any event, some amount of backwards compatibility has been removed,\r
+> so if we do want to keep it removed, we should add a good NEWS item to\r
+> explain that peoples custom bindings might break.\r
+\r
+I'd rather keep the backwards compatibility removed, but you're\r
+definitely right that we need a good NEWS item for it.  I've posted a\r
+NEWS item in id:1384296252-17884-1-git-send-email-amdragon@mit.edu,\r
+but let me know if you think it can be clearer or more helpful.\r
+\r
+> jamie.\r
+> \r
+> >    (mapc (lambda (tag-change)\r
+> >      (unless (string-match-p "^[-+]\\S-+$" tag-change)\r
+> >        (error "Tag must be of the form `+this_tag' or `-that_tag'")))\r
+> > @@ -278,9 +269,7 @@ notmuch-after-tag-hook will be run."\r
+> >      (run-hooks 'notmuch-before-tag-hook)\r
+> >      (apply 'notmuch-call-notmuch-process "tag"\r
+> >       (append tag-changes (list "--" query)))\r
+> > -    (run-hooks 'notmuch-after-tag-hook))\r
+> > -  ;; in all cases we return tag-changes as a list\r
+> > -  tag-changes)\r
+> > +    (run-hooks 'notmuch-after-tag-hook)))\r
+> >  \r
+> >  (defun notmuch-tag-change-list (tags &optional reverse)\r
+> >    "Convert TAGS into a list of tag changes.\r
+> >\r
+> > _______________________________________________\r
+> > notmuch mailing list\r
+> > notmuch@notmuchmail.org\r
+> > http://notmuchmail.org/mailman/listinfo/notmuch\r