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

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

[Austin Clements]

notmuch-poll-script has long since been deprecated in favor of
post-new hooks, but this wasn't obvious from the documentation.
Update the documentation to make this clear.  Since
notmuch-poll-script could, to some extend, be used to control the path
of the notmuch binary and that use is now clearly discouraged, promote
notmuch-command to a real defcustom instead of just a variable.
---
 emacs/notmuch-lib.el | 24 ++++++++++++++++--------
 1 file changed, 16 insertions(+), 8 deletions(-)

diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el
index 2941da3..c06baac 100644
--- a/emacs/notmuch-lib.el
+++ b/emacs/notmuch-lib.el
@@ -25,9 +25,6 @@
 (require 'mm-decode)
 (require 'cl)
 
-(defvar notmuch-command "notmuch"
-  "Command to run the notmuch binary.")
-
 (defgroup notmuch nil
   "Notmuch mail reader for Emacs."
   :group 'mail)
@@ -66,6 +63,16 @@ (defgroup notmuch-faces nil
   "Graphical attributes for displaying text"
   :group 'notmuch)
 
+(defcustom notmuch-command "notmuch"
+  "Name of the notmuch binary.
+
+This can be a relative or absolute path to the notmuch binary.
+If this is a relative path, it will be searched for in all of the
+directories given in `exec-path' (which is, by default, based on
+$PATH)."
+  :type 'string
+  :group 'notmuch-external)
+
 (defcustom notmuch-search-oldest-first t
   "Show the oldest mail first when searching.
 
@@ -77,7 +84,11 @@ (defcustom notmuch-search-oldest-first t
   :group 'notmuch-search)
 
 (defcustom notmuch-poll-script nil
-  "An external script to incorporate new mail into the notmuch database.
+  "[Deprecated] Command to run to incorporate new mail into the notmuch database.
+
+This option has been deprecated in favor of \"notmuch new\"
+hooks (see man notmuch-hooks).  To change the path to the notmuch
+binary, customize `notmuch-command'.
 
 This variable controls the action invoked by
 `notmuch-poll-and-refresh-this-buffer' (bound by default to 'G')
@@ -93,10 +104,7 @@ (defcustom notmuch-poll-script nil
 
 1. Invoke a program to transfer mail to the local mail store
 2. Invoke \"notmuch new\" to incorporate the new mail
-3. Invoke one or more \"notmuch tag\" commands to classify the mail
-
-Note that the recommended way of achieving the same is using
-\"notmuch new\" hooks."
+3. Invoke one or more \"notmuch tag\" commands to classify the mail"
   :type '(choice (const :tag "notmuch new" nil)
 		 (const :tag "Disabled" "")
 		 (string :tag "Custom script"))
-- 
2.0.0

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

[Tomi Ollila]

On Fri, Jul 25 2014, Austin Clements <amdragon@MIT.EDU> wrote:

> notmuch-poll-script has long since been deprecated in favor of
> post-new hooks, but this wasn't obvious from the documentation.
> Update the documentation to make this clear.  Since
> notmuch-poll-script could, to some extend, be used to control the path
> of the notmuch binary and that use is now clearly discouraged, promote
> notmuch-command to a real defcustom instead of just a variable.
> ---

Fine by me -- although the post/pre-new hooks are not sufficient for me ;D

Tomi

>  emacs/notmuch-lib.el | 24 ++++++++++++++++--------
>  1 file changed, 16 insertions(+), 8 deletions(-)
>
> diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el
> index 2941da3..c06baac 100644
> --- a/emacs/notmuch-lib.el
> +++ b/emacs/notmuch-lib.el
> @@ -25,9 +25,6 @@
>  (require 'mm-decode)
>  (require 'cl)
>  
> -(defvar notmuch-command "notmuch"
> -  "Command to run the notmuch binary.")
> -
>  (defgroup notmuch nil
>    "Notmuch mail reader for Emacs."
>    :group 'mail)
> @@ -66,6 +63,16 @@ (defgroup notmuch-faces nil
>    "Graphical attributes for displaying text"
>    :group 'notmuch)
>  
> +(defcustom notmuch-command "notmuch"
> +  "Name of the notmuch binary.
> +
> +This can be a relative or absolute path to the notmuch binary.
> +If this is a relative path, it will be searched for in all of the
> +directories given in `exec-path' (which is, by default, based on
> +$PATH)."
> +  :type 'string
> +  :group 'notmuch-external)
> +
>  (defcustom notmuch-search-oldest-first t
>    "Show the oldest mail first when searching.
>  
> @@ -77,7 +84,11 @@ (defcustom notmuch-search-oldest-first t
>    :group 'notmuch-search)
>  
>  (defcustom notmuch-poll-script nil
> -  "An external script to incorporate new mail into the notmuch database.
> +  "[Deprecated] Command to run to incorporate new mail into the notmuch database.
> +
> +This option has been deprecated in favor of \"notmuch new\"
> +hooks (see man notmuch-hooks).  To change the path to the notmuch
> +binary, customize `notmuch-command'.
>  
>  This variable controls the action invoked by
>  `notmuch-poll-and-refresh-this-buffer' (bound by default to 'G')
> @@ -93,10 +104,7 @@ (defcustom notmuch-poll-script nil
>  
>  1. Invoke a program to transfer mail to the local mail store
>  2. Invoke \"notmuch new\" to incorporate the new mail
> -3. Invoke one or more \"notmuch tag\" commands to classify the mail
> -
> -Note that the recommended way of achieving the same is using
> -\"notmuch new\" hooks."
> +3. Invoke one or more \"notmuch tag\" commands to classify the mail"
>    :type '(choice (const :tag "notmuch new" nil)
>  		 (const :tag "Disabled" "")
>  		 (string :tag "Custom script"))
> -- 
> 2.0.0
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

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

[David Bremner]

Austin Clements <amdragon@MIT.EDU> writes:

> notmuch-poll-script has long since been deprecated in favor of
> post-new hooks, but this wasn't obvious from the documentation.
> Update the documentation to make this clear.  Since
> notmuch-poll-script could, to some extend, be used to control the path
> of the notmuch binary and that use is now clearly discouraged, promote
> notmuch-command to a real defcustom instead of just a variable.

pushed

d