run-hooks-with-args-* do fixes (bug#12393)
authorGlenn Morris <rgm@gnu.org>
Tue, 18 Sep 2012 01:07:13 +0000 (21:07 -0400)
committerGlenn Morris <rgm@gnu.org>
Tue, 18 Sep 2012 01:07:13 +0000 (21:07 -0400)
* src/eval.c (Frun_hook_with_args_until_success)
(Frun_hook_with_args_until_failure): Doc fixes.

src/ChangeLog
src/eval.c

index 0834ab9..2b23ff7 100644 (file)
@@ -1,3 +1,8 @@
+2012-09-18  Glenn Morris  <rgm@gnu.org>
+
+       * eval.c (Frun_hook_with_args_until_success)
+       (Frun_hook_with_args_until_failure): Doc fixes.  (Bug#12393)
+
 2012-09-14  Andreas Schwab  <schwab@linux-m68k.org>
 
        * fileio.c (Ffile_selinux_context): Only call freecon when
index a2df5bf..332c332 100644 (file)
@@ -2579,6 +2579,7 @@ If it is a list of functions, those functions are called, in order,
 with the given arguments ARGS, until one of them
 returns a non-nil value.  Then we return that value.
 However, if they all return nil, we return nil.
+If the value of HOOK is nil, this function returns nil.
 
 Do not use `make-local-variable' to make a hook variable buffer-local.
 Instead, use `add-hook' and specify t for the LOCAL argument.
@@ -2600,10 +2601,12 @@ DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
 HOOK should be a symbol, a hook variable.  If HOOK has a non-nil
 value, that value may be a function or a list of functions to be
 called to run the hook.  If the value is a function, it is called with
-the given arguments and its return value is returned.
+the given arguments.  Then we return nil if the function returns nil,
+and t if it returns non-nil.
 If it is a list of functions, those functions are called, in order,
 with the given arguments ARGS, until one of them returns nil.
-Then we return nil.  However, if they all return non-nil, we return non-nil.
+Then we return nil.  However, if they all return non-nil, we return t.
+If the value of HOOK is nil, this function returns t.
 
 Do not use `make-local-variable' to make a hook variable buffer-local.
 Instead, use `add-hook' and specify t for the LOCAL argument.