[PATCH] emacs: Mention race condition safety in user visible documentation

diff --git a/84/06e3dd36bd11a59aafd6d838c9a101f8a05218 b/84/06e3dd36bd11a59aafd6d838c9a101f8a05218
new file mode 100644 (file)
index 0000000..3d7f2f7
--- /dev/null
+++ b/84/06e3dd36bd11a59aafd6d838c9a101f8a05218
@@ -0,0 +1,101 @@
+Return-Path: <sojkam1@fel.cvut.cz>\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 36FAF431FB6\r
+       for <notmuch@notmuchmail.org>; Sat, 18 Feb 2012 14:44:37 -0800 (PST)\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 HlbF1jBjBIlN for <notmuch@notmuchmail.org>;\r
+       Sat, 18 Feb 2012 14:44:36 -0800 (PST)\r
+Received: from max.feld.cvut.cz (max.feld.cvut.cz [147.32.192.36])\r
+       by olra.theworths.org (Postfix) with ESMTP id B2B6C431FAE\r
+       for <notmuch@notmuchmail.org>; Sat, 18 Feb 2012 14:44:36 -0800 (PST)\r
+Received: from localhost (unknown [192.168.200.4])\r
+       by max.feld.cvut.cz (Postfix) with ESMTP id 4FF0A19F35E0;\r
+       Sat, 18 Feb 2012 23:44:35 +0100 (CET)\r
+X-Virus-Scanned: IMAP AMAVIS\r
+Received: from max.feld.cvut.cz ([192.168.200.1])\r
+       by localhost (styx.feld.cvut.cz [192.168.200.4]) (amavisd-new,\r
+       port 10044)\r
+       with ESMTP id 7Q0djq5YFbhH; Sat, 18 Feb 2012 23:44:34 +0100 (CET)\r
+Received: from imap.feld.cvut.cz (imap.feld.cvut.cz [147.32.192.34])\r
+       by max.feld.cvut.cz (Postfix) with ESMTP id 0D02F19F35D5;\r
+       Sat, 18 Feb 2012 23:44:34 +0100 (CET)\r
+Received: from steelpick.2x.cz (unknown [213.29.198.144])\r
+       (Authenticated sender: sojkam1)\r
+       by imap.feld.cvut.cz (Postfix) with ESMTPSA id EC834660968;\r
+       Sat, 18 Feb 2012 23:44:33 +0100 (CET)\r
+Received: from wsh by steelpick.2x.cz with local (Exim 4.77)\r
+       (envelope-from <sojkam1@fel.cvut.cz>)\r
+       id 1Ryt17-00040G-F6; Sat, 18 Feb 2012 23:44:33 +0100\r
+From: Michal Sojka <sojkam1@fel.cvut.cz>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] emacs: Mention race condition safety in user visible\r
+       documentation\r
+Date: Sat, 18 Feb 2012 23:44:18 +0100\r
+Message-Id: <1329605059-15358-1-git-send-email-sojkam1@fel.cvut.cz>\r
+X-Mailer: git-send-email 1.7.7.3\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: Sat, 18 Feb 2012 22:44:37 -0000\r
+\r
+After recent rework of a/A/x/X key bindings, the important paragraph in\r
+documentation of `notmuch-show-archive-thread' stayed hidden from users,\r
+because no key is bound to this function.\r
+\r
+This patch copies the important paragraph to the documentation of\r
+functions currently bound to keys.\r
+---\r
+ emacs/notmuch-show.el |   14 ++++++++++++--\r
+ 1 files changed, 12 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
+index aa9ccee..1916146 100644\r
+--- a/emacs/notmuch-show.el\r
++++ b/emacs/notmuch-show.el\r
+@@ -1721,13 +1721,23 @@ buffer."\r
+     (notmuch-show-tag-all (concat op "inbox"))))\r
+ \r
+ (defun notmuch-show-archive-thread-then-next ()\r
+-  "Archive each message in thread, then show next thread from search."\r
++  "Archive each message in thread, then show next thread from search.\r
++\r
++Note: This command is safe from any race condition of new messages\r
++being delivered to the same thread. It does not archive the\r
++entire thread, but only the messages shown in the current\r
++buffer."\r
+   (interactive)\r
+   (notmuch-show-archive-thread)\r
+   (notmuch-show-next-thread t))\r
+ \r
+ (defun notmuch-show-archive-thread-then-exit ()\r
+-  "Archive each message in thread, then exit back to search results."\r
++  "Archive each message in thread, then exit back to search results.\r
++\r
++Note: This command is safe from any race condition of new messages\r
++being delivered to the same thread. It does not archive the\r
++entire thread, but only the messages shown in the current\r
++buffer."\r
+   (interactive)\r
+   (notmuch-show-archive-thread)\r
+   (notmuch-show-next-thread))\r
+-- \r
+1.7.7.3\r
+\r