summaryrefslogtreecommitdiff
path: root/lisp/use-package/use-package.el
diff options
context:
space:
mode:
authorRadon Rosborough <radon.neon@gmail.com>2017-03-08 18:19:15 -0800
committerRadon Rosborough <radon.neon@gmail.com>2017-03-08 18:19:15 -0800
commit89a8f94672ec715f19979bf6e83a2e23814d5476 (patch)
treeed3b9f9951d7fdcf3ed9847b8009412af30e5122 /lisp/use-package/use-package.el
parentf6224b295622d5a7065a107b1323486fa9822387 (diff)
parenta233f01ff64a3cb4002c3913883035bb1b299208 (diff)
downloademacs-89a8f94672ec715f19979bf6e83a2e23814d5476.tar.gz
emacs-89a8f94672ec715f19979bf6e83a2e23814d5476.tar.bz2
emacs-89a8f94672ec715f19979bf6e83a2e23814d5476.zip
Merge branch 'generalized-ensure' into defer-install
Diffstat (limited to 'lisp/use-package/use-package.el')
-rw-r--r--lisp/use-package/use-package.el8
1 files changed, 6 insertions, 2 deletions
diff --git a/lisp/use-package/use-package.el b/lisp/use-package/use-package.el
index 3d5c99919d6..6695c19af64 100644
--- a/lisp/use-package/use-package.el
+++ b/lisp/use-package/use-package.el
@@ -185,8 +185,12 @@ Must be set before loading use-package."
(defcustom use-package-ensure-function 'use-package-ensure-elpa
"Function that ensures a package is installed.
-This function is called with one argument, the package name as a
-symbol, by the `:ensure' keyword.
+This function is called with three arguments: the name of the
+package declared in the `use-package' form; the argument passed
+to `:ensure'; and the current `state' plist created by previous
+handlers. Note that this function is called whenever `:ensure' is
+provided, even if it is nil. It is up to the function to decide
+on the semantics of the various values for `:ensure'.
The default value uses package.el to install the package."
:type '(choice (const :tag "package.el" use-package-ensure-elpa)