diff options
author | Chong Yidong <cyd@gnu.org> | 2012-03-17 19:11:08 +0800 |
---|---|---|
committer | Chong Yidong <cyd@gnu.org> | 2012-03-17 19:11:08 +0800 |
commit | 986bd52a31d3ef5a9cc35ecfb8463d758d1e5e6c (patch) | |
tree | 6ec0f817f4d5ef35f771c5b03bd5e11d5ce4a942 /doc/lispref/package.texi | |
parent | f761251a434c75e6eec2e70ac6839cf07ec32414 (diff) | |
download | emacs-986bd52a31d3ef5a9cc35ecfb8463d758d1e5e6c.tar.gz |
Misc manual updates.
* doc/emacs/package.texi (Package Installation): Document use of
package-initialize in init file.
* doc/lispref/os.texi (Startup Summary): Mention package loading.
(Init File): Don't refer to .emacs in section title. Copyedits.
(Terminal-Specific): Give a realistic example.
(Command-Line Arguments): Reference Entering Emacs instead of
repeating the spiel about not restarting Emacs.
(Time of Day): Discuss time representation at beginning of node.
(Sound Output): Copyedits.
* doc/lispref/package.texi (Packaging Basics): Document package-initialize.
Diffstat (limited to 'doc/lispref/package.texi')
-rw-r--r-- | doc/lispref/package.texi | 41 |
1 files changed, 30 insertions, 11 deletions
diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi index eb3612dc868..b17f13b6b89 100644 --- a/doc/lispref/package.texi +++ b/doc/lispref/package.texi @@ -15,6 +15,8 @@ install, uninstall, and upgrade it. The following sections describe how to create a package, and how to put it in a @dfn{package archive} for others to download. +@xref{Packages,,, emacs, The GNU Emacs Manual}, for a description of +user-level features of the packaging system. @menu * Packaging Basics:: The basic concepts of Emacs Lisp packages. @@ -91,17 +93,34 @@ definitions are saved to a file named @file{@var{name}-autoloads.el} in the content directory. They are typically used to autoload the principal user commands defined in the package, but they can also perform other tasks, such as adding an element to -@code{auto-mode-alist} (@pxref{Auto Major Mode}). During this time, -Emacs will also byte-compile the Lisp files. - - After installation, and (by default) each time Emacs is started, the -installed package is @dfn{activated}. During activation, Emacs adds -the package's content directory to @code{load-path}, and evaluates the -autoload definitions in @file{@var{name}-autoloads.el}. - - Note that a package typically does @emph{not} autoload every -function and variable defined within it---only the handful of commands -typically called to begin using the package. +@code{auto-mode-alist} (@pxref{Auto Major Mode}). Note that a package +typically does @emph{not} autoload every function and variable defined +within it---only the handful of commands typically called to begin +using the package. Emacs then byte-compiles every Lisp file in the +package. + + After installation, the installed package is @dfn{loaded}: Emacs +adds the package's content directory to @code{load-path}, and +evaluates the autoload definitions in @file{@var{name}-autoloads.el}. + + Whenever Emacs starts up, it automatically calls the function +@code{package-initialize} to load installed packages. This is done +after loading the init file and abbrev file (if any) and before +running @code{after-init-hook} (@pxref{Startup Summary}). Automatic +package loading is disabled if the user option +@code{package-enable-at-startup} is @code{nil}. + +@deffn Command package-initialize &optional no-activate +This function initializes Emacs' internal record of which packages are +installed, and loads them. The user option @code{package-load-list} +specifies which packages to load; by default, all installed packages +are loaded. @xref{Package Installation,,, emacs, The GNU Emacs +Manual}. + +The optional argument @var{no-activate}, if non-@code{nil}, causes +Emacs to update its record of installed packages without actually +loading them; it is for internal use only. +@end deffn @node Simple Packages @section Simple Packages |