From: Chong Yidong Date: Mon, 6 Feb 2012 12:36:31 +0000 (+0800) Subject: * lisp/custom.el (defcustom): Doc fix. X-Git-Tag: emacs-pretest-24.0.94~283 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=9a6dd7472a531b065e2f353b280755d49b50d813;p=emacs.git * lisp/custom.el (defcustom): Doc fix. Fixes: debbugs:9711 --- diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 1fa62f4b1b9..f0f438e540e 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,7 @@ +2012-02-06 Chong Yidong + + * custom.el (defcustom): Doc fix (Bug#9711). + 2012-02-05 Chong Yidong * cus-edit.el (custom-variable-reset-backup): Quote the value 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]...