From: Richard M. Stallman Date: Mon, 14 Feb 2005 10:16:24 +0000 (+0000) Subject: (Autoload): defun's doc string overrides autoload's doc string. X-Git-Tag: ttn-vms-21-2-B4~2306 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=9e328e231a6f97b580de43102bf1730e4c4b9cbf;p=emacs.git (Autoload): defun's doc string overrides autoload's doc string. (Repeated Loading): Modernize "add to list" examples. (Where Defined): Finish updating table of load-history elts. --- diff --git a/lispref/loading.texi b/lispref/loading.texi index 61c5b13ca6f..ecd08868495 100644 --- a/lispref/loading.texi +++ b/lispref/loading.texi @@ -365,10 +365,12 @@ one of these suffixes, and it will not load from a file whose name is just @var{filename} with no added suffix. The argument @var{docstring} is the documentation string for the -function. Normally, this should be identical to the documentation string -in the function definition itself. Specifying the documentation string -in the call to @code{autoload} makes it possible to look at the -documentation without loading the function's real definition. +function. Specifying the documentation string in the call to +@code{autoload} makes it possible to look at the documentation without +loading the function's real definition. Normally, this should be +identical to the documentation string in the function definition +itself. If it isn't, the function definition's documentation string +takes effect when it is loaded. If @var{interactive} is non-@code{nil}, that says @var{function} can be called interactively. This lets completion in @kbd{M-x} work without @@ -526,8 +528,7 @@ initialized. (@xref{Defining Variables}.) The simplest way to add an element to an alist is like this: @example -(setq minor-mode-alist - (cons '(leif-mode " Leif") minor-mode-alist)) +(push '(leif-mode " Leif") minor-mode-alist) @end example @noindent @@ -536,12 +537,15 @@ To avoid the problem, write this: @example (or (assq 'leif-mode minor-mode-alist) - (setq minor-mode-alist - (cons '(leif-mode " Leif") minor-mode-alist))) + (push '(leif-mode " Leif") minor-mode-alist)) @end example - To add an element to a list just once, you can also use @code{add-to-list} -(@pxref{Setting Variables}). +@noindent +or this: + +@example +(add-to-list '(leif-mode " Leif") minor-mode-alist) +@end example Occasionally you will want to test explicitly whether a library has already been loaded. Here's one way to test, in a library, whether it @@ -746,12 +750,12 @@ elements have these forms: @item @var{var} The symbol @var{var} was defined as a variable. @item (defun . @var{fun}) -The @var{fun} was defined by this library. +The function @var{fun} was defined. @item (t . @var{fun}) The function @var{fun} was previously an autoload before this library -redefined it as a function. The following element is always the -symbol @var{fun}, which signifies that the library defined @var{fun} -as a function. +redefined it as a function. The following element is always +@code{(defun . @var{fun}), which represents defining @var{fun} as a +function. @item (autoload . @var{fun}) The function @var{fun} was defined as an autoload. @item (require . @var{feature})