aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorChong Yidong2012-09-07 21:53:21 +0800
committerChong Yidong2012-09-07 21:53:21 +0800
commitcee2e90d475f6d9dbdb7e92a127b65faa342665c (patch)
tree610d89ce5fa1893f91fd0d991b30201e78f9a4bb /doc/lispref
parent4d64875a837a2d338bf776872f5f76522b707099 (diff)
downloademacs-cee2e90d475f6d9dbdb7e92a127b65faa342665c.tar.gz
emacs-cee2e90d475f6d9dbdb7e92a127b65faa342665c.zip
Minor doc fix for switch-to-buffer.
* doc/lispref/windows.texi (Display Action Functions) (Choosing Window Options): Remove obsolete variable display-buffer-reuse-frames. (Switching Buffers): Minor doc tweak for switch-to-buffer. * lisp/window.el (switch-to-buffer): Doc fix. Fixes: debbugs:12181
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/ChangeLog1
-rw-r--r--doc/lispref/windows.texi25
2 files changed, 13 insertions, 13 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 37e96dde077..9a747838c26 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -5,6 +5,7 @@
5 * windows.texi (Display Action Functions) 5 * windows.texi (Display Action Functions)
6 (Choosing Window Options): Remove obsolete variable 6 (Choosing Window Options): Remove obsolete variable
7 display-buffer-reuse-frames. 7 display-buffer-reuse-frames.
8 (Switching Buffers): Minor doc tweak for switch-to-buffer.
8 9
9 * positions.texi (Narrowing): Document buffer-narrowed-p. 10 * positions.texi (Narrowing): Document buffer-narrowed-p.
10 11
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 52bdc9a5fa1..ea48a46359c 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -1492,12 +1492,10 @@ to make a buffer current to modify it in Lisp, use
1492@code{set-buffer}. @xref{Current Buffer}. 1492@code{set-buffer}. @xref{Current Buffer}.
1493 1493
1494@deffn Command switch-to-buffer buffer-or-name &optional norecord force-same-window 1494@deffn Command switch-to-buffer buffer-or-name &optional norecord force-same-window
1495This function displays @var{buffer-or-name} in the selected window, 1495This command attempts to display @var{buffer-or-name} in the selected
1496and makes it the current buffer. (In contrast, @code{set-buffer} 1496window, and makes it the current buffer. It is often used
1497makes the buffer current but does not display it; @pxref{Current 1497interactively (as the binding of @kbd{C-x b}), as well as in Lisp
1498Buffer}). It is often used interactively (as the binding of @kbd{C-x 1498programs. The return value is the buffer switched to.
1499b}), as well as in Lisp programs. The return value is the buffer
1500switched to.
1501 1499
1502If @var{buffer-or-name} is @code{nil}, it defaults to the buffer 1500If @var{buffer-or-name} is @code{nil}, it defaults to the buffer
1503returned by @code{other-buffer} (@pxref{The Buffer List}). If 1501returned by @code{other-buffer} (@pxref{The Buffer List}). If
@@ -1506,17 +1504,18 @@ buffer, this function creates a new buffer with that name; the new
1506buffer's major mode is determined by the variable @code{major-mode} 1504buffer's major mode is determined by the variable @code{major-mode}
1507(@pxref{Major Modes}). 1505(@pxref{Major Modes}).
1508 1506
1509Normally the specified buffer is put at the front of the buffer 1507Normally, the specified buffer is put at the front of the buffer
1510list---both the global buffer list and the selected frame's buffer 1508list---both the global buffer list and the selected frame's buffer
1511list (@pxref{The Buffer List}). However, this is not done if the 1509list (@pxref{The Buffer List}). However, this is not done if the
1512optional argument @var{norecord} is non-@code{nil}. 1510optional argument @var{norecord} is non-@code{nil}.
1513 1511
1514If this function is unable to display the buffer in the selected 1512Sometimes, @code{switch-to-buffer} may be unable to display the buffer
1515window---usually because the selected window is a minibuffer window or 1513in the selected window. This happens if the selected window is a
1516is strongly dedicated to its buffer (@pxref{Dedicated Windows})---then 1514minibuffer window, or if the selected window is strongly dedicated to
1517it normally tries to display the buffer in some other window, in the 1515its buffer (@pxref{Dedicated Windows}). In that case, the command
1518manner of @code{pop-to-buffer} (see below). However, if the optional 1516normally tries to display the buffer in some other window, by invoking
1519argument @var{force-same-window} is non-@code{nil}, it signals an error 1517@code{pop-to-buffer} (see below). However, if the optional argument
1518@var{force-same-window} is non-@code{nil}, it signals an error
1520instead. 1519instead.
1521@end deffn 1520@end deffn
1522 1521