diff options
| author | Eli Zaretskii | 2023-02-18 19:45:33 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2023-02-18 19:45:33 +0200 |
| commit | fb5299ba0993a8f121b5ae62793f291bd565bb1b (patch) | |
| tree | 51cbeffaba4b2cd5bc93b4ebe8e3f2d12bbfc6a4 | |
| parent | 9f508cef85df64ccbafada477bbb17a8439bc839 (diff) | |
| download | emacs-fb5299ba0993a8f121b5ae62793f291bd565bb1b.tar.gz emacs-fb5299ba0993a8f121b5ae62793f291bd565bb1b.zip | |
; Fix wording of last change.
| -rw-r--r-- | doc/lispref/windows.texi | 54 |
1 files changed, 30 insertions, 24 deletions
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 1ec645721ca..01ac6fb901a 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -630,11 +630,11 @@ example, by calling @code{select-window} with argument @var{norecord} | |||
| 630 | with @var{window} as the selected window without needlessly running | 630 | with @var{window} as the selected window without needlessly running |
| 631 | @code{buffer-list-update-hook}. | 631 | @code{buffer-list-update-hook}. |
| 632 | 632 | ||
| 633 | Note that this macro temporarily puts the window management code in a | 633 | Note that this macro temporarily puts the window management code in an |
| 634 | unstable state. In particular, the most recently window (see below) | 634 | unstable state. In particular, the most recently used window (see below) |
| 635 | will not necessarily match the selected one. Hence, functions like | 635 | will not necessarily match the selected one. Hence, functions like |
| 636 | @code{get-lru-window} and @code{get-mru-window} may return unexpected | 636 | @code{get-lru-window} and @code{get-mru-window} may return unexpected |
| 637 | results when called from within the scope of this macro. | 637 | results when called from the body of this macro. |
| 638 | @end defmac | 638 | @end defmac |
| 639 | 639 | ||
| 640 | @defmac with-selected-frame frame forms@dots{} | 640 | @defmac with-selected-frame frame forms@dots{} |
| @@ -662,10 +662,11 @@ selected window unless @code{with-selected-window} has been used. | |||
| 662 | @end defun | 662 | @end defun |
| 663 | 663 | ||
| 664 | @defun window-bump-use-time &optional window | 664 | @defun window-bump-use-time &optional window |
| 665 | This function marks @var{window} as being the second most recently used | 665 | This function marks @var{window} as being the second most recently |
| 666 | one. It does nothing if @var{window} is the selected window or the | 666 | used one (after the selected window). It does nothing if @var{window} |
| 667 | selected window does not have the highest use time among all windows | 667 | is the selected window or the selected window does not have the |
| 668 | which may happen within the scope of @code{with-selected-window}. | 668 | highest use time among all windows which may happen within the scope |
| 669 | of @code{with-selected-window}. | ||
| 669 | @end defun | 670 | @end defun |
| 670 | 671 | ||
| 671 | @anchor{Window Group}Sometimes several windows collectively and | 672 | @anchor{Window Group}Sometimes several windows collectively and |
| @@ -3068,29 +3069,30 @@ entry. | |||
| 3068 | @vindex window-min-width@r{, a buffer display action alist entry} | 3069 | @vindex window-min-width@r{, a buffer display action alist entry} |
| 3069 | @item window-min-width | 3070 | @item window-min-width |
| 3070 | The value specifies a minimum width of the window used, in canonical | 3071 | The value specifies a minimum width of the window used, in canonical |
| 3071 | frame columns. The special value @code{full-width} means the window | 3072 | frame columns. The special value @code{full-width} means the chosen |
| 3072 | chosen should be one has no other windows on the left or right it in its | 3073 | window should be one that has no other windows on the left or right of |
| 3073 | frame. | 3074 | it in its frame. |
| 3074 | 3075 | ||
| 3075 | This entry is currently honored by @code{display-buffer-use-some-window} | 3076 | This entry is currently honored by @code{display-buffer-use-some-window} |
| 3076 | and @code{display-buffer-use-least-recent-window} who try hard to avoid | 3077 | and @code{display-buffer-use-least-recent-window}, which try hard to avoid |
| 3077 | returning a less recently used window that does not satisfy it. | 3078 | returning a less recently used window that does not satisfy the entry. |
| 3078 | 3079 | ||
| 3079 | Note that providing such an entry alone does not necessarily make the | 3080 | Note that providing such an entry alone does not necessarily make the |
| 3080 | window as wide as specified by its value. To actually resize an | 3081 | window as wide as specified by its value. To actually resize an |
| 3081 | existing window or make a new window as wide as specified by that value, | 3082 | existing window or make a new window as wide as specified by this |
| 3082 | a @code{window-width} entry specifying that value should be provided as | 3083 | entry's value, a @code{window-width} entry specifying that value |
| 3083 | well. Such a @code{window-width} entry can, however, specify a | 3084 | should be provided as well. Such a @code{window-width} entry can, |
| 3084 | completely different value or ask the window width to be fit to that of | 3085 | however, specify a completely different value, or ask the window width |
| 3085 | its buffer in which case the @code{window-min-width} entry provides the | 3086 | to fit that of its buffer, in which case the |
| 3086 | guaranteed minimum width of the window used. | 3087 | @code{window-min-width} entry provides the guaranteed minimum width of |
| 3088 | the window. | ||
| 3087 | 3089 | ||
| 3088 | @vindex window-min-height@r{, a buffer display action alist entry} | 3090 | @vindex window-min-height@r{, a buffer display action alist entry} |
| 3089 | @item window-min-height | 3091 | @item window-min-height |
| 3090 | The value specifies a minimum height of the window used, in canonical | 3092 | The value specifies a minimum height of the window used, in canonical |
| 3091 | frame lines. The special value @code{full-height} means the window | 3093 | frame lines. The special value @code{full-height} means the chosen |
| 3092 | chosen should be a full-height window, one has no other windows above or | 3094 | window should be a full-height window, one that has no other windows |
| 3093 | below it in its frame. | 3095 | above or below it in its frame. |
| 3094 | 3096 | ||
| 3095 | This entry is currently honored by @code{display-buffer-below-selected} | 3097 | This entry is currently honored by @code{display-buffer-below-selected} |
| 3096 | which does not use a window that is not as high as specified by this | 3098 | which does not use a window that is not as high as specified by this |
| @@ -3228,7 +3230,7 @@ after this list. | |||
| 3228 | 3230 | ||
| 3229 | @vindex lru-frames@r{, a buffer display action alist entry} | 3231 | @vindex lru-frames@r{, a buffer display action alist entry} |
| 3230 | @item lru-frames | 3232 | @item lru-frames |
| 3231 | The value specifies the set of frames to search for window that can be | 3233 | The value specifies the set of frames to search for a window that can be |
| 3232 | used to display the buffer. It is honored by | 3234 | used to display the buffer. It is honored by |
| 3233 | @code{display-buffer-use-some-window} and | 3235 | @code{display-buffer-use-some-window} and |
| 3234 | @code{display-buffer-use-least-recent-window} when trying to find a less | 3236 | @code{display-buffer-use-least-recent-window} when trying to find a less |
| @@ -3248,7 +3250,7 @@ functions will not consider such a window for displaying the buffer. | |||
| 3248 | @item bump-use-time | 3250 | @item bump-use-time |
| 3249 | If non-@code{nil}, such an entry will cause @code{display-buffer} to | 3251 | If non-@code{nil}, such an entry will cause @code{display-buffer} to |
| 3250 | bump the use time (@pxref{Selecting Windows}) of the window it uses. | 3252 | bump the use time (@pxref{Selecting Windows}) of the window it uses. |
| 3251 | This should avoid that this window is later used by action functions | 3253 | This should avoid later use of this window by action functions |
| 3252 | like @code{display-buffer-use-some-window} and | 3254 | like @code{display-buffer-use-some-window} and |
| 3253 | @code{display-buffer-use-least-recent-window} for showing another | 3255 | @code{display-buffer-use-least-recent-window} for showing another |
| 3254 | buffer. | 3256 | buffer. |
| @@ -4079,7 +4081,7 @@ related to the new window. For non-input related actions | |||
| 4079 | @code{display-buffer-below-selected} might be preferable because the | 4081 | @code{display-buffer-below-selected} might be preferable because the |
| 4080 | selected window usually already has the user's attention. | 4082 | selected window usually already has the user's attention. |
| 4081 | 4083 | ||
| 4082 | @item Take care about which window is selected | 4084 | @item Take care which window is selected |
| 4083 | Many applications call @code{display-buffer} from within window | 4085 | Many applications call @code{display-buffer} from within window |
| 4084 | excursions produced by @code{with-selected-window} or | 4086 | excursions produced by @code{with-selected-window} or |
| 4085 | @code{select-window} calls with a non-@code{nil} @var{norecord} | 4087 | @code{select-window} calls with a non-@code{nil} @var{norecord} |
| @@ -4102,6 +4104,7 @@ window, evaluating the following form | |||
| 4102 | @end group | 4104 | @end group |
| 4103 | @end example | 4105 | @end example |
| 4104 | 4106 | ||
| 4107 | @noindent | ||
| 4105 | will display a window showing the @file{*Messages*} buffer at the bottom | 4108 | will display a window showing the @file{*Messages*} buffer at the bottom |
| 4106 | and leave the other window selected. Evaluating the next form | 4109 | and leave the other window selected. Evaluating the next form |
| 4107 | 4110 | ||
| @@ -4112,6 +4115,7 @@ and leave the other window selected. Evaluating the next form | |||
| 4112 | @end group | 4115 | @end group |
| 4113 | @end example | 4116 | @end example |
| 4114 | 4117 | ||
| 4118 | @noindent | ||
| 4115 | will display @file{*Messages*} in a window on the top and select it | 4119 | will display @file{*Messages*} in a window on the top and select it |
| 4116 | which is usually not what @code{display-buffer} is supposed to do. | 4120 | which is usually not what @code{display-buffer} is supposed to do. |
| 4117 | 4121 | ||
| @@ -4125,6 +4129,7 @@ On the other hand, while evaluating the following form | |||
| 4125 | @end group | 4129 | @end group |
| 4126 | @end example | 4130 | @end example |
| 4127 | 4131 | ||
| 4132 | @noindent | ||
| 4128 | will correctly select the @file{*Messages*} buffer, the next form | 4133 | will correctly select the @file{*Messages*} buffer, the next form |
| 4129 | 4134 | ||
| 4130 | @example | 4135 | @example |
| @@ -4136,6 +4141,7 @@ will correctly select the @file{*Messages*} buffer, the next form | |||
| 4136 | @end group | 4141 | @end group |
| 4137 | @end example | 4142 | @end example |
| 4138 | 4143 | ||
| 4144 | @noindent | ||
| 4139 | will not. | 4145 | will not. |
| 4140 | 4146 | ||
| 4141 | Also, invocations of action functions like | 4147 | Also, invocations of action functions like |