aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Rudalics2020-04-15 10:18:15 +0200
committerMartin Rudalics2020-04-15 10:18:15 +0200
commite5ca8e5e73acbe9147203d1365365626fc35441e (patch)
tree467d6bf403c7664e5fb8b4658f5bbb6b8eaf028d
parent485f24223fdca91d439b7beaaac33f66cb3bc2af (diff)
downloademacs-e5ca8e5e73acbe9147203d1365365626fc35441e.tar.gz
emacs-e5ca8e5e73acbe9147203d1365365626fc35441e.zip
Fix Elisp manual entry on 'set-window-configuration'
* doc/lispref/windows.texi (Window Configurations): Fix description of 'set-window-configuration'.
-rw-r--r--doc/lispref/windows.texi39
1 files changed, 20 insertions, 19 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index c9301c9d186..a19f123c658 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -5861,25 +5861,26 @@ which window parameters (if any) are saved by this function.
5861 5861
5862@defun set-window-configuration configuration 5862@defun set-window-configuration configuration
5863This function restores the configuration of windows and buffers as 5863This function restores the configuration of windows and buffers as
5864specified by @var{configuration}, for the frame that @var{configuration} 5864specified by @var{configuration}, for the frame that
5865was created for. 5865@var{configuration} was created for, regardless of whether that frame
5866 5866is selected or not. The argument @var{configuration} must be a value
5867The argument @var{configuration} must be a value that was previously 5867that was previously returned by @code{current-window-configuration}
5868returned by @code{current-window-configuration}. The configuration is 5868for that frame.
5869restored in the frame from which @var{configuration} was made, whether 5869
5870that frame is selected or not. In some rare cases this may trigger 5870If the frame from which @var{configuration} was saved is dead, all
5871execution of the @code{window-size-change-functions} (@pxref{Window 5871this function does is to restore the value of the variable
5872Hooks}) even if the size of windows did not change at all. The 5872@code{minibuffer-scroll-window} and to adjust the value returned by
5873@code{window-configuration-change-hook} functions will be called if and 5873@code{minibuffer-selected-window}. In this case, the function returns
5874only if at least one window was added to or deleted from the frame. 5874@code{nil}. Otherwise, it returns @code{t}.
5875 5875
5876If the frame from which @var{configuration} was saved is dead, all this 5876If the buffer of a window of @var{configuration} has been killed since
5877function does is restore the three variables @code{window-min-height}, 5877@var{configuration} was made, that window is, as a rule, removed from
5878@code{window-min-width} and @code{minibuffer-scroll-window}. In this 5878the restored configuration. However, if that window is the last
5879case, the function returns @code{nil}. Otherwise, it returns @code{t}. 5879window remaining in the restored configuration, another live buffer is
5880 5880shown in it.
5881Here is a way of using this function to get the same effect 5881
5882as @code{save-window-excursion}: 5882Here is a way of using this function to get the same effect as
5883@code{save-window-excursion}:
5883 5884
5884@example 5885@example
5885@group 5886@group