From: Juanma Barranquero <lekktu@gmail.com>
Date: Sun, 17 Dec 2006 11:54:10 +0000 (+0000)
Subject: (Fkill_buffer): Doc fix.
X-Git-Tag: emacs-pretest-22.0.92~71
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f6e22881e2e567fea51226a35d4e195fcad0381e;p=emacs.git

(Fkill_buffer): Doc fix.
(syms_of_buffer) <kill-buffer-query-functions>: Doc fix.
---

diff --git a/src/ChangeLog b/src/ChangeLog
index 4dfd454fa86..473ebe25af8 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2006-12-17  Juanma Barranquero  <lekktu@gmail.com>
+
+	* buffer.c (Fkill_buffer): Doc fix.
+	(syms_of_buffer) <kill-buffer-query-functions>: Doc fix.
+
 2006-12-16  Juanma Barranquero  <lekktu@gmail.com>
 
 	* minibuf.c (Ftry_completion): Check that obarray buckets are symbols.
diff --git a/src/buffer.c b/src/buffer.c
index 18bed7a865e..452f13a605a 100644
--- a/src/buffer.c
+++ b/src/buffer.c
@@ -1331,15 +1331,16 @@ See `kill-buffer'."
  */
 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
        doc: /* Kill the buffer BUFFER.
-The argument may be a buffer or may be the name of a buffer.
-An argument of nil means kill the current buffer.
+The argument may be a buffer or the name of a buffer.
+With a nil argument, kill the current buffer.
 
-Value is t if the buffer is actually killed, nil if user says no.
+Value is t if the buffer is actually killed, nil otherwise.
 
-The value of `kill-buffer-hook' (which may be local to that buffer),
-if not void, is a list of functions to be called, with no arguments,
-before the buffer is actually killed.  The buffer to be killed is current
-when the hook functions are called.
+The functions in `kill-buffer-query-functions' are called with BUFFER as
+the current buffer.  If any of them returns nil, the buffer is not killed.
+
+The hook `kill-buffer-hook' is run before the buffer is actually killed.
+The buffer being killed will be current while the hook is running.
 
 Any processes that have this buffer as the `process-buffer' are killed
 with SIGHUP.  */)
@@ -6015,7 +6016,7 @@ is a member of the list.  */);
   Vinhibit_read_only = Qnil;
 
   DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
-     doc: /* Cursor to use when this buffer is in the selected window.
+		     doc: /* Cursor to use when this buffer is in the selected window.
 Values are interpreted as follows:
 
   t 		  use the cursor specified for the frame
@@ -6040,11 +6041,13 @@ to the default frame line height.  A value of nil means add no extra space.  */)
 
   DEFVAR_PER_BUFFER ("cursor-in-non-selected-windows",
 		     &current_buffer->cursor_in_non_selected_windows, Qnil,
-    doc: /* *Cursor type to display in non-selected windows.
+		     doc: /* *Cursor type to display in non-selected windows.
 The value t means to use hollow box cursor.  See `cursor-type' for other values.  */);
 
   DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
-	       doc: /* List of functions called with no args to query before killing a buffer.  */);
+	       doc: /* List of functions called with no args to query before killing a buffer.
+The buffer being killed will be current while the functions are running.
+If any of them returns nil, the buffer is not killed.  */);
   Vkill_buffer_query_functions = Qnil;
 
   DEFVAR_LISP ("change-major-mode-hook", &Vchange_major_mode_hook,