diff options
| author | Martin Rudalics | 2008-10-23 09:20:55 +0000 |
|---|---|---|
| committer | Martin Rudalics | 2008-10-23 09:20:55 +0000 |
| commit | 4d48fcdc0f06e4d0061c57d2ae79e2e77c71cb36 (patch) | |
| tree | a53f7b3141654dc75d59dff0684296048b8d8e82 | |
| parent | cd265ca60fa8bc6294137426e792b876d165f15e (diff) | |
| download | emacs-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/ChangeLog | 10 | ||||
| -rw-r--r-- | doc/lispref/buffers.texi | 44 |
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 @@ | |||
| 1 | 2008-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 | |||
| 1 | 2008-10-22 Chong Yidong <cyd@stupidchicken.com> | 11 | 2008-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 |
| 197 | This function makes @var{buffer-or-name} the current buffer. This does | 197 | This function makes @var{buffer-or-name} the current buffer. An error |
| 198 | not display the buffer in any window, so the user cannot necessarily see | 198 | is signaled if @var{buffer-or-name} is not an existing buffer or the |
| 199 | the buffer. But Lisp programs will now operate on it. | 199 | name of an existing buffer. The return value is the buffer made |
| 200 | 200 | current. | |
| 201 | This function returns the buffer identified by @var{buffer-or-name}. | 201 | |
| 202 | An error is signaled if @var{buffer-or-name} does not identify an | 202 | This function does not display the buffer in any window, so the user |
| 203 | existing buffer. | 203 | cannot necessarily see the buffer. But Lisp programs will now operate |
| 204 | on 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 |
| 273 | This function returns the name of @var{buffer} as a string. If | 274 | This 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 | ||
| 276 | If @code{buffer-name} returns @code{nil}, it means that @var{buffer} | 277 | If @code{buffer-name} returns @code{nil}, it means that @var{buffer} |
| 277 | has been killed. @xref{Killing Buffers}. | 278 | has been killed. @xref{Killing Buffers}. |
| @@ -883,8 +884,12 @@ buffer that you bury will come last in the value of @code{(buffer-list | |||
| 883 | If @var{buffer-or-name} is @code{nil} or omitted, this means to bury the | 884 | If @var{buffer-or-name} is @code{nil} or omitted, this means to bury the |
| 884 | current buffer. In addition, if the buffer is displayed in the selected | 885 | current buffer. In addition, if the buffer is displayed in the selected |
| 885 | window, this switches to some other buffer (obtained using | 886 | window, 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 |
| 887 | displayed in some other window, it remains displayed there. | 888 | is dedicated to its buffer, it deletes that window if there are other |
| 889 | windows left on its frame. Otherwise, if the selected window is the | ||
| 890 | only window on its frame, it iconifies that frame. If | ||
| 891 | @var{buffer-or-name} is displayed in some other window, it remains | ||
| 892 | displayed there. | ||
| 888 | 893 | ||
| 889 | To replace a buffer in all the windows that display it, use | 894 | To 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 |
| 906 | subprocess can also create a buffer (@pxref{Processes}). | 911 | subprocess can also create a buffer (@pxref{Processes}). |
| 907 | 912 | ||
| 908 | @defun get-buffer-create name | 913 | @defun get-buffer-create buffer-or-name |
| 909 | This function returns a buffer named @var{name}. It returns a live | 914 | This function returns a buffer named @var{buffer-or-name}. An error is |
| 910 | buffer with that name, if one exists; otherwise, it creates a new | 915 | signaled if @var{buffer-or-name} is neither a string nor a buffer. The |
| 911 | buffer. The buffer does not become the current buffer---this function | 916 | buffer returned does not become the current buffer---this function does |
| 912 | does not change which buffer is current. | 917 | not change which buffer is current. |
| 913 | 918 | ||
| 914 | If @var{name} is a buffer instead of a string, it is returned, even if | 919 | If @var{buffer-or-name} is a string and a live buffer with that name |
| 915 | it is dead. An error is signaled if @var{name} is neither a string | 920 | exists, it returns that buffer. If no such buffer exists, it creates a |
| 916 | nor a buffer. | 921 | new buffer. If @var{buffer-or-name} is a buffer instead of a string, it |
| 922 | is returned as given, even if it is dead. | ||
| 917 | 923 | ||
| 918 | @example | 924 | @example |
| 919 | @group | 925 | @group |