diff options
| author | Richard M. Stallman | 2005-02-06 11:23:38 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-02-06 11:23:38 +0000 |
| commit | d5e2c90c44bc2ddbbd2b9848c44369d424598302 (patch) | |
| tree | 92bf2fc626d91983c94ac7aff50c499b312fe053 /src/eval.c | |
| parent | 75dcf8392527a49c119afa9394e280b8005723c0 (diff) | |
| download | emacs-d5e2c90c44bc2ddbbd2b9848c44369d424598302.tar.gz emacs-d5e2c90c44bc2ddbbd2b9848c44369d424598302.zip | |
(Frun_hook_with_args)
(Frun_hook_with_args_until_success)
(Frun_hook_with_args_until_failure): Doc fixes.
Diffstat (limited to 'src/eval.c')
| -rw-r--r-- | src/eval.c | 25 |
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 | |||
| 2323 | the given arguments and its return value is returned. If it is a list | 2323 | the given arguments and its return value is returned. If it is a list |
| 2324 | of functions, those functions are called, in order, | 2324 | of functions, those functions are called, in order, |
| 2325 | with the given arguments ARGS. | 2325 | with the given arguments ARGS. |
| 2326 | It is best not to depend on the value return by `run-hook-with-args', | 2326 | It is best not to depend on the value returned by `run-hook-with-args', |
| 2327 | as that may change. | 2327 | as that may change. |
| 2328 | 2328 | ||
| 2329 | Do not use `make-local-variable' to make a hook variable buffer-local. | 2329 | Do not use `make-local-variable' to make a hook variable buffer-local. |
| @@ -2339,11 +2339,14 @@ usage: (run-hook-with-args HOOK &rest ARGS) */) | |||
| 2339 | DEFUN ("run-hook-with-args-until-success", Frun_hook_with_args_until_success, | 2339 | DEFUN ("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. |
| 2342 | HOOK should be a symbol, a hook variable. Its value should | 2342 | HOOK should be a symbol, a hook variable. If HOOK has a non-nil |
| 2343 | be a list of functions. We call those functions, one by one, | 2343 | value, that value may be a function or a list of functions to be |
| 2344 | passing arguments ARGS to each of them, until one of them | 2344 | called to run the hook. If the value is a function, it is called with |
| 2345 | the given arguments and its return value is returned. | ||
| 2346 | If it is a list of functions, those functions are called, in order, | ||
| 2347 | with the given arguments ARGS, until one of them | ||
| 2345 | returns a non-nil value. Then we return that value. | 2348 | returns a non-nil value. Then we return that value. |
| 2346 | If all the functions return nil, we return nil. | 2349 | However, if they all return nil, we return nil. |
| 2347 | 2350 | ||
| 2348 | Do not use `make-local-variable' to make a hook variable buffer-local. | 2351 | Do not use `make-local-variable' to make a hook variable buffer-local. |
| 2349 | Instead, use `add-hook' and specify t for the LOCAL argument. | 2352 | Instead, use `add-hook' and specify t for the LOCAL argument. |
| @@ -2358,11 +2361,13 @@ usage: (run-hook-with-args-until-success HOOK &rest ARGS) */) | |||
| 2358 | DEFUN ("run-hook-with-args-until-failure", Frun_hook_with_args_until_failure, | 2361 | DEFUN ("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. |
| 2361 | HOOK should be a symbol, a hook variable. Its value should | 2364 | HOOK should be a symbol, a hook variable. If HOOK has a non-nil |
| 2362 | be a list of functions. We call those functions, one by one, | 2365 | value, that value may be a function or a list of functions to be |
| 2363 | passing arguments ARGS to each of them, until one of them | 2366 | called to run the hook. If the value is a function, it is called with |
| 2364 | returns nil. Then we return nil. | 2367 | the given arguments and its return value is returned. |
| 2365 | If all the functions return non-nil, we return non-nil. | 2368 | If it is a list of functions, those functions are called, in order, |
| 2369 | with the given arguments ARGS, until one of them returns nil. | ||
| 2370 | Then we return nil. However, if they all return non-nil, we return non-nil. | ||
| 2366 | 2371 | ||
| 2367 | Do not use `make-local-variable' to make a hook variable buffer-local. | 2372 | Do not use `make-local-variable' to make a hook variable buffer-local. |
| 2368 | Instead, use `add-hook' and specify t for the LOCAL argument. | 2373 | Instead, use `add-hook' and specify t for the LOCAL argument. |