Commit 0b21c100 authored by Chong Yidong's avatar Chong Yidong

Tweak custom-variable-p and user-variable-p docs.

* lisp/custom.el (custom-variable-p): Doc fix.

* src/eval.c (Fuser_variable_p): Doc fix; mention custom-variable-p.
parent 5ddce96c
......@@ -126,7 +126,7 @@ TUTORIAL.zh
abbrevs.texi cyd
ack.texi
anti.texi
anti.texi cyd
arevert-xtra.texi cyd
basic.texi cyd
buffers.texi cyd
......
2012-01-25 Chong Yidong <cyd@gnu.org>
* custom.el (custom-variable-p): Doc fix.
2012-01-25 Glenn Morris <rgm@gnu.org>
* progmodes/compile.el (compilation-next-error-function):
......
......@@ -591,8 +591,10 @@ If NOSET is non-nil, don't bother autoloading LOAD when setting the variable."
;; This test is also in the C code of `user-variable-p'.
(defun custom-variable-p (variable)
"Return non-nil if VARIABLE is a custom variable.
This recursively follows aliases."
"Return non-nil if VARIABLE is a customizable variable.
A customizable variable is either (i) a variable whose property
list contains a non-nil `standard-value' or `custom-autoload'
property, or (ii) an alias for another customizable variable."
(setq variable (indirect-variable variable))
(or (get variable 'standard-value)
(get variable 'custom-autoload)))
......
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,
......
......@@ -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;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment