summaryrefslogtreecommitdiff
path: root/lisp
diff options
context:
space:
mode:
authorChong Yidong <cyd@gnu.org>2012-09-07 21:53:21 +0800
committerChong Yidong <cyd@gnu.org>2012-09-07 21:53:21 +0800
commitcee2e90d475f6d9dbdb7e92a127b65faa342665c (patch)
tree610d89ce5fa1893f91fd0d991b30201e78f9a4bb /lisp
parent4d64875a837a2d338bf776872f5f76522b707099 (diff)
downloademacs-cee2e90d475f6d9dbdb7e92a127b65faa342665c.tar.gz
emacs-cee2e90d475f6d9dbdb7e92a127b65faa342665c.tar.bz2
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 'lisp')
-rw-r--r--lisp/ChangeLog2
-rw-r--r--lisp/window.el34
2 files changed, 20 insertions, 16 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index db3a3f5d044..95a6c1e7174 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,7 @@
2012-09-07 Chong Yidong <cyd@gnu.org>
+ * window.el (switch-to-buffer): Doc fix (Bug#12181).
+
* files.el (after-find-file): Don't fail on a read-only buffer if
require-final-newline is `visit' or `visit-save' (Bug#11156).
diff --git a/lisp/window.el b/lisp/window.el
index 66b86f45e77..0e03268029c 100644
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -5642,26 +5642,28 @@ buffer with the name BUFFER-OR-NAME and return that buffer."
(defun switch-to-buffer (buffer-or-name &optional norecord force-same-window)
"Switch to buffer BUFFER-OR-NAME in the selected window.
-If called interactively, prompt for the buffer name using the
+If the selected window cannot display the specified
+buffer (e.g. if it is a minibuffer window or strongly dedicated
+to another buffer), call `pop-to-buffer' to select the buffer in
+another window.
+
+If called interactively, read the buffer name using the
minibuffer. The variable `confirm-nonexistent-file-or-buffer'
determines whether to request confirmation before creating a new
buffer.
-BUFFER-OR-NAME may be a buffer, a string (a buffer name), or
-nil. If BUFFER-OR-NAME is a string that does not identify an
-existing buffer, create a buffer with that name. If
-BUFFER-OR-NAME is nil, switch to the buffer returned by
-`other-buffer'.
-
-Optional argument NORECORD non-nil means do not put the buffer
-specified by BUFFER-OR-NAME at the front of the buffer list and
-do not make the window displaying it the most recently selected
-one.
-
-If FORCE-SAME-WINDOW is non-nil, BUFFER-OR-NAME must be displayed
-in the selected window; signal an error if that is
-impossible (e.g. if the selected window is minibuffer-only). If
-nil, BUFFER-OR-NAME may be displayed in another window.
+BUFFER-OR-NAME may be a buffer, a string (a buffer name), or nil.
+If BUFFER-OR-NAME is a string that does not identify an existing
+buffer, create a buffer with that name. If BUFFER-OR-NAME is
+nil, switch to the buffer returned by `other-buffer'.
+
+If optional argument NORECORD is non-nil, do not put the buffer
+at the front of the buffer list, and do not make the window
+displaying it the most recently selected one.
+
+If optional argument FORCE-SAME-WINDOW is non-nil, the buffer
+must be displayed in the selected window; if that is impossible,
+signal an error rather than calling `pop-to-buffer'.
Return the buffer switched to."
(interactive