From: Alan Mackenzie <acm@muc.de>
To: Eli Zaretskii <eliz@gnu.org>, Noam Postavsky <npostavs@gmail.com>
Cc: 25111@debbugs.gnu.org, Phillip Lord <phillip.lord@russet.org.uk>
Subject: bug#25111: (Inaccurate documentation of inhibit-modification-hooks)
Date: Sun, 19 May 2019 20:31:19 +0000 [thread overview]
Message-ID: <20190519203119.GA5309@ACM> (raw)
In-Reply-To: <83lgvlcet1.fsf@gnu.org>
Hello, Eli and Noam.
On Mon, Dec 12, 2016 at 18:06:34 +0200, Eli Zaretskii wrote:
> > From: phillip.lord@russet.org.uk (Phillip Lord)
> > Cc: 25111@debbugs.gnu.org
> > Date: Sun, 11 Dec 2016 22:11:14 +0000
> > So, instead of this:
> > If these functions modify the buffer, they should bind
> > ‘inhibit-modification-hooks’ to ‘t’ around doing so, to avoid
> > confusing the internal mechanism that calls these hooks.
> > We could have:
> > These functions should avoid unnecessarily modifying the buffer.
> > Emacs binds 'inhibit-modification-hooks' to `t' during their
> > evaluation, which means that any modifications will not be signalled
> > to other hook functions listening for them.
> > Perhaps a better solution would be:
> > These functions should avoid unnecessarily modifying the buffer; see
> > Change Hooks for further details.
> > Then a new paragraph can be added to the Change Hooks section talking
> > about the complexity of modifying buffers on these hooks, with
> > alternatives.
> > I am happy to draft something if you wish.
> Sure, please do.
> Thanks.
OK, it was a while ago, and I'm not Phillip, but I recently got caught
out with the inaccurate documentation of inhibit-modification-hooks, so I
suggest the following, to get the discussion rolling again:
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index a2ed4b3891..b88702f2a2 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -1743,9 +1743,17 @@ Overlay Properties
length is the number of characters deleted, and the post-change
beginning and end are equal.)
-If these functions modify the buffer, they should bind
-@code{inhibit-modification-hooks} to @code{t} around doing so, to
-avoid confusing the internal mechanism that calls these hooks.
+@c If these functions modify the buffer, they should bind
+@c @code{inhibit-modification-hooks} to @code{t} around doing so, to
+@c avoid confusing the internal mechanism that calls these hooks.
+
+When these functions are called, @code{inhibit-modification-hooks} is
+bound to non-@code{nil}. If the functions modify the buffer, you
+might want to bind @code{inhibit-modification-hooks} to nil, so as to
+cause the change hooks to run for these modifications. @xref{Change
+Hooks}. However, doing this can sometimes confuse the internal
+mechanism that calls all these hooks, leading, for example, to calling
+them recursively, which is usually unwanted.
Text properties also support the @code{modification-hooks} property,
but the details are somewhat different (@pxref{Special Properties}).
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 278bc3c268..fd4338ecdb 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -3621,9 +3621,14 @@ Special Properties
hook will only be run when removing some characters, replacing them
with others, or changing their text-properties.
-If these functions modify the buffer, they should bind
-@code{inhibit-modification-hooks} to @code{t} around doing so, to
-avoid confusing the internal mechanism that calls these hooks.
+@c If these functions modify the buffer, they should bind
+@c @code{inhibit-modification-hooks} to @code{t} around doing so, to
+@c avoid confusing the internal mechanism that calls these hooks.
+
+When Emacs calls these functions, @code{inhibit-modification-hooks} is
+set to @code{nil}. If the functions modify the buffer, you should
+consider binding this variable to non-@code{nil}, to avoid confusing
+the internal mechanism that calls these hooks. @xref{Change Hooks}.
Overlays also support the @code{modification-hooks} property, but the
details are somewhat different (@pxref{Overlay Properties}).
--
Alan Mackenzie (Nuremberg, Germany).
next prev parent reply other threads:[~2019-05-19 20:31 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-04 20:53 bug#25111: Phillip Lord
2016-12-05 15:33 ` bug#25111: Eli Zaretskii
[not found] ` <87wpfbpual.fsf@russet.org.uk>
2016-12-07 16:40 ` bug#25111: Phillip Lord
[not found] ` <WM!2f8d5bad87de09a0621b1f025704a97dd719ed1ae7d08e03f6b419e215cd51bc54917b522795d7421de3533c07950608!@mailhub-mx1>
2016-12-08 15:55 ` bug#25111: Eli Zaretskii
2016-12-09 17:17 ` bug#25111: Phillip Lord
2016-12-09 17:26 ` bug#25111: Eli Zaretskii
2016-12-11 22:11 ` bug#25111: Phillip Lord
2016-12-12 16:06 ` bug#25111: Eli Zaretskii
2019-05-19 20:31 ` Alan Mackenzie [this message]
2019-05-25 12:39 ` bug#25111: (Inaccurate documentation of inhibit-modification-hooks) Noam Postavsky
2019-05-25 13:44 ` Alan Mackenzie
2019-05-25 14:36 ` Noam Postavsky
2019-05-27 14:31 ` Alan Mackenzie
2019-06-03 19:15 ` Alan Mackenzie
2019-06-03 19:26 ` npostavs
2019-06-04 9:32 ` Alan Mackenzie
2019-06-04 14:36 ` Eli Zaretskii
2019-06-09 12:00 ` Eli Zaretskii
2019-06-09 20:45 ` Alan Mackenzie
2019-06-24 12:52 ` Alan Mackenzie
2019-06-24 22:48 ` Noam Postavsky
2019-06-25 9:17 ` Alan Mackenzie
2019-05-25 13:49 ` Eli Zaretskii
2016-12-05 17:39 ` bug#25111: How modification-hooks let-bind inhibit-modification-hooks? Noam Postavsky
2016-12-05 18:37 ` Eli Zaretskii
2017-03-09 19:34 ` Noam Postavsky
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190519203119.GA5309@ACM \
--to=acm@muc.de \
--cc=25111@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=npostavs@gmail.com \
--cc=phillip.lord@russet.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).