[Emacs-diffs] /srv/bzr/emacs/trunk r99561: * custom.el (custom-initialize-delay): Doc fix.

[Glenn Morris]

------------------------------------------------------------
revno: 99561
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Thu 2010-02-25 20:42:07 -0800
message:
  * custom.el (custom-initialize-delay): Doc fix.
modified:
  lisp/ChangeLog
  lisp/custom.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2010-02-26 04:40:03 +0000
+++ b/lisp/ChangeLog    2010-02-26 04:42:07 +0000
@@ -1,5 +1,7 @@
 2010-02-26  Glenn Morris  <address@hidden>
 
+       * 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.
 

=== modified file 'lisp/custom.el'
--- a/lisp/custom.el    2010-01-13 08:35:10 +0000
+++ b/lisp/custom.el    2010-02-26 04:42:07 +0000
@@ -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