From 590c056d7e48687031c391ac2f073bc25a990f10 Mon Sep 17 00:00:00 2001 From: Martin Rudalics Date: Sun, 25 Sep 2011 12:11:25 +0200 Subject: [PATCH] Some minor changes in windows section. * windows.texi (Windows and Frames, Display Action Functions) (Switching Buffers): Fix some typos. (Buffers and Windows): Remove reference to window-auto-delete. Reword description of replace-buffer-in-windows. (Window History): Fix some typos and refer to frame local buffer list. --- doc/lispref/ChangeLog | 9 ++++++ doc/lispref/windows.texi | 59 ++++++++++++++++++++-------------------- 2 files changed, 39 insertions(+), 29 deletions(-) diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index c99d565895..e45fa693fe 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,12 @@ +2011-09-25 Martin Rudalics + + * windows.texi (Windows and Frames, Display Action Functions) + (Switching Buffers): Fix some typos. + (Buffers and Windows): Remove reference to window-auto-delete. + Reword description of replace-buffer-in-windows. + (Window History): Fix some typos and refer to frame local buffer + list. + 2011-09-25 Chong Yidong * windows.texi (Display Action Functions) diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 6565a01441..1276246a0e 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -294,7 +294,7 @@ optional argument @var{window} can be an arbitrary window and defaults to the selected one. The return value is @code{nil} if @var{window} is a live window or its children form a vertical combination. In the example above @code{(window-left-child W4)} is @code{W6} while -@code{(window-top-child W3)} is @code{nil}. +@code{(window-left-child W3)} is @code{nil}. @end defun @defun window-child window @@ -2078,15 +2078,15 @@ buffer using @code{switch-to-prev-buffer} (@pxref{Window History}). buffer; it defaults to the current buffer. If a window displaying @var{buffer-or-name} is dedicated -(@pxref{Dedicated Windows}) has never displayed any other buffers and +(@pxref{Dedicated Windows}), has never displayed any other buffers and is not the only window on its frame, that window is deleted. If that -window is the only window on its frame and there are other frames on -the frame's terminal, that frame is deleted too; otherwise, some other -buffer is displayed in that window, as explained above. A user can -prevent the deletion of windows and/or frames by customizing the -option @code{window-auto-delete}. +window is the only window on its frame and there are other frames on the +frame's terminal, that frame is deleted too; otherwise, the buffer +provided by the function @code{switch-to-prev-buffer} (@pxref{Window +History}) is displayed instead. @end deffn + @node Switching Buffers @section Switching to a Buffer in a Window @cindex switching to a buffer @@ -2123,12 +2123,12 @@ list---both the global buffer list and the selected frame's buffer list (@pxref{The Buffer List}). However, this is not done if the optional argument @var{norecord} is non-@code{nil}. -If this function is unable to display in the seleted window---usually -because the selected window is a minibuffer window or is strongly -dedicated to its buffer (@pxref{Dedicated Windows})---then it normally -tries to display in some other window, in the manner of -@code{pop-to-buffer} (see below). However, if the optional argument -@var{force-same-window} is non-@code{nil}, it signals an error +If this function is unable to display the buffer in the selected +window---usually because the selected window is a minibuffer window or +is strongly dedicated to its buffer (@pxref{Dedicated Windows})---then +it normally tries to display the buffer in some other window, in the +manner of @code{pop-to-buffer} (see below). However, if the optional +argument @var{force-same-window} is non-@code{nil}, it signals an error instead. @end deffn @@ -2356,7 +2356,7 @@ window. It uses @code{split-window-sensibly} as a subroutine @defun display-buffer-use-some-window buffer alist This function tries to display @var{buffer} by choosing an existing -buffer and displaying the buffer in that window. It can fail if all +window and displaying the buffer in that window. It can fail if all windows are dedicated to another buffer (@pxref{Dedicated Windows}). @end defun @@ -2629,16 +2629,16 @@ If all options described above fail to produce a suitable window, resort, it will try to display @var{buffer-or-name} on a separate frame. In that case, the value of @code{pop-up-frames} is disregarded. + @node Window History @section Window History @cindex window history - Each window remembers the buffers it has displayed earlier and the -order in which these buffers have been removed from it. This history -is used, for example, by @code{replace-buffer-in-windows} -(@pxref{Buffers and Windows}). This list is set automatically -maintained by Emacs, but you can use the following functions to -explicitly inspect or alter it: +Each window remembers the buffers it has displayed earlier and the order +in which these buffers have been removed from it. This history is used, +for example, by @code{replace-buffer-in-windows} (@pxref{Buffers and +Windows}). This list is automatically maintained by Emacs, but you can +use the following functions to explicitly inspect or alter it: @defun window-prev-buffers &optional window This function returns a list specifying the previous contents of @@ -2652,7 +2652,7 @@ buffer was last shown, and @var{window-pos} is the point position when that buffer was last shown. The list is ordered so that earlier elements correspond to more -recently-shown buffers, and the first element corresponds to the +recently-shown buffers, and the first element usually corresponds to the buffer most recently removed from the window. @end defun @@ -2671,8 +2671,9 @@ below). This list is mainly used by @code{switch-to-prev-buffer} and @defun window-next-buffers &optional window This function returns the list of buffers recently re-shown in -@var{window} via @code{switch-to-prev-buffer}. @var{window} should be -a live window or @code{nil} (meaning the selected window). +@var{window} via @code{switch-to-prev-buffer}. The @var{window} +argument must denote a live window or @code{nil} (meaning the selected +window). @end defun @defun set-window-next-buffers window next-buffers @@ -2707,8 +2708,8 @@ or killed or has been already shown by a recent invocation of If repeated invocations of this command have already shown all buffers previously shown in @var{window}, further invocations will show buffers -from the global buffer list starting with the buffer returned by -@code{last-buffer} (@pxref{The Buffer List}). +from the buffer list of the frame @var{window} appears on (@pxref{The +Buffer List}). @end deffn @deffn Command switch-to-next-buffer &optional window @@ -2717,12 +2718,12 @@ the effect of the last @code{switch-to-prev-buffer} command in @var{window}. The argument @var{window} must be a live window and defaults to the selected one. -If there is no recent invocation of a @code{switch-to-prev-buffer} -that can be undone, this function tries to show the first buffer from -the global buffer list as returned by @code{other-buffer} (@pxref{The -Buffer List}). +If there is no recent invocation of a @code{switch-to-prev-buffer} that +can be undone, this function tries to show a buffer from the buffer list +of the frame @var{window} appears on (@pxref{The Buffer List}). @end deffn + @node Dedicated Windows @section Dedicated Windows @cindex dedicated window -- 2.39.2