summaryrefslogtreecommitdiff
path: root/lisp/custom.el
diff options
context:
space:
mode:
authorChong Yidong <cyd@gnu.org>2012-02-06 20:36:31 +0800
committerChong Yidong <cyd@gnu.org>2012-02-06 20:36:31 +0800
commit9a6dd7472a531b065e2f353b280755d49b50d813 (patch)
tree96df985c8628f36ef41124f2decc940b5bf3fa71 /lisp/custom.el
parentb737198d07688dea61ff1e6fbe3867714490dbf9 (diff)
downloademacs-9a6dd7472a531b065e2f353b280755d49b50d813.tar.gz
* lisp/custom.el (defcustom): Doc fix.
Fixes: debbugs:9711
Diffstat (limited to 'lisp/custom.el')
-rw-r--r--lisp/custom.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/custom.el b/lisp/custom.el
index 962336978b1..a879c7f76a0 100644
--- a/lisp/custom.el
+++ b/lisp/custom.el
@@ -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]...