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

diff --git a/72/63feebf83dc11ce0f203bcf75e4ce77054b9b6 b/72/63feebf83dc11ce0f203bcf75e4ce77054b9b6
new file mode 100644 (file)
index 0000000..0e1d44e
--- /dev/null
+++ b/72/63feebf83dc11ce0f203bcf75e4ce77054b9b6
@@ -0,0 +1,114 @@
+Return-Path: <m.walters@qmul.ac.uk>\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 A7046431FAF\r
+       for <notmuch@notmuchmail.org>; Tue, 21 Feb 2012 00:43:37 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+       tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+       NML_ADSP_CUSTOM_MED=1.2, 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 DMRZT+L+zyFQ for <notmuch@notmuchmail.org>;\r
+       Tue, 21 Feb 2012 00:43:33 -0800 (PST)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\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 8D3EC431FAE\r
+       for <notmuch@notmuchmail.org>; Tue, 21 Feb 2012 00:43:33 -0800 (PST)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+       by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1RzlJl-0006ck-6x; Tue, 21 Feb 2012 08:43:29 +0000\r
+Received: from 94-192-233-223.zone6.bethere.co.uk ([94.192.233.223]\r
+       helo=localhost)\r
+       by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.69)\r
+       (envelope-from <m.walters@qmul.ac.uk>)\r
+       id 1RzlJl-0004To-0A; Tue, 21 Feb 2012 08:43:25 +0000\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: Michal Sojka <sojkam1@fel.cvut.cz>, Jani Nikula <jani@nikula.org>\r
+Subject: Re: [PATCH] emacs: Mention race condition safety in user visible\r
+       documentation\r
+In-Reply-To: <87y5rzmg5v.fsf@steelpick.2x.cz>\r
+References: <1329605059-15358-1-git-send-email-sojkam1@fel.cvut.cz>\r
+       <CAB+hUn907hwS46jM4FY+BAhBTE1VMaMs=q0PFEou3DfWWaDF8g@mail.gmail.com>\r
+       <87y5rzmg5v.fsf@steelpick.2x.cz>\r
+User-Agent: Notmuch/0.11.1+206~g3b67774 (http://notmuchmail.org) Emacs/23.2.1\r
+       (i486-pc-linux-gnu)\r
+Date: Tue, 21 Feb 2012 08:45:00 +0000\r
+Message-ID: <87vcn0tw1f.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Sender-Host-Address: 94.192.233.223\r
+X-QM-SPAM-Info: Sender has good ham record.  :)\r
+X-QM-Body-MD5: 1bc024877d1328992dec7147d4731c00 (of first 20000 bytes)\r
+X-SpamAssassin-Score: -1.8\r
+X-SpamAssassin-SpamBar: -\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+       determine if it is\r
+       spam. We require at least 5.0 points to mark a message as spam.\r
+       This message scored -1.8 points.\r
+       Summary of the scoring: \r
+       * -2.3 RCVD_IN_DNSWL_MED RBL: Sender listed at http://www.dnswl.org/,\r
+       *      medium trust\r
+       *      [138.37.6.40 listed in list.dnswl.org]\r
+       * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+       provider *      (markwalters1009[at]gmail.com)\r
+       * -0.0 T_RP_MATCHES_RCVD Envelope sender domain matches handover relay\r
+       *      domain\r
+       *  0.5 AWL AWL: From: address is in the auto white-list\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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: Tue, 21 Feb 2012 08:43:37 -0000\r
+\r
+On Sun, 19 Feb 2012 08:33:00 +0100, Michal Sojka <sojkam1@fel.cvut.cz> wrote:\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
+I like this suggested wording (or perhaps "Archive all messages in the\r
+current buffer, ..."). I do not think `Archive each message in thread' is\r
+completely clear (is the thread the thread as it is now or as it was\r
+then).\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r