From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 26 Nov 2015 20:08:54 +0000 (+0200)
Subject: Improve commentary of prepare_to_modify_buffer_1
X-Git-Tag: emacs-25.0.90~639
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3f042f65887672da52c6fe32b6d3254aff4be9c7;p=emacs.git

Improve commentary of prepare_to_modify_buffer_1

* src/insdel.c (prepare_to_modify_buffer_1): Mention in commentary
that this function runs Lisp.  Suggested by Richard Stallman
<rms@gnu.org>.
---

diff --git a/src/insdel.c b/src/insdel.c
index 8b08c1e59b7..bb3171b14ce 100644
--- a/src/insdel.c
+++ b/src/insdel.c
@@ -1785,7 +1785,12 @@ run_undoable_change (void)
    any modification properties the text may have.
 
    If PRESERVE_PTR is nonzero, we relocate *PRESERVE_PTR
-   by holding its value temporarily in a marker.  */
+   by holding its value temporarily in a marker.
+
+   This function runs Lisp, which means it can GC, which means it can
+   compact buffers, including the current buffer being worked on here.
+   So don't you dare calling this function while manipulating the gap,
+   or during some other similar "critical section".  */
 
 void
 prepare_to_modify_buffer_1 (ptrdiff_t start, ptrdiff_t end,