diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/ChangeLog | 4 | ||||
| -rw-r--r-- | src/eval.c | 15 |
2 files changed, 12 insertions, 7 deletions
diff --git a/src/ChangeLog b/src/ChangeLog index c8b1e654830..f9236f159cd 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,7 @@ +2012-01-25 Chong Yidong <cyd@gnu.org> + + * eval.c (Fuser_variable_p): Doc fix; mention custom-variable-p. + 2012-01-21 Chong Yidong <cyd@gnu.org> * floatfns.c (Fcopysign): Make the second argument non-optional, diff --git a/src/eval.c b/src/eval.c index 7b1c516d756..dbd06e7c1b1 100644 --- a/src/eval.c +++ b/src/eval.c @@ -926,13 +926,14 @@ lisp_indirect_variable (Lisp_Object sym) DEFUN ("user-variable-p", Fuser_variable_p, Suser_variable_p, 1, 1, 0, doc: /* Return t if VARIABLE is intended to be set and modified by users. \(The alternative is a variable used internally in a Lisp program.) -A variable is a user variable if -\(1) the first character of its documentation is `*', or -\(2) it is customizable (its property list contains a non-nil value - of `standard-value' or `custom-autoload'), or -\(3) it is an alias for another user variable. -Return nil if VARIABLE is an alias and there is a loop in the -chain of symbols. */) + +This function returns t if (i) the first character of its +documentation is `*', or (ii) it is customizable (its property list +contains a non-nil value of `standard-value' or `custom-autoload'), or +\(iii) it is an alias for a user variable. + +But condition (i) is considered obsolete, so for most purposes this is +equivalent to `custom-variable-p'. */) (Lisp_Object variable) { Lisp_Object documentation; |