]> git.eshelyaron.com Git - emacs.git/commitdiff
Update docstring for use-package-ensure-function
authorRadon Rosborough <radon.neon@gmail.com>
Thu, 9 Mar 2017 02:16:31 +0000 (18:16 -0800)
committerRadon Rosborough <radon.neon@gmail.com>
Thu, 9 Mar 2017 02:17:49 +0000 (18:17 -0800)
Now it properly reflects the API changes recently made.

lisp/use-package/use-package.el

index 2ef697201f8eb056d3181e80e3d8b82d120fdc74..13ba63446c1b16122592ad7a37a68189785c4e24 100644 (file)
@@ -184,8 +184,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)