[Emacs-diffs] /srv/bzr/emacs/trunk r106927: Tweak custom-variable-p and user-variable-p docs.

[Chong Yidong]

------------------------------------------------------------
revno: 106927
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Wed 2012-01-25 13:48:11 +0800
message:
  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.
modified:
  admin/FOR-RELEASE
  lisp/ChangeLog
  lisp/custom.el
  src/ChangeLog
  src/eval.c

=== modified file 'admin/FOR-RELEASE'
--- a/admin/FOR-RELEASE 2012-01-23 04:23:50 +0000
+++ b/admin/FOR-RELEASE 2012-01-25 05:48:11 +0000
@@ -126,7 +126,7 @@
 
 abbrevs.texi      cyd
 ack.texi          
-anti.texi
+anti.texi         cyd
 arevert-xtra.texi cyd
 basic.texi        cyd
 buffers.texi      cyd

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-01-25 02:01:22 +0000
+++ b/lisp/ChangeLog    2012-01-25 05:48:11 +0000
@@ -1,3 +1,7 @@
+2012-01-25  Chong Yidong  <address@hidden>
+
+       * custom.el (custom-variable-p): Doc fix.
+
 2012-01-25  Glenn Morris  <address@hidden>
 
        * progmodes/compile.el (compilation-next-error-function):

=== modified file 'lisp/custom.el'
--- a/lisp/custom.el    2012-01-19 07:21:25 +0000
+++ b/lisp/custom.el    2012-01-25 05:48:11 +0000
@@ -591,8 +591,10 @@
 
 ;; 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)))

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2012-01-21 15:52:46 +0000
+++ b/src/ChangeLog     2012-01-25 05:48:11 +0000
@@ -1,3 +1,7 @@
+2012-01-25  Chong Yidong  <address@hidden>
+
+       * eval.c (Fuser_variable_p): Doc fix; mention custom-variable-p.
+
 2012-01-21  Chong Yidong  <address@hidden>
 
        * floatfns.c (Fcopysign): Make the second argument non-optional,

=== modified file 'src/eval.c'
--- a/src/eval.c        2012-01-19 07:21:25 +0000
+++ b/src/eval.c        2012-01-25 05:48:11 +0000
@@ -926,13 +926,14 @@
 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;