# HG changeset patch
# User Richard M. Stallman <rms@gnu.org>
# Date 1129994156 0
# Node ID 3fcb7f692502190f0238bc7c958d64a77a948c07
# Parent  f754be327a7e1d094d723fda14f6165972be189c
(Building Emacs): Document eval-at-startup.

diff -r f754be327a7e -r 3fcb7f692502 lispref/internals.texi
--- a/lispref/internals.texi	Sat Oct 22 15:01:08 2005 +0000
+++ b/lispref/internals.texi	Sat Oct 22 15:15:56 2005 +0000
@@ -117,6 +117,18 @@
 normal features for your site, do it with @file{default.el}, so that
 users can override your changes if they wish.  @xref{Startup Summary}.
 
+  In a package that can be preloaded, it is sometimes useful to
+specify a computation to be done when Emacs subsequently starts up.
+For this, use @code{eval-at-startup}:
+
+@defmacro eval-at-startup body@dots{}
+This evaluates the @var{body} forms, either immediately if running in
+an Emacs that has already started up, or later when Emacs does start
+up.  Since the value of the @var{body} forms is not necessarily
+available when the @code{eval-at-startup} form is run, that form
+always returns @code{nil}.
+@end defmacro
+
 @defun dump-emacs to-file from-file
 @cindex unexec
 This function dumps the current state of Emacs into an executable file