; Expand 'package-vc-install' documentation

* lisp/emacs-lisp/package-vc.el (package-vc-install): Go into further
detail on the handling of the REV argument.  (Bug#60418)
This commit is contained in:
Philip Kaludercic 2023-05-06 20:51:39 +02:00
parent 7133784303
commit dfde902f3b

View file

@ -747,11 +747,13 @@ indicating the package name and SPEC is a plist as described in
symbol whose name is the package name, and the URL for the symbol whose name is the package name, and the URL for the
package will be taken from the package's metadata. package will be taken from the package's metadata.
By default, this function installs the last version of the package By default, this function installs the last revision of the
available from its repository, but if REV is given and non-nil, it package available from its repository. If REV is a string, it
specifies the revision to install. If REV has the special value describes the revision to install, as interpreted by the VC
`:last-release' (interactively, the prefix argument), that stands backend. The special value `:last-release' (interactively, the
for the last released version of the package. prefix argument), will use the commit of the latest release, if
it exists. The last release is the latest revision which changed
the \"Version:\" header of the package's main Lisp file.
Optional argument BACKEND specifies the VC backend to use for cloning Optional argument BACKEND specifies the VC backend to use for cloning
the package's repository; this is only possible if NAME-OR-URL is a URL, the package's repository; this is only possible if NAME-OR-URL is a URL,