]> git.eshelyaron.com Git - emacs.git/commitdiff
(Killing Buffers): Update documentation of kill-buffer.
authorMartin Rudalics <rudalics@gmx.at>
Wed, 22 Oct 2008 16:08:11 +0000 (16:08 +0000)
committerMartin Rudalics <rudalics@gmx.at>
Wed, 22 Oct 2008 16:08:11 +0000 (16:08 +0000)
doc/lispref/ChangeLog
doc/lispref/buffers.texi

index ff74456009269360ecfda2794de9954918a8b028..04fbf8716a62c4896270aa7cb34a0c453cb8f865 100644 (file)
@@ -5,6 +5,9 @@
        (Choosing Window): Rewrite documentation of display-buffer and
        its options.
 
+       * buffers.texi (Killing Buffers): Update documentation of
+       kill-buffer.
+
 2008-10-21  Eli Zaretskii  <eliz@gnu.org>
 
        * processes.texi (Serial Ports): Fix wording and improve markup.
index 4d12185726c43428503c81995e52c51ff23532cf..b915e69ab6a010534ae23b89a005c622087bb0e5 100644 (file)
@@ -996,10 +996,11 @@ this feature to test whether a buffer has been killed:
 @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 @@ It does this even if not called interactively.  To prevent the request
 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