changeset 99036:26ffccc14770

(Killing Buffers): Update documentation of kill-buffer.
author Martin Rudalics <rudalics@gmx.at>
date Wed, 22 Oct 2008 16:07:55 +0000
parents 90d78f7a7eba
children fcf50f75628d
files doc/lispref/buffers.texi
diffstat 1 files changed, 6 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/doc/lispref/buffers.texi	Wed Oct 22 15:35:00 2008 +0000
+++ b/doc/lispref/buffers.texi	Wed Oct 22 16:07:55 2008 +0000
@@ -996,10 +996,11 @@
 @end group
 @end example
 
-@deffn Command kill-buffer buffer-or-name
+@deffn Command kill-buffer &optional buffer-or-name
 This function kills the buffer @var{buffer-or-name}, freeing all its
 memory for other uses or to be returned to the operating system.  If
-@var{buffer-or-name} is @code{nil}, it kills the current buffer.
+@var{buffer-or-name} is @code{nil} or omitted, it kills the current
+buffer.
 
 Any processes that have this buffer as the @code{process-buffer} are
 sent the @code{SIGHUP} signal, which normally causes them to terminate.
@@ -1012,6 +1013,9 @@
 for confirmation, clear the modified flag before calling
 @code{kill-buffer}.  @xref{Buffer Modification}.
 
+This function calls `replace-buffer-in-windows' for cleaning up all
+windows currently displaying the buffer to be killed.
+
 Killing a buffer that is already dead has no effect.
 
 This function returns @code{t} if it actually killed the buffer.  It