]> git.eshelyaron.com Git - emacs.git/commitdiff
Expand 'package-vc--unpack-1' documentation
authorPhilip Kaludercic <philipk@posteo.net>
Sun, 6 Nov 2022 12:16:50 +0000 (13:16 +0100)
committerPhilip Kaludercic <philipk@posteo.net>
Thu, 17 Nov 2022 19:37:28 +0000 (20:37 +0100)
* lisp/emacs-lisp/package-vc.el (package-vc--unpack-1): Explain what
the function does.

lisp/emacs-lisp/package-vc.el

index e1a84c466e3647af0cbb4768bc27fcd6eed386b3..5d9e7c91a5a94af81d2fec7af6cc1a51f3e3e577 100644 (file)
@@ -375,7 +375,11 @@ otherwise it's assumed to be an Info file."
                   file pkg-dir)))
 
 (defun package-vc--unpack-1 (pkg-desc pkg-dir)
-  "Install PKG-DESC that is already checked-out in PKG-DIR."
+  "Prepare PKG-DESC that is already checked-out in PKG-DIR.
+This includes downloading missing dependencies, generating
+autoloads, generating a package description file (used to
+identify a package as a source package later on), building
+documentation and marking the package as installed."
   ;; In case the package was installed directly from source, the
   ;; dependency list wasn't know beforehand, and they might have
   ;; to be installed explicitly.