procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix Elisp manual entry on 'set-window-configuration'

Browse source 
* doc/lispref/windows.texi (Window Configurations): Fix
description of 'set-window-configuration'.
This commit is contained in:
Martin Rudalics 2020-04-15 10:18:15 +02:00
parent 485f24223f
commit e5ca8e5e73
1 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
doc/lispref/windows.texi
View file

@ -5861,25 +5861,26 @@ which window parameters (if any) are saved by this function.
@defun set-window-configuration configuration @defun set-window-configuration configuration
This function restores the configuration of windows and buffers as This function restores the configuration of windows and buffers as
specified by @var{configuration}, for the frame that @var{configuration} specified by @var{configuration}, for the frame that
was created for. @var{configuration} was created for, regardless of whether that frame
is selected or not. The argument @var{configuration} must be a value
that was previously returned by @code{current-window-configuration}
for that frame.
The argument @var{configuration} must be a value that was previously If the frame from which @var{configuration} was saved is dead, all
returned by @code{current-window-configuration}. The configuration is this function does is to restore the value of the variable
restored in the frame from which @var{configuration} was made, whether @code{minibuffer-scroll-window} and to adjust the value returned by
that frame is selected or not. In some rare cases this may trigger @code{minibuffer-selected-window}. In this case, the function returns
execution of the @code{window-size-change-functions} (@pxref{Window @code{nil}. Otherwise, it returns @code{t}.
Hooks}) even if the size of windows did not change at all. The
@code{window-configuration-change-hook} functions will be called if and
only if at least one window was added to or deleted from the frame.
If the frame from which @var{configuration} was saved is dead, all this If the buffer of a window of @var{configuration} has been killed since
function does is restore the three variables @code{window-min-height}, @var{configuration} was made, that window is, as a rule, removed from
@code{window-min-width} and @code{minibuffer-scroll-window}. In this the restored configuration. However, if that window is the last
case, the function returns @code{nil}. Otherwise, it returns @code{t}. window remaining in the restored configuration, another live buffer is
shown in it.
Here is a way of using this function to get the same effect Here is a way of using this function to get the same effect as
as @code{save-window-excursion}: @code{save-window-excursion}:
@example @example
@group @group