changeset 107234:78f7c3c01214

* custom.el (custom-initialize-delay): Doc fix.
author Glenn Morris <rgm@gnu.org>
date Thu, 25 Feb 2010 20:42:07 -0800
parents 548e079ffb49
children a3c102291ce1
files lisp/ChangeLog lisp/custom.el
diffstat 2 files changed, 13 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/ChangeLog	Thu Feb 25 20:40:03 2010 -0800
+++ b/lisp/ChangeLog	Thu Feb 25 20:42:07 2010 -0800
@@ -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.
 
--- a/lisp/custom.el	Thu Feb 25 20:40:03 2010 -0800
+++ b/lisp/custom.el	Thu Feb 25 20:42:07 2010 -0800
@@ -113,10 +113,17 @@
 
 (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