summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2021-01-27 07:55:11 -0800
committerGlenn Morris <rgm@gnu.org>2021-01-27 07:55:11 -0800
commit4be6c9215bdc5c6856e6d1b2c445f4a268a6f2be (patch)
tree8fbe8146c3cb052f0b6d29b335add60b559a2390 /doc
parent27889f029ac3728edaf9a6b1c9c0c511cb22c6fc (diff)
parent3443a1c698790fca0481178f08dcb45cca576a30 (diff)
downloademacs-4be6c9215bdc5c6856e6d1b2c445f4a268a6f2be.tar.gz
Merge from origin/emacs-27
3443a1c698 Fix last change
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/text.texi17
1 files changed, 15 insertions, 2 deletions
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi
index 14854a5aafa..b3673465240 100644
--- a/doc/lispref/text.texi
+++ b/doc/lispref/text.texi
@@ -1441,6 +1441,11 @@ the @code{amalgamating-undo-limit} variable. If this variable is 1,
no changes are amalgamated.
@end defun
+A Lisp program can amalgamate a series of changes into a single change
+group by calling @code{undo-amalgamate-change-group} (@pxref{Atomic
+Changes}). Note that @code{amalgamating-undo-limit} has no effect on
+the groups produced by that function.
+
@defvar undo-auto-current-boundary-timer
Some buffers, such as process buffers, can change even when no
commands are executing. In these cases, @code{undo-boundary} is
@@ -5629,9 +5634,17 @@ This function cancels and undoes all the changes in the change group
specified by @var{handle}.
@end defun
+ You can cause some or all of the changes in a change group to be
+considered as a single unit for the purposes of the @code{undo}
+commands (@pxref{Undo}) by using @code{undo-amalgamate-change-group}.
+
@defun undo-amalgamate-change-group
-Amalgamate changes in change-group since @var{handle}. I.e., remove
-all undo boundaries between the state of @var{handle} and now.
+Amalgamate all the changes made in the change-group since the state
+identified by @var{handle}. This function removes all undo boundaries
+between undo records of changes since the state described by
+@var{handle}. Usually, @var{handle} is the handle returned by
+@code{prepare-change-group}, in which case all the changes since the
+beginning of the change-group are amalgamated into a single undo unit.
@end defun
Your code should use @code{unwind-protect} to make sure the group is