* lisp/custom.el (defcustom): Doc fix.
authorChong Yidong <cyd@gnu.org>
Mon, 6 Feb 2012 12:36:31 +0000 (20:36 +0800)
committerChong Yidong <cyd@gnu.org>
Mon, 6 Feb 2012 12:36:31 +0000 (20:36 +0800)
Fixes: debbugs:9711

lisp/ChangeLog
lisp/custom.el

index 1fa62f4..f0f438e 100644 (file)
@@ -1,3 +1,7 @@
+2012-02-06  Chong Yidong  <cyd@gnu.org>
+
+       * custom.el (defcustom): Doc fix (Bug#9711).
+
 2012-02-05  Chong Yidong  <cyd@gnu.org>
 
        * cus-edit.el (custom-variable-reset-backup): Quote the value
index 9623369..a879c7f 100644 (file)
@@ -200,10 +200,14 @@ set to nil, as the value is no longer rogue."
 
 (defmacro defcustom (symbol value doc &rest args)
   "Declare SYMBOL as a customizable variable that defaults to VALUE.
+SYMBOL is the variable name; it should not be quoted.
+VALUE is an expression specifying the variable's standard value.
+This expression should not be quoted.  It is evaluated once by
+`defcustom', and the value is assigned to SYMBOL if the variable
+is unbound.  The expression may also be re-evaluated by Customize
+whenever it needs to get the variable's standard value.
 DOC is the variable documentation.
 
-Neither SYMBOL nor VALUE need to be quoted.
-If SYMBOL is not already bound, initialize it to VALUE.
 The remaining arguments should have the form
 
    [KEYWORD VALUE]...