From: Philip Kaludercic <philipk@posteo.net>
Date: Sun, 6 Nov 2022 12:16:50 +0000 (+0100)
Subject: Expand 'package-vc--unpack-1' documentation
X-Git-Tag: emacs-29.0.90~1616^2~89
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=b0200a37e4d6da32f72ce3832ed44a57934c599c;p=emacs.git

Expand 'package-vc--unpack-1' documentation

* lisp/emacs-lisp/package-vc.el (package-vc--unpack-1): Explain what
the function does.
---

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.