[PATCH] emacs: Clarify that notmuch-poll-script is deprecated
authorAustin Clements <amdragon@MIT.EDU>
Thu, 24 Jul 2014 21:19:31 +0000 (17:19 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:03:51 +0000 (10:03 -0800)
d3/035a7cc8644c9899ab33931b382d4de98e6c7d [new file with mode: 0644]

diff --git a/d3/035a7cc8644c9899ab33931b382d4de98e6c7d b/d3/035a7cc8644c9899ab33931b382d4de98e6c7d
new file mode 100644 (file)
index 0000000..e38ad29
--- /dev/null
@@ -0,0 +1,142 @@
+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 4199B431FBD\r
+       for <notmuch@notmuchmail.org>; Thu, 24 Jul 2014 14:19:44 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[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 GhI4n2hHxn-1 for <notmuch@notmuchmail.org>;\r
+       Thu, 24 Jul 2014 14:19:40 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-7.mit.edu (dmz-mailsec-scanner-7.mit.edu\r
+       [18.7.68.36])\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 4E4EC431FAF\r
+       for <notmuch@notmuchmail.org>; Thu, 24 Jul 2014 14:19:40 -0700 (PDT)\r
+X-AuditID: 12074424-f79146d00000067c-69-53d1786b4cb7\r
+Received: from mailhub-auth-2.mit.edu ( [18.7.62.36])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-7.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id E1.0C.01660.B6871D35; Thu, 24 Jul 2014 17:19:39 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id s6OLJb6i005120; \r
+       Thu, 24 Jul 2014 17:19:37 -0400\r
+Received: from drake.dyndns.org (26-4-182.dynamic.csail.mit.edu [18.26.4.182])\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 s6OLJZaP011747\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Thu, 24 Jul 2014 17:19:36 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1XAQQJ-0001W3-4Y; Thu, 24 Jul 2014 17:19:35 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] emacs: Clarify that notmuch-poll-script is deprecated\r
+Date: Thu, 24 Jul 2014 17:19:31 -0400\r
+Message-Id: <1406236771-5792-1-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 2.0.0\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFprBIsWRmVeSWpSXmKPExsUixG6noptdcTHY4MctFYvrN2cyOzB6PFt1\r
+       izmAMYrLJiU1J7MstUjfLoEr48WLBraCV8IVX/ZLNTB2CnQxcnJICJhIXP2whQ3CFpO4cG89\r
+       kM3FISQwm0miY/0sRghnI6PEuvld7CBVQgJHmCS2N2pBJOYySjRs/MgIkmAT0JDYtn85mC0i\r
+       IC2x8+5s1i5GDg5mATWJP10qIKawgJvE5M4gkAoWAVWJLz/fsYDYvAL2Eg8eXGGEOEJOouHG\r
+       J7YJjLwLGBlWMcqm5Fbp5iZm5hSnJusWJyfm5aUW6Zrr5WaW6KWmlG5iBAeAi8oOxuZDSocY\r
+       BTgYlXh4O/aeDxZiTSwrrsw9xCjJwaQkyvu77GKwEF9SfkplRmJxRnxRaU5q8SFGCQ5mJRHe\r
+       jUFAOd6UxMqq1KJ8mJQ0B4uSOO9ba6tgIYH0xJLU7NTUgtQimKwMB4eSBK9wOVCjYFFqempF\r
+       WmZOCUKaiYMTZDgP0PBkkBre4oLE3OLMdIj8KUZFKXHeNpCLBEASGaV5cL2wCH3FKA70ijBv\r
+       KEg7DzC64bpfAQ1mAhr8KuE8yOCSRIQUMFY9FNIDxOOC7xzN3Kf1SOiE8q1/oVObotacVV3O\r
+       sazO5nMaU63ey2OOp53/zfyikXszuK3g5ZRf+7UbfseueeMRULvw24HDF+LMlpodfb9synR2\r
+       23OzJm8/0+CepLVHSM27P++Hl2XIhKUprPJL976snLX9lZiljNrt1usbVi2JvNsp/cPc6f91\r
+       JZbijERDLeai4kQA++QpkqsCAAA=\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: Thu, 24 Jul 2014 21:19:44 -0000\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
+ 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