summaryrefslogtreecommitdiff
path: root/lisp
diff options
context:
space:
mode:
authorPhilip Kaludercic <philipk@posteo.net>2022-11-06 13:16:50 +0100
committerPhilip Kaludercic <philipk@posteo.net>2022-11-17 20:37:28 +0100
commitb0200a37e4d6da32f72ce3832ed44a57934c599c (patch)
tree2e4ab17e0ec7ee0138f6631fc7683e6a8979b543 /lisp
parentf939859fe4eab6774f41030b27f5329afd4e98b1 (diff)
downloademacs-b0200a37e4d6da32f72ce3832ed44a57934c599c.tar.gz
emacs-b0200a37e4d6da32f72ce3832ed44a57934c599c.tar.bz2
emacs-b0200a37e4d6da32f72ce3832ed44a57934c599c.zip
Expand 'package-vc--unpack-1' documentation
* lisp/emacs-lisp/package-vc.el (package-vc--unpack-1): Explain what the function does.
Diffstat (limited to 'lisp')
-rw-r--r--lisp/emacs-lisp/package-vc.el6
1 files changed, 5 insertions, 1 deletions
diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el
index e1a84c466e3..5d9e7c91a5a 100644
--- a/lisp/emacs-lisp/package-vc.el
+++ b/lisp/emacs-lisp/package-vc.el
@@ -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.