aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2005-02-06 11:23:38 +0000
committerRichard M. Stallman2005-02-06 11:23:38 +0000
commitd5e2c90c44bc2ddbbd2b9848c44369d424598302 (patch)
tree92bf2fc626d91983c94ac7aff50c499b312fe053
parent75dcf8392527a49c119afa9394e280b8005723c0 (diff)
downloademacs-d5e2c90c44bc2ddbbd2b9848c44369d424598302.tar.gz
emacs-d5e2c90c44bc2ddbbd2b9848c44369d424598302.zip
(Frun_hook_with_args)
(Frun_hook_with_args_until_success) (Frun_hook_with_args_until_failure): Doc fixes.
-rw-r--r--src/eval.c25
1 files changed, 15 insertions, 10 deletions
diff --git a/src/eval.c b/src/eval.c
index 9c27caa29ca..83e16360473 100644
--- a/src/eval.c
+++ b/src/eval.c
@@ -2323,7 +2323,7 @@ called to run the hook. If the value is a function, it is called with
2323the given arguments and its return value is returned. If it is a list 2323the given arguments and its return value is returned. If it is a list
2324of functions, those functions are called, in order, 2324of functions, those functions are called, in order,
2325with the given arguments ARGS. 2325with the given arguments ARGS.
2326It is best not to depend on the value return by `run-hook-with-args', 2326It is best not to depend on the value returned by `run-hook-with-args',
2327as that may change. 2327as that may change.
2328 2328
2329Do not use `make-local-variable' to make a hook variable buffer-local. 2329Do not use `make-local-variable' to make a hook variable buffer-local.
@@ -2339,11 +2339,14 @@ usage: (run-hook-with-args HOOK &rest ARGS) */)
2339DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success, 2339DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success,
2340 Srun_hook_with_args_until_success, 1, MANY, 0, 2340 Srun_hook_with_args_until_success, 1, MANY, 0,
2341 doc: /* Run HOOK with the specified arguments ARGS. 2341 doc: /* Run HOOK with the specified arguments ARGS.
2342HOOK should be a symbol, a hook variable. Its value should 2342HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2343be a list of functions. We call those functions, one by one, 2343value, that value may be a function or a list of functions to be
2344passing arguments ARGS to each of them, until one of them 2344called to run the hook. If the value is a function, it is called with
2345the given arguments and its return value is returned.
2346If it is a list of functions, those functions are called, in order,
2347with the given arguments ARGS, until one of them
2345returns a non-nil value. Then we return that value. 2348returns a non-nil value. Then we return that value.
2346If all the functions return nil, we return nil. 2349However, if they all return nil, we return nil.
2347 2350
2348Do not use `make-local-variable' to make a hook variable buffer-local. 2351Do not use `make-local-variable' to make a hook variable buffer-local.
2349Instead, use `add-hook' and specify t for the LOCAL argument. 2352Instead, use `add-hook' and specify t for the LOCAL argument.
@@ -2358,11 +2361,13 @@ usage: (run-hook-with-args-until-success HOOK &rest ARGS) */)
2358DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure, 2361DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure,
2359 Srun_hook_with_args_until_failure, 1, MANY, 0, 2362 Srun_hook_with_args_until_failure, 1, MANY, 0,
2360 doc: /* Run HOOK with the specified arguments ARGS. 2363 doc: /* Run HOOK with the specified arguments ARGS.
2361HOOK should be a symbol, a hook variable. Its value should 2364HOOK should be a symbol, a hook variable. If HOOK has a non-nil
2362be a list of functions. We call those functions, one by one, 2365value, that value may be a function or a list of functions to be
2363passing arguments ARGS to each of them, until one of them 2366called to run the hook. If the value is a function, it is called with
2364returns nil. Then we return nil. 2367the given arguments and its return value is returned.
2365If all the functions return non-nil, we return non-nil. 2368If it is a list of functions, those functions are called, in order,
2369with the given arguments ARGS, until one of them returns nil.
2370Then we return nil. However, if they all return non-nil, we return non-nil.
2366 2371
2367Do not use `make-local-variable' to make a hook variable buffer-local. 2372Do not use `make-local-variable' to make a hook variable buffer-local.
2368Instead, use `add-hook' and specify t for the LOCAL argument. 2373Instead, use `add-hook' and specify t for the LOCAL argument.