From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 4199B431FBD for ; Thu, 24 Jul 2014 14:19:44 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: -2.3 X-Spam-Level: X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5 tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id GhI4n2hHxn-1 for ; Thu, 24 Jul 2014 14:19:40 -0700 (PDT) Received: from dmz-mailsec-scanner-7.mit.edu (dmz-mailsec-scanner-7.mit.edu [18.7.68.36]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id 4E4EC431FAF for ; Thu, 24 Jul 2014 14:19:40 -0700 (PDT) X-AuditID: 12074424-f79146d00000067c-69-53d1786b4cb7 Received: from mailhub-auth-2.mit.edu ( [18.7.62.36]) (using TLS with cipher AES256-SHA (256/256 bits)) (Client did not present a certificate) by dmz-mailsec-scanner-7.mit.edu (Symantec Messaging Gateway) with SMTP id E1.0C.01660.B6871D35; Thu, 24 Jul 2014 17:19:39 -0400 (EDT) Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id s6OLJb6i005120; Thu, 24 Jul 2014 17:19:37 -0400 Received: from drake.dyndns.org (26-4-182.dynamic.csail.mit.edu [18.26.4.182]) (authenticated bits=0) (User authenticated as amdragon@ATHENA.MIT.EDU) by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s6OLJZaP011747 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); Thu, 24 Jul 2014 17:19:36 -0400 Received: from amthrax by drake.dyndns.org with local (Exim 4.77) (envelope-from ) id 1XAQQJ-0001W3-4Y; Thu, 24 Jul 2014 17:19:35 -0400 From: Austin Clements To: notmuch@notmuchmail.org Subject: [PATCH] emacs: Clarify that notmuch-poll-script is deprecated Date: Thu, 24 Jul 2014 17:19:31 -0400 Message-Id: <1406236771-5792-1-git-send-email-amdragon@mit.edu> X-Mailer: git-send-email 2.0.0 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFprBIsWRmVeSWpSXmKPExsUixG6noptdcTHY4MctFYvrN2cyOzB6PFt1 izmAMYrLJiU1J7MstUjfLoEr48WLBraCV8IVX/ZLNTB2CnQxcnJICJhIXP2whQ3CFpO4cG89 kM3FISQwm0miY/0sRghnI6PEuvld7CBVQgJHmCS2N2pBJOYySjRs/MgIkmAT0JDYtn85mC0i IC2x8+5s1i5GDg5mATWJP10qIKawgJvE5M4gkAoWAVWJLz/fsYDYvAL2Eg8eXGGEOEJOouHG J7YJjLwLGBlWMcqm5Fbp5iZm5hSnJusWJyfm5aUW6Zrr5WaW6KWmlG5iBAeAi8oOxuZDSocY BTgYlXh4O/aeDxZiTSwrrsw9xCjJwaQkyvu77GKwEF9SfkplRmJxRnxRaU5q8SFGCQ5mJRHe jUFAOd6UxMqq1KJ8mJQ0B4uSOO9ba6tgIYH0xJLU7NTUgtQimKwMB4eSBK9wOVCjYFFqempF WmZOCUKaiYMTZDgP0PBkkBre4oLE3OLMdIj8KUZFKXHeNpCLBEASGaV5cL2wCH3FKA70ijBv KEg7DzC64bpfAQ1mAhr8KuE8yOCSRIQUMFY9FNIDxOOC7xzN3Kf1SOiE8q1/oVObotacVV3O sazO5nMaU63ey2OOp53/zfyikXszuK3g5ZRf+7UbfseueeMRULvw24HDF+LMlpodfb9synR2 23OzJm8/0+CepLVHSM27P++Hl2XIhKUprPJL976snLX9lZiljNrt1usbVi2JvNsp/cPc6f91 JZbijERDLeai4kQA++QpkqsCAAA= X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 24 Jul 2014 21:19:44 -0000 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