summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2010-02-25 20:42:07 -0800
committerGlenn Morris <rgm@gnu.org>2010-02-25 20:42:07 -0800
commit90a946031af5a128df5d6027a94b9183b50a69b0 (patch)
treeefb9d1f54f53bcd1ba846070b985f53f10743df3
parentcdbf910017670adc503318b8b9407ef85a7ad2ba (diff)
downloademacs-90a946031af5a128df5d6027a94b9183b50a69b0.tar.gz
* custom.el (custom-initialize-delay): Doc fix.
-rw-r--r--lisp/ChangeLog2
-rw-r--r--lisp/custom.el15
2 files changed, 13 insertions, 4 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index d91d95e5313..8314cf91134 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,7 @@
2010-02-26 Glenn Morris <rgm@gnu.org>
+ * custom.el (custom-initialize-delay): Doc fix.
+
* mail/sendmail.el (send-mail-function): Autoload the call
to custom-initialize-delay, not otherwise preserved in loaddefs.el.
diff --git a/lisp/custom.el b/lisp/custom.el
index 347b2e1bebf..2484ee26f21 100644
--- a/lisp/custom.el
+++ b/lisp/custom.el
@@ -113,10 +113,17 @@ For the standard setting, use `set-default'."
(defun custom-initialize-delay (symbol value)
"Delay initialization of SYMBOL to the next Emacs start.
-This is used in files that are preloaded, so that the initialization is
-done in the run-time context rather than the build-time context.
-This also has the side-effect that the (delayed) initialization is performed
-with the :setter."
+This is used in files that are preloaded (or for autoloaded
+variables), so that the initialization is done in the run-time
+context rather than the build-time context. This also has the
+side-effect that the (delayed) initialization is performed with
+the :set function.
+
+For variables in preloaded files, you can simply use this
+function for the :initialize property. For autoloaded variables,
+you will also need to add an autoload stanza calling this
+function, and another one setting the standard-value property.
+See `send-mail-function' in sendmail.el for an example."
;; Until the var is actually initialized, it is kept unbound.
;; This seemed to be at least as good as setting it to an arbitrary
;; value like nil (evaluating `value' is not an option because it