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

diff --git a/10/ab0df90beb099ee059c045bd050b02d89c5f48 b/10/ab0df90beb099ee059c045bd050b02d89c5f48
new file mode 100644 (file)
index 0000000..df6126f
--- /dev/null
+++ b/10/ab0df90beb099ee059c045bd050b02d89c5f48
@@ -0,0 +1,92 @@
+Return-Path: <sojka@os.inf.tu-dresden.de>\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 8A72D431FB6\r
+       for <notmuch@notmuchmail.org>; Sat, 18 Feb 2012 23:33:04 -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 k8yU4d9wewlN for <notmuch@notmuchmail.org>;\r
+       Sat, 18 Feb 2012 23:33:03 -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 3B7AD431FAE\r
+       for <notmuch@notmuchmail.org>; Sat, 18 Feb 2012 23:33:03 -0800 (PST)\r
+Received: from localhost (unknown [192.168.200.4])\r
+       by max.feld.cvut.cz (Postfix) with ESMTP id 89CFB19F35DC;\r
+       Sun, 19 Feb 2012 08:33:02 +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 7rxtwFfqs3HM; Sun, 19 Feb 2012 08:33:01 +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 A625419F35D3;\r
+       Sun, 19 Feb 2012 08:33:01 +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 9318A660968;\r
+       Sun, 19 Feb 2012 08:33:01 +0100 (CET)\r
+Received: from wsh by steelpick.2x.cz with local (Exim 4.77)\r
+       (envelope-from <sojka@os.inf.tu-dresden.de>)\r
+       id 1Rz1GW-0005AP-OP; Sun, 19 Feb 2012 08:33:00 +0100\r
+From: Michal Sojka <sojkam1@fel.cvut.cz>\r
+To: Jani Nikula <jani@nikula.org>\r
+Subject: Re: [PATCH] emacs: Mention race condition safety in user visible\r
+       documentation\r
+In-Reply-To:\r
+ <CAB+hUn907hwS46jM4FY+BAhBTE1VMaMs=q0PFEou3DfWWaDF8g@mail.gmail.com>\r
+References: <1329605059-15358-1-git-send-email-sojkam1@fel.cvut.cz>\r
+       <CAB+hUn907hwS46jM4FY+BAhBTE1VMaMs=q0PFEou3DfWWaDF8g@mail.gmail.com>\r
+User-Agent: Notmuch/0.11.1+210~g5c2fc0a (http://notmuchmail.org) Emacs/23.3.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Sun, 19 Feb 2012 08:33:00 +0100\r
+Message-ID: <87y5rzmg5v.fsf@steelpick.2x.cz>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Cc: notmuch@notmuchmail.org\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: Sun, 19 Feb 2012 07:33:04 -0000\r
+\r
+On Sun, 19 Feb 2012, Jani Nikula wrote:\r
+> On Feb 19, 2012 12:44 AM, "Michal Sojka" <sojkam1@fel.cvut.cz> wrote:\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
+> Hi Michal, this was discussed earlier, and Dmitry convinced me that the\r
+> code does exactly what the user expects it to do (archives only the\r
+> messages in the buffer) so it would be unnecessary and confusing to have\r
+> this documentation. It could be added as a comment for developers I\r
+> guess.\r
+\r
+I'm not sure. As a developer, I'm used to think about race conditions\r
+and the mentioned documentation sounds very racy to me. I guess a lot of\r
+other notmuch users are developers who may think the same.\r
+\r
+> >  (defun notmuch-show-archive-thread-then-next ()\r
+> > -  "Archive each message in thread, then show next thread from search."\r
+\r
+What about changing it to "Archive each message in the current buffer, ..."?\r
+\r
+-Michal\r