aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Rudalics2008-10-23 09:20:55 +0000
committerMartin Rudalics2008-10-23 09:20:55 +0000
commit4d48fcdc0f06e4d0061c57d2ae79e2e77c71cb36 (patch)
treea53f7b3141654dc75d59dff0684296048b8d8e82
parentcd265ca60fa8bc6294137426e792b876d165f15e (diff)
downloademacs-4d48fcdc0f06e4d0061c57d2ae79e2e77c71cb36.tar.gz
emacs-4d48fcdc0f06e4d0061c57d2ae79e2e77c71cb36.zip
(Current Buffer): Reword documentation of set-buffer.
(Buffer Names): Reword documentation of buffer-name. (The Buffer List): For bury-buffer explain what happens with the buffer's window. (Creating Buffers): Say that get-buffer-create's arg is buffer-or-name.
-rw-r--r--doc/lispref/ChangeLog10
-rw-r--r--doc/lispref/buffers.texi44
2 files changed, 35 insertions, 19 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index e41fb3aba00..fb37335d855 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,13 @@
12008-10-23 Martin Rudalics <rudalics@gmx.at>
2
3 * buffers.texi (Current Buffer): Reword documentation of
4 set-buffer.
5 (Buffer Names): Reword documentation of buffer-name.
6 (The Buffer List): For bury-buffer explain what happens with the
7 buffer's window.
8 (Creating Buffers): Say that get-buffer-create's arg is called
9 buffer-or-name.
10
12008-10-22 Chong Yidong <cyd@stupidchicken.com> 112008-10-22 Chong Yidong <cyd@stupidchicken.com>
2 12
3 * advice.texi (Computed Advice): Explain what DEFINITION is. 13 * advice.texi (Computed Advice): Explain what DEFINITION is.
diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi
index 2e0e64f7722..5bf27eda420 100644
--- a/doc/lispref/buffers.texi
+++ b/doc/lispref/buffers.texi
@@ -194,13 +194,14 @@ This function returns the current buffer.
194@end defun 194@end defun
195 195
196@defun set-buffer buffer-or-name 196@defun set-buffer buffer-or-name
197This function makes @var{buffer-or-name} the current buffer. This does 197This function makes @var{buffer-or-name} the current buffer. An error
198not display the buffer in any window, so the user cannot necessarily see 198is signaled if @var{buffer-or-name} is not an existing buffer or the
199the buffer. But Lisp programs will now operate on it. 199name of an existing buffer. The return value is the buffer made
200 200current.
201This function returns the buffer identified by @var{buffer-or-name}. 201
202An error is signaled if @var{buffer-or-name} does not identify an 202This function does not display the buffer in any window, so the user
203existing buffer. 203cannot necessarily see the buffer. But Lisp programs will now operate
204on it.
204@end defun 205@end defun
205 206
206@defspec save-current-buffer body@dots{} 207@defspec save-current-buffer body@dots{}
@@ -270,8 +271,8 @@ space also initially disables recording undo information; see
270@ref{Undo}. 271@ref{Undo}.
271 272
272@defun buffer-name &optional buffer 273@defun buffer-name &optional buffer
273This function returns the name of @var{buffer} as a string. If 274This function returns the name of @var{buffer} as a string.
274@var{buffer} is not supplied, it defaults to the current buffer. 275@var{buffer} defaults to the current buffer.
275 276
276If @code{buffer-name} returns @code{nil}, it means that @var{buffer} 277If @code{buffer-name} returns @code{nil}, it means that @var{buffer}
277has been killed. @xref{Killing Buffers}. 278has been killed. @xref{Killing Buffers}.
@@ -883,8 +884,12 @@ buffer that you bury will come last in the value of @code{(buffer-list
883If @var{buffer-or-name} is @code{nil} or omitted, this means to bury the 884If @var{buffer-or-name} is @code{nil} or omitted, this means to bury the
884current buffer. In addition, if the buffer is displayed in the selected 885current buffer. In addition, if the buffer is displayed in the selected
885window, this switches to some other buffer (obtained using 886window, this switches to some other buffer (obtained using
886@code{other-buffer}) in the selected window. But if the buffer is 887@code{other-buffer}) in the selected window. But if the selected window
887displayed in some other window, it remains displayed there. 888is dedicated to its buffer, it deletes that window if there are other
889windows left on its frame. Otherwise, if the selected window is the
890only window on its frame, it iconifies that frame. If
891@var{buffer-or-name} is displayed in some other window, it remains
892displayed there.
888 893
889To replace a buffer in all the windows that display it, use 894To replace a buffer in all the windows that display it, use
890@code{replace-buffer-in-windows}. @xref{Buffers and Windows}. 895@code{replace-buffer-in-windows}. @xref{Buffers and Windows}.
@@ -905,15 +910,16 @@ buffer and gives it a unique name.
905@code{create-file-buffer} (@pxref{Visiting Files}). Starting a 910@code{create-file-buffer} (@pxref{Visiting Files}). Starting a
906subprocess can also create a buffer (@pxref{Processes}). 911subprocess can also create a buffer (@pxref{Processes}).
907 912
908@defun get-buffer-create name 913@defun get-buffer-create buffer-or-name
909This function returns a buffer named @var{name}. It returns a live 914This function returns a buffer named @var{buffer-or-name}. An error is
910buffer with that name, if one exists; otherwise, it creates a new 915signaled if @var{buffer-or-name} is neither a string nor a buffer. The
911buffer. The buffer does not become the current buffer---this function 916buffer returned does not become the current buffer---this function does
912does not change which buffer is current. 917not change which buffer is current.
913 918
914If @var{name} is a buffer instead of a string, it is returned, even if 919If @var{buffer-or-name} is a string and a live buffer with that name
915it is dead. An error is signaled if @var{name} is neither a string 920exists, it returns that buffer. If no such buffer exists, it creates a
916nor a buffer. 921new buffer. If @var{buffer-or-name} is a buffer instead of a string, it
922is returned as given, even if it is dead.
917 923
918@example 924@example
919@group 925@group