Re: [PATCH] emacs: Mention race condition safety in user visible documentation
authorJani Nikula <jani@nikula.org>
Sun, 19 Feb 2012 07:05:17 +0000 (09:05 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:44:40 +0000 (09:44 -0800)
ce/fad69bdd089deb1b3ee828756b2329f994ce19 [new file with mode: 0644]

diff --git a/ce/fad69bdd089deb1b3ee828756b2329f994ce19 b/ce/fad69bdd089deb1b3ee828756b2329f994ce19
new file mode 100644 (file)
index 0000000..a36f842
--- /dev/null
@@ -0,0 +1,203 @@
+Return-Path: <jani@nikula.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 olra.theworths.org (Postfix) with ESMTP id 7DECE431FB6\r
+       for <notmuch@notmuchmail.org>; Sat, 18 Feb 2012 23:05:22 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.699\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.699 tagged_above=-999 required=5\r
+       tests=[HTML_MESSAGE=0.001, RCVD_IN_DNSWL_LOW=-0.7] 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 v1EnDRINdeG1 for <notmuch@notmuchmail.org>;\r
+       Sat, 18 Feb 2012 23:05:19 -0800 (PST)\r
+Received: from mail-pw0-f53.google.com (mail-pw0-f53.google.com\r
+       [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 323FC431FAE\r
+       for <notmuch@notmuchmail.org>; Sat, 18 Feb 2012 23:05:19 -0800 (PST)\r
+Received: by pbbrq13 with SMTP id rq13so6011632pbb.26\r
+       for <notmuch@notmuchmail.org>; Sat, 18 Feb 2012 23:05:17 -0800 (PST)\r
+Received-SPF: pass (google.com: domain of jani@nikula.org designates\r
+       10.68.225.73 as permitted sender) client-ip=10.68.225.73; \r
+Authentication-Results: mr.google.com;\r
+       spf=pass (google.com: domain of jani@nikula.org\r
+       designates 10.68.225.73 as permitted sender)\r
+       smtp.mail=jani@nikula.org\r
+Received: from mr.google.com ([10.68.225.73])\r
+       by 10.68.225.73 with SMTP id ri9mr48470454pbc.70.1329635117259\r
+       (num_hops = 1); Sat, 18 Feb 2012 23:05:17 -0800 (PST)\r
+MIME-Version: 1.0\r
+Received: by 10.68.225.73 with SMTP id ri9mr39770025pbc.70.1329635117204; Sat,\r
+       18 Feb 2012 23:05:17 -0800 (PST)\r
+Received: by 10.68.12.103 with HTTP; Sat, 18 Feb 2012 23:05:17 -0800 (PST)\r
+Received: by 10.68.12.103 with HTTP; Sat, 18 Feb 2012 23:05:17 -0800 (PST)\r
+In-Reply-To: <1329605059-15358-1-git-send-email-sojkam1@fel.cvut.cz>\r
+References: <1329605059-15358-1-git-send-email-sojkam1@fel.cvut.cz>\r
+Date: Sun, 19 Feb 2012 09:05:17 +0200\r
+Message-ID:\r
+ <CAB+hUn907hwS46jM4FY+BAhBTE1VMaMs=q0PFEou3DfWWaDF8g@mail.gmail.com>\r
+Subject: Re: [PATCH] emacs: Mention race condition safety in user visible\r
+       documentation\r
+From: Jani Nikula <jani@nikula.org>\r
+To: Michal Sojka <sojkam1@fel.cvut.cz>\r
+Content-Type: multipart/alternative; boundary=e89a8ff2437dd784aa04b94bccfb\r
+X-Gm-Message-State:\r
+ ALoCoQkI+WQSKtHf8JyDkLiE2vnaFQV84ZVIpDuUwM6iRDEbmHNCbTW9106o+V56fUubL2KjrKoi\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:05:22 -0000\r
+\r
+--e89a8ff2437dd784aa04b94bccfb\r
+Content-Type: text/plain; charset=UTF-8\r
+\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 guess.\r
+\r
+BR,\r
+Jani.\r
+\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
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r
+\r
+--e89a8ff2437dd784aa04b94bccfb\r
+Content-Type: text/html; charset=UTF-8\r
+Content-Transfer-Encoding: quoted-printable\r
+\r
+<p><br>\r
+On Feb 19, 2012 12:44 AM, &quot;Michal Sojka&quot; &lt;<a href=3D"mailto:so=\r
+jkam1@fel.cvut.cz">sojkam1@fel.cvut.cz</a>&gt; wrote:<br>\r
+&gt;<br>\r
+&gt; After recent rework of a/A/x/X key bindings, the important paragraph i=\r
+n<br>\r
+&gt; documentation of `notmuch-show-archive-thread&#39; stayed hidden from =\r
+users,<br>\r
+&gt; because no key is bound to this function.<br>\r
+&gt;<br>\r
+&gt; This patch copies the important paragraph to the documentation of<br>\r
+&gt; functions currently bound to keys.</p>\r
+<p>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 message=\r
+s in the buffer) so it would be unnecessary and confusing to have this docu=\r
+mentation. It could be added as a comment for developers I guess.</p>\r
+\r
+<p>BR,<br>\r
+Jani.<br>\r
+ </p>\r
+<p>&gt; ---<br>\r
+&gt; =C2=A0emacs/notmuch-show.el | =C2=A0 14 ++++++++++++--<br>\r
+&gt; =C2=A01 files changed, 12 insertions(+), 2 deletions(-)<br>\r
+&gt;<br>\r
+&gt; diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el<br>\r
+&gt; index aa9ccee..1916146 100644<br>\r
+&gt; --- a/emacs/notmuch-show.el<br>\r
+&gt; +++ b/emacs/notmuch-show.el<br>\r
+&gt; @@ -1721,13 +1721,23 @@ buffer.&quot;<br>\r
+&gt; =C2=A0 =C2=A0 (notmuch-show-tag-all (concat op &quot;inbox&quot;))))<b=\r
+r>\r
+&gt;<br>\r
+&gt; =C2=A0(defun notmuch-show-archive-thread-then-next ()<br>\r
+&gt; - =C2=A0&quot;Archive each message in thread, then show next thread fr=\r
+om search.&quot;<br>\r
+&gt; + =C2=A0&quot;Archive each message in thread, then show next thread fr=\r
+om search.<br>\r
+&gt; +<br>\r
+&gt; +Note: This command is safe from any race condition of new messages<br=\r
+>\r
+&gt; +being delivered to the same thread. It does not archive the<br>\r
+&gt; +entire thread, but only the messages shown in the current<br>\r
+&gt; +buffer.&quot;<br>\r
+&gt; =C2=A0 (interactive)<br>\r
+&gt; =C2=A0 (notmuch-show-archive-thread)<br>\r
+&gt; =C2=A0 (notmuch-show-next-thread t))<br>\r
+&gt;<br>\r
+&gt; =C2=A0(defun notmuch-show-archive-thread-then-exit ()<br>\r
+&gt; - =C2=A0&quot;Archive each message in thread, then exit back to search=\r
+ results.&quot;<br>\r
+&gt; + =C2=A0&quot;Archive each message in thread, then exit back to search=\r
+ results.<br>\r
+&gt; +<br>\r
+&gt; +Note: This command is safe from any race condition of new messages<br=\r
+>\r
+&gt; +being delivered to the same thread. It does not archive the<br>\r
+&gt; +entire thread, but only the messages shown in the current<br>\r
+&gt; +buffer.&quot;<br>\r
+&gt; =C2=A0 (interactive)<br>\r
+&gt; =C2=A0 (notmuch-show-archive-thread)<br>\r
+&gt; =C2=A0 (notmuch-show-next-thread))<br>\r
+&gt; --<br>\r
+&gt; 1.7.7.3<br>\r
+&gt;<br>\r
+&gt; _______________________________________________<br>\r
+&gt; notmuch mailing list<br>\r
+&gt; <a href=3D"mailto:notmuch@notmuchmail.org">notmuch@notmuchmail.org</a>=\r
+<br>\r
+&gt; <a href=3D"http://notmuchmail.org/mailman/listinfo/notmuch">http://not=\r
+muchmail.org/mailman/listinfo/notmuch</a><br>\r
+</p>\r
+\r
+--e89a8ff2437dd784aa04b94bccfb--\r