summaryrefslogtreecommitdiff
path: root/doc/lispref/windows.texi
diff options
context:
space:
mode:
authorMartin Rudalics <rudalics@gmx.at>2018-11-18 09:24:10 +0100
committerMartin Rudalics <rudalics@gmx.at>2018-11-18 09:24:10 +0100
commit72525076996cd709086b1afb47ab0d095322e9b7 (patch)
treed86cd2fcd2bf2255d6f246c85552a847b64ef92d /doc/lispref/windows.texi
parent88762b4063a42a69234bda74b1626b646734715a (diff)
downloademacs-72525076996cd709086b1afb47ab0d095322e9b7.tar.gz
Fix description of some window hooks
* doc/lispref/windows.texi (Window Hooks): Remove text that warns against using 'save-window-excursion' while running 'window-size-change-functions', it's no more relevant. Clarify description of 'window-configuration-change-hook'.
Diffstat (limited to 'doc/lispref/windows.texi')
-rw-r--r--doc/lispref/windows.texi32
1 files changed, 15 insertions, 17 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index e9bd0c7d83e..46f106838a5 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -6016,26 +6016,24 @@ whether a specific window has changed size, compare the return values of
@code{window-pixel-height} for that window (@pxref{Window Sizes}).
These function are usually only called when at least one window was
-added or has changed size since the last time this hook was run for the
-associated frame. In some rare cases this hook also runs when a window
-that was added intermittently has been deleted afterwards. In these
-cases none of the windows on the frame will appear to have changed its
-size.
-
-You may use @code{save-selected-window} in these functions
-(@pxref{Selecting Windows}). However, do not use
-@code{save-window-excursion} (@pxref{Window Configurations}); exiting
-that macro counts as a size change, which would cause these functions to
-be called again.
+added or has changed size since the last time this hook was run for
+the associated frame. In some rare cases this hook also runs when a
+window that was added intermittently has been deleted afterwards. In
+these cases none of the windows on the frame will appear to have
+changed its size.
@end defvar
@defvar window-configuration-change-hook
-A normal hook that is run every time the window configuration of a frame
-changes. Window configuration changes include splitting and deleting
-windows, and the display of a different buffer in a window. Resizing the
-frame or individual windows do not count as configuration changes. Use
-@code{window-size-change-functions}, see above, when you want to track
-size changes that are not caused by the deletion or creation of windows.
+A normal hook that is run every time the window configuration of a
+frame changes. Window configuration changes include splitting and
+deleting windows, and the display of a different buffer in a window.
+
+The hook can be also used for tracking changes of window sizes. It
+is, however, not run when the size of a frame changes or automatic
+resizing of a minibuffer window (@pxref{Minibuffer Windows}) changes
+the size of another window. As a rule, adding a function to
+@code{window-size-change-functions}, see above, is the recommended way
+for reliably tracking size changes of any window.
The buffer-local value of this hook is run once for each window on the
affected frame, with the relevant window selected and its buffer