Re: [PATCH] emacs: Clarify that notmuch-poll-script is deprecated

diff --git a/9e/b3918bf8cf64912de183e10619356ced3a43d9 b/9e/b3918bf8cf64912de183e10619356ced3a43d9
new file mode 100644 (file)
index 0000000..60bc0bb
--- /dev/null
+++ b/9e/b3918bf8cf64912de183e10619356ced3a43d9
@@ -0,0 +1,130 @@
+Return-Path: <tomi.ollila@iki.fi>\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 2B071431FC2\r
+       for <notmuch@notmuchmail.org>; Fri, 25 Jul 2014 01:52:10 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       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 4vRNpeGkAT-K for <notmuch@notmuchmail.org>;\r
+       Fri, 25 Jul 2014 01:51:59 -0700 (PDT)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id A2644431FAF\r
+       for <notmuch@notmuchmail.org>; Fri, 25 Jul 2014 01:51:59 -0700 (PDT)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id A8414100199;\r
+       Fri, 25 Jul 2014 11:51:52 +0300 (EEST)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: Austin Clements <amdragon@MIT.EDU>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH] emacs: Clarify that notmuch-poll-script is deprecated\r
+In-Reply-To: <1406236771-5792-1-git-send-email-amdragon@mit.edu>\r
+References: <1406236771-5792-1-git-send-email-amdragon@mit.edu>\r
+User-Agent: Notmuch/0.18.1+25~gdaf4b6f (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Fri, 25 Jul 2014 11:51:52 +0300\r
+Message-ID: <m2zjfxkehj.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\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, 25 Jul 2014 08:52:10 -0000\r
+\r
+On Fri, Jul 25 2014, Austin Clements <amdragon@MIT.EDU> wrote:\r
+\r
+> notmuch-poll-script has long since been deprecated in favor of\r
+> post-new hooks, but this wasn't obvious from the documentation.\r
+> Update the documentation to make this clear.  Since\r
+> notmuch-poll-script could, to some extend, be used to control the path\r
+> of the notmuch binary and that use is now clearly discouraged, promote\r
+> notmuch-command to a real defcustom instead of just a variable.\r
+> ---\r
+\r
+Fine by me -- although the post/pre-new hooks are not sufficient for me ;D\r
+\r
+Tomi\r
+\r
+>  emacs/notmuch-lib.el | 24 ++++++++++++++++--------\r
+>  1 file changed, 16 insertions(+), 8 deletions(-)\r
+>\r
+> diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el\r
+> index 2941da3..c06baac 100644\r
+> --- a/emacs/notmuch-lib.el\r
+> +++ b/emacs/notmuch-lib.el\r
+> @@ -25,9 +25,6 @@\r
+>  (require 'mm-decode)\r
+>  (require 'cl)\r
+>  \r
+> -(defvar notmuch-command "notmuch"\r
+> -  "Command to run the notmuch binary.")\r
+> -\r
+>  (defgroup notmuch nil\r
+>    "Notmuch mail reader for Emacs."\r
+>    :group 'mail)\r
+> @@ -66,6 +63,16 @@ (defgroup notmuch-faces nil\r
+>    "Graphical attributes for displaying text"\r
+>    :group 'notmuch)\r
+>  \r
+> +(defcustom notmuch-command "notmuch"\r
+> +  "Name of the notmuch binary.\r
+> +\r
+> +This can be a relative or absolute path to the notmuch binary.\r
+> +If this is a relative path, it will be searched for in all of the\r
+> +directories given in `exec-path' (which is, by default, based on\r
+> +$PATH)."\r
+> +  :type 'string\r
+> +  :group 'notmuch-external)\r
+> +\r
+>  (defcustom notmuch-search-oldest-first t\r
+>    "Show the oldest mail first when searching.\r
+>  \r
+> @@ -77,7 +84,11 @@ (defcustom notmuch-search-oldest-first t\r
+>    :group 'notmuch-search)\r
+>  \r
+>  (defcustom notmuch-poll-script nil\r
+> -  "An external script to incorporate new mail into the notmuch database.\r
+> +  "[Deprecated] Command to run to incorporate new mail into the notmuch database.\r
+> +\r
+> +This option has been deprecated in favor of \"notmuch new\"\r
+> +hooks (see man notmuch-hooks).  To change the path to the notmuch\r
+> +binary, customize `notmuch-command'.\r
+>  \r
+>  This variable controls the action invoked by\r
+>  `notmuch-poll-and-refresh-this-buffer' (bound by default to 'G')\r
+> @@ -93,10 +104,7 @@ (defcustom notmuch-poll-script nil\r
+>  \r
+>  1. Invoke a program to transfer mail to the local mail store\r
+>  2. Invoke \"notmuch new\" to incorporate the new mail\r
+> -3. Invoke one or more \"notmuch tag\" commands to classify the mail\r
+> -\r
+> -Note that the recommended way of achieving the same is using\r
+> -\"notmuch new\" hooks."\r
+> +3. Invoke one or more \"notmuch tag\" commands to classify the mail"\r
+>    :type '(choice (const :tag "notmuch new" nil)\r
+>               (const :tag "Disabled" "")\r
+>               (string :tag "Custom script"))\r
+> -- \r
+> 2.0.0\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r