emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

core-packages: improve documentation

Browse source
This commit is contained in:
Henrik Lissner 2017-02-13 04:49:53 -05:00
parent 9bd270b375
commit 14967f084a
1 changed files with 21 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

37
core/core-packages.el
View file

@ -97,10 +97,9 @@ packages exist.")
(defun doom-initialize (&optional force-p) (defun doom-initialize (&optional force-p)
"Initialize installed packages (using package.el) and ensure the core packages "Initialize installed packages (using package.el) and ensure the core packages
are installed. If you byte compile core/core.el, this function will be avoided are installed. If you byte-compile core/core.el, this function will be avoided
to speed up startup." to speed up startup."
;; This is called early during Emacs initialization, so we can only use native ;; Called early during initialization; only use native functions!
;; emacs functions.
(unless (or doom-init-p force-p) (unless (or doom-init-p force-p)
(setq load-path doom--base-load-path (setq load-path doom--base-load-path
package-activated-list nil) package-activated-list nil)
@ -112,9 +111,12 @@ to speed up startup."
(list doom-cache-dir package-user-dir)) (list doom-cache-dir package-user-dir))
(package-initialize t) (package-initialize t)
;; Sure, `package-initialize' could fill `load-path', but package activation
;; Sure, `package-initialize' fills the load-path, but when NO-ACTIVATE is ;; costs precious milliseconds, and my premature optimization quota isn't
;; non-nil, it will error out on missing packages. UNACCEPTAABBLLLE! ;; filled yet. UNACCEPTAABBLLLE!
;;
;; Also, in some edge cases involving package initialization during a
;; non-interactive session, `package-initialize' fails to fill `load-path'.
(setq load-path (append load-path (directory-files package-user-dir t "^[a-zA-Z0-9]" t))) (setq load-path (append load-path (directory-files package-user-dir t "^[a-zA-Z0-9]" t)))
;; Ensure core packages are installed ;; Ensure core packages are installed
@ -297,24 +299,27 @@ it hasn't already, and if it exists."
;; ;;
(defmacro @package (name &rest plist) (defmacro @package (name &rest plist)
"Declares a package. This does not load nor install them explicitly. "Declares a package and how to install it (if applicable). This does not load
nor install them.
this macro serves a purely declarative purpose, and are run to build
`doom-packages', so that functions like `doom/packages-install' can operate on
them.
Accepts the following properties: Accepts the following properties:
:recipe RECIPE Takes a MELPA-style recipe (see `quelpa-recipe' for an :recipe RECIPE Takes a MELPA-style recipe (see `quelpa-recipe' in
example); for packages to be installed from external `quelpa' for an example); for packages to be installed
sources. from external sources.
:pin ARCHIVE-NAME Instructs ELPA to only look for this package in :pin ARCHIVE-NAME Instructs ELPA to only look for this package in
ARCHIVE-NAME. e.g. \"org\"." ARCHIVE-NAME. e.g. \"org\". Ignored if RECIPE is present.
This macro serves a purely declarative purpose, and are used to fill
`doom-packages', so that functions like `doom/packages-install' can operate on
them. "
(declare (indent defun)) (declare (indent defun))
(let ((pkg-recipe (plist-get plist :recipe)) (let ((pkg-recipe (plist-get plist :recipe))
(pkg-pin (plist-get plist :pin))) (pkg-pin (plist-get plist :pin)))
(when (= 0 (mod (length pkg-recipe) 2)) (when (= 0 (mod (length pkg-recipe) 2))
(plist-put plist :recipe (cons name pkg-recipe))) (plist-put plist :recipe (cons name pkg-recipe)))
(when (and pkg-recipe pkg-pin)
(plist-put plist :pkg-pin nil))
`(add-to-list 'doom-packages ',(cons name plist) t))) `(add-to-list 'doom-packages ',(cons name plist) t)))
(defmacro @depends-on (module submodule) (defmacro @depends-on (module submodule)
@ -337,7 +342,7 @@ SUBMODULE is a symbol."
(defun doom/reload-autoloads () (defun doom/reload-autoloads ()
"Refreshes the autoloads.el file, which tells Emacs where to find all the "Refreshes the autoloads.el file, which tells Emacs where to find all the
autoloaded functions in the modules you use or among the core libraries, e.g. autoloaded functions in enabled modules or among the core libraries, e.g.
core/autoload/*.el. core/autoload/*.el.
In modules, checks modules/*/autoload.el and modules/*/autoload/*.el. In modules, checks modules/*/autoload.el and modules/*/autoload/*.el.