]> git.eshelyaron.com Git - emacs.git/commitdiff
* custom.el (custom-initialize-delay): Doc fix.
authorGlenn Morris <rgm@gnu.org>
Fri, 26 Feb 2010 04:42:07 +0000 (20:42 -0800)
committerGlenn Morris <rgm@gnu.org>
Fri, 26 Feb 2010 04:42:07 +0000 (20:42 -0800)
lisp/ChangeLog
lisp/custom.el

index d91d95e5313818ad73aeca5f33095db18b1f1c9f..8314cf9113469d02848ad2f4faaac0c3038be340 100644 (file)
@@ -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.
 
index 347b2e1bebfefd9960dae9f0051af653ebf4880b..2484ee26f2136dfec5274d024d5fc34ea70769e0 100644 (file)
@@ -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