From: Jani Nikula Date: Sun, 19 Feb 2012 07:05:17 +0000 (+0200) Subject: Re: [PATCH] emacs: Mention race condition safety in user visible documentation X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=1e953e62587c5d5145e6eae1ec7d974184e06319;p=notmuch-archives.git Re: [PATCH] emacs: Mention race condition safety in user visible documentation --- diff --git a/ce/fad69bdd089deb1b3ee828756b2329f994ce19 b/ce/fad69bdd089deb1b3ee828756b2329f994ce19 new file mode 100644 index 000000000..a36f842cf --- /dev/null +++ b/ce/fad69bdd089deb1b3ee828756b2329f994ce19 @@ -0,0 +1,203 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 7DECE431FB6 + for ; Sat, 18 Feb 2012 23:05:22 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.699 +X-Spam-Level: +X-Spam-Status: No, score=-0.699 tagged_above=-999 required=5 + tests=[HTML_MESSAGE=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id v1EnDRINdeG1 for ; + Sat, 18 Feb 2012 23:05:19 -0800 (PST) +Received: from mail-pw0-f53.google.com (mail-pw0-f53.google.com + [209.85.160.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 323FC431FAE + for ; Sat, 18 Feb 2012 23:05:19 -0800 (PST) +Received: by pbbrq13 with SMTP id rq13so6011632pbb.26 + for ; Sat, 18 Feb 2012 23:05:17 -0800 (PST) +Received-SPF: pass (google.com: domain of jani@nikula.org designates + 10.68.225.73 as permitted sender) client-ip=10.68.225.73; +Authentication-Results: mr.google.com; + spf=pass (google.com: domain of jani@nikula.org + designates 10.68.225.73 as permitted sender) + smtp.mail=jani@nikula.org +Received: from mr.google.com ([10.68.225.73]) + by 10.68.225.73 with SMTP id ri9mr48470454pbc.70.1329635117259 + (num_hops = 1); Sat, 18 Feb 2012 23:05:17 -0800 (PST) +MIME-Version: 1.0 +Received: by 10.68.225.73 with SMTP id ri9mr39770025pbc.70.1329635117204; Sat, + 18 Feb 2012 23:05:17 -0800 (PST) +Received: by 10.68.12.103 with HTTP; Sat, 18 Feb 2012 23:05:17 -0800 (PST) +Received: by 10.68.12.103 with HTTP; Sat, 18 Feb 2012 23:05:17 -0800 (PST) +In-Reply-To: <1329605059-15358-1-git-send-email-sojkam1@fel.cvut.cz> +References: <1329605059-15358-1-git-send-email-sojkam1@fel.cvut.cz> +Date: Sun, 19 Feb 2012 09:05:17 +0200 +Message-ID: + +Subject: Re: [PATCH] emacs: Mention race condition safety in user visible + documentation +From: Jani Nikula +To: Michal Sojka +Content-Type: multipart/alternative; boundary=e89a8ff2437dd784aa04b94bccfb +X-Gm-Message-State: + ALoCoQkI+WQSKtHf8JyDkLiE2vnaFQV84ZVIpDuUwM6iRDEbmHNCbTW9106o+V56fUubL2KjrKoi +Cc: notmuch@notmuchmail.org +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sun, 19 Feb 2012 07:05:22 -0000 + +--e89a8ff2437dd784aa04b94bccfb +Content-Type: text/plain; charset=UTF-8 + +On Feb 19, 2012 12:44 AM, "Michal Sojka" wrote: +> +> After recent rework of a/A/x/X key bindings, the important paragraph in +> documentation of `notmuch-show-archive-thread' stayed hidden from users, +> because no key is bound to this function. +> +> This patch copies the important paragraph to the documentation of +> functions currently bound to keys. + +Hi Michal, this was discussed earlier, and Dmitry convinced me that the +code does exactly what the user expects it to do (archives only the +messages in the buffer) so it would be unnecessary and confusing to have +this documentation. It could be added as a comment for developers I guess. + +BR, +Jani. + +> --- +> emacs/notmuch-show.el | 14 ++++++++++++-- +> 1 files changed, 12 insertions(+), 2 deletions(-) +> +> diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el +> index aa9ccee..1916146 100644 +> --- a/emacs/notmuch-show.el +> +++ b/emacs/notmuch-show.el +> @@ -1721,13 +1721,23 @@ buffer." +> (notmuch-show-tag-all (concat op "inbox")))) +> +> (defun notmuch-show-archive-thread-then-next () +> - "Archive each message in thread, then show next thread from search." +> + "Archive each message in thread, then show next thread from search. +> + +> +Note: This command is safe from any race condition of new messages +> +being delivered to the same thread. It does not archive the +> +entire thread, but only the messages shown in the current +> +buffer." +> (interactive) +> (notmuch-show-archive-thread) +> (notmuch-show-next-thread t)) +> +> (defun notmuch-show-archive-thread-then-exit () +> - "Archive each message in thread, then exit back to search results." +> + "Archive each message in thread, then exit back to search results. +> + +> +Note: This command is safe from any race condition of new messages +> +being delivered to the same thread. It does not archive the +> +entire thread, but only the messages shown in the current +> +buffer." +> (interactive) +> (notmuch-show-archive-thread) +> (notmuch-show-next-thread)) +> -- +> 1.7.7.3 +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch + +--e89a8ff2437dd784aa04b94bccfb +Content-Type: text/html; charset=UTF-8 +Content-Transfer-Encoding: quoted-printable + +


+On Feb 19, 2012 12:44 AM, "Michal Sojka" <sojkam1@fel.cvut.cz> wrote:
+>
+> After recent rework of a/A/x/X key bindings, the important paragraph i= +n
+> documentation of `notmuch-show-archive-thread' stayed hidden from = +users,
+> because no key is bound to this function.
+>
+> This patch copies the important paragraph to the documentation of
+> functions currently bound to keys.

+

Hi Michal, this was discussed earlier, and Dmitry convinced me that the = +code does exactly what the user expects it to do (archives only the message= +s in the buffer) so it would be unnecessary and confusing to have this docu= +mentation. It could be added as a comment for developers I guess.

+ +

BR,
+Jani.
+

+

> ---
+> =C2=A0emacs/notmuch-show.el | =C2=A0 14 ++++++++++++--
+> =C2=A01 files changed, 12 insertions(+), 2 deletions(-)
+>
+> diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
+> index aa9ccee..1916146 100644
+> --- a/emacs/notmuch-show.el
+> +++ b/emacs/notmuch-show.el
+> @@ -1721,13 +1721,23 @@ buffer."
+> =C2=A0 =C2=A0 (notmuch-show-tag-all (concat op "inbox")))) +>
+> =C2=A0(defun notmuch-show-archive-thread-then-next ()
+> - =C2=A0"Archive each message in thread, then show next thread fr= +om search."
+> + =C2=A0"Archive each message in thread, then show next thread fr= +om search.
+> +
+> +Note: This command is safe from any race condition of new messages +> +being delivered to the same thread. It does not archive the
+> +entire thread, but only the messages shown in the current
+> +buffer."
+> =C2=A0 (interactive)
+> =C2=A0 (notmuch-show-archive-thread)
+> =C2=A0 (notmuch-show-next-thread t))
+>
+> =C2=A0(defun notmuch-show-archive-thread-then-exit ()
+> - =C2=A0"Archive each message in thread, then exit back to search= + results."
+> + =C2=A0"Archive each message in thread, then exit back to search= + results.
+> +
+> +Note: This command is safe from any race condition of new messages +> +being delivered to the same thread. It does not archive the
+> +entire thread, but only the messages shown in the current
+> +buffer."
+> =C2=A0 (interactive)
+> =C2=A0 (notmuch-show-archive-thread)
+> =C2=A0 (notmuch-show-next-thread))
+> --
+> 1.7.7.3
+>
+> _______________________________________________
+> notmuch mailing list
+> notmuch@notmuchmail.org= +
+> http://not= +muchmail.org/mailman/listinfo/notmuch
+

+ +--e89a8ff2437dd784aa04b94bccfb--