[PATCH] Fix documentation for notmuch--tag-hook functions

diff --git a/ab/1a3b037ec5cd345851773d710afa68c54e58f0 b/ab/1a3b037ec5cd345851773d710afa68c54e58f0
new file mode 100644 (file)
index 0000000..bde23e9
--- /dev/null
+++ b/ab/1a3b037ec5cd345851773d710afa68c54e58f0
@@ -0,0 +1,101 @@
+Return-Path: <daniel@schoepe.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id A5B076DE0243\r
+ for <notmuch@notmuchmail.org>; Tue, 16 Jun 2015 14:47:30 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.471\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.471 tagged_above=-999 required=5 tests=[AWL=1.292, \r
+ DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+ RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=-0.01,\r
+ RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id VqgnaoZgw6s6 for <notmuch@notmuchmail.org>;\r
+ Tue, 16 Jun 2015 14:47:28 -0700 (PDT)\r
+Received: from mail-lb0-f174.google.com (mail-lb0-f174.google.com\r
+ [209.85.217.174])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id C47C86DE01F5\r
+ for <notmuch@notmuchmail.org>; Tue, 16 Jun 2015 14:47:27 -0700 (PDT)\r
+Received: by lblr1 with SMTP id r1so19569935lbl.0\r
+ for <notmuch@notmuchmail.org>; Tue, 16 Jun 2015 14:47:25 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=schoepe.org; s=google;\r
+ h=from:to:cc:subject:date:message-id;\r
+ bh=y1COqrdUrkrGsUvcVpACszHl2y94sVWDCL2yHhl3UJk=;\r
+ b=YQktWp3MBhMKifI2V18utdBrxCq7FMFZOvPvInAB/CA/2I6sWyNFXgROFbOmGxmMFg\r
+ E4Ne4L2CSUV8HeIQ5M7tdm5XP/C3YhP7hABwy9b+wKOx3Mk1DIegl1k7nW1EkqeQpNl0\r
+ 8lIAjrT0rQQ0w/KvC9b/XMu8DZt8d6LdNb2w8=\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+ d=1e100.net; s=20130820;\r
+ h=x-gm-message-state:from:to:cc:subject:date:message-id;\r
+ bh=y1COqrdUrkrGsUvcVpACszHl2y94sVWDCL2yHhl3UJk=;\r
+ b=DygcUxzzQLEx0zKDr21JZcwRO7zkdwgxrO+FCJ69ItOfN0lVrG7PJkMNrs+IO3fXXB\r
+ oZZj+5+CFYFh4nNRon4oedSAKYKDutESjM5sKCO3k1I/K0IJzGm0CoMGMht9/DoRBZLK\r
+ PRAunhsGQkFx7tDyruCOCptsYPMEcF20Sga/YtmNG6+7wj2ytt3b3n10eDVWqDIWuXo+\r
+ TsCheeP7HIoTTNoRahPQhRZVL5VK1xBnS8bb3lPS9E9DnTYLhKdiZQYc3ogFDRhlNuv8\r
+ Z0LySNdQdHnP088qhgQBEnQih3jt6HzoReid2lpCg7YmNFMtdelVH9AjBCiztTb/A27v\r
+ avGw==\r
+X-Gm-Message-State:\r
+ ALoCoQn/GDeZoKwCEaDzoqoJEmlr8XF9Sm9p33F966TDUy/505+h2C5d6yLaHzQizY92zLQBzzc+\r
+X-Received: by 10.152.30.34 with SMTP id p2mr4267377lah.89.1434491245272;\r
+ Tue, 16 Jun 2015 14:47:25 -0700 (PDT)\r
+Received: from localhost (rd19.odn.sgsnet.se. [46.239.97.207])\r
+ by mx.google.com with ESMTPSA id ox10sm512747lbc.30.2015.06.16.14.47.22\r
+ (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);\r
+ Tue, 16 Jun 2015 14:47:23 -0700 (PDT)\r
+From: Daniel Schoepe <daniel@schoepe.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] Fix documentation for notmuch--tag-hook functions\r
+Date: Tue, 16 Jun 2015 23:47:20 +0200\r
+Message-Id: <1434491240-31023-1-git-send-email-daniel@schoepe.org>\r
+X-Mailer: git-send-email 2.4.3\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.18\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, 16 Jun 2015 21:47:30 -0000\r
+\r
+The second argument to notmuch-tag is now called tag-changes, but the\r
+documentation for notmuch-before-tag-hook and notmuch-after-tag-hook\r
+still used the old argument name `tags'. This resulted in broken hooks\r
+when following the documentation.\r
+---\r
+ emacs/notmuch-tag.el | 4 ++--\r
+ 1 file changed, 2 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el\r
+index f54aa9d..c7f62c9 100644\r
+--- a/emacs/notmuch-tag.el\r
++++ b/emacs/notmuch-tag.el\r
+@@ -265,7 +265,7 @@ changed (the normal case) are shown using formats from\r
+ (defcustom notmuch-before-tag-hook nil\r
+   "Hooks that are run before tags of a message are modified.\r
+ \r
+-'tags' will contain the tags that are about to be added or removed as\r
++'tag-changes' will contain the tags that are about to be added or removed as\r
+ a list of strings of the form \"+TAG\" or \"-TAG\".\r
+ 'query' will be a string containing the search query that determines\r
+ the messages that are about to be tagged"\r
+@@ -277,7 +277,7 @@ the messages that are about to be tagged"\r
+ (defcustom notmuch-after-tag-hook nil\r
+   "Hooks that are run after tags of a message are modified.\r
+ \r
+-'tags' will contain the tags that were added or removed as\r
++'tag-changes' will contain the tags that were added or removed as\r
+ a list of strings of the form \"+TAG\" or \"-TAG\".\r
+ 'query' will be a string containing the search query that determines\r
+ the messages that were tagged"\r
+-- \r
+2.4.3\r
+\r