[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
scratch/package-vc-fixes 6a46e7d3ee 17/48: Move package spec documentati
From: |
Philip Kaludercic |
Subject: |
scratch/package-vc-fixes 6a46e7d3ee 17/48: Move package spec documentation to 'package-vc-selected-packages' |
Date: |
Wed, 16 Nov 2022 04:50:00 -0500 (EST) |
branch: scratch/package-vc-fixes
commit 6a46e7d3ee8cb14c682e0813edc962a21c6a5e08
Author: Philip Kaludercic <philipk@posteo.net>
Commit: Philip Kaludercic <philipk@posteo.net>
Move package spec documentation to 'package-vc-selected-packages'
* lisp/emacs-lisp/package-vc.el (package-vc-selected-packages): Add
documentation.
(package-vc--archive-spec-alist): Remove documentation.
---
lisp/emacs-lisp/package-vc.el | 56 +++++++++++++++++++++----------------------
1 file changed, 27 insertions(+), 29 deletions(-)
diff --git a/lisp/emacs-lisp/package-vc.el b/lisp/emacs-lisp/package-vc.el
index aa67c99cbd..7d89f437f1 100644
--- a/lisp/emacs-lisp/package-vc.el
+++ b/lisp/emacs-lisp/package-vc.el
@@ -140,9 +140,31 @@ is a symbol designating the package and SPEC is one of:
- nil, if any package version can be installed;
- a version string, if that specific revision is to be installed;
-- a property list of the form described in
- `package-vc-archive-spec-alist', giving a package
- specification.
+- a property list. Valid key/value pairs are
+
+ `:url' (string)
+ The URL of the repository used to fetch the package source.
+
+ `:branch' (string)
+ If given, the name of the branch to checkout after cloning the directory.
+
+ `:lisp-dir' (string)
+ The repository-relative name of the directory to use for loading the Lisp
+ sources. If not given, the value defaults to the root directory
+ of the repository.
+
+ `:main-file' (string)
+ The main file of the project, relevant to gather package metadata.
+ If not given, the assumed default is the package name with \".el\"
+ appended to it.
+
+ `:vc-backend' (symbol)
+ A symbol of the VC backend to use for cloning the package. The
+ value ought to be a member of `vc-handled-backends'. If omitted,
+ `vc-clone' will fall back onto the archive default or on
+ `package-vc-default-backend'.
+
+ All other values are ignored.
This user option differs from `package-selected-packages' in that
it is meant to be specified manually. If you want to install all
@@ -165,32 +187,8 @@ the packages in the list, you cal also use
(defvar package-vc--archive-spec-alist nil
"List of package specifications for each archive.
-The list maps each package name, as a string, to a plist.
-Valid keys and the corresponding value types are:
-
- `:url' (string)
- The URL of the repository used to fetch the package source.
-
- `:branch' (string)
- If given, the name of the branch to checkout after cloning the directory.
-
- `:lisp-dir' (string)
- The repository-relative name of the directory to use for loading the Lisp
- sources. If not given, the value defaults to the root directory
- of the repository.
-
- `:main-file' (string)
- The main file of the project, relevant to gather package metadata.
- If not given, the assumed default is the package name with \".el\"
- appended to it.
-
- `:vc-backend' (symbol)
- A symbol of the VC backend to use for cloning the package. The
- value ought to be a member of `vc-handled-backends'. If omitted,
- `vc-clone' will fall back onto the archive default or on
- `package-vc-default-backend'.
-
-All other values are ignored.")
+The list maps each package name, as a string, to a plist as
+specified in `package-vc-selected-packages'.")
(defvar package-vc--archive-data-alist nil
"List of package specification metadata for archives.
- branch scratch/package-vc-fixes created (now 18ee1e728a), Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes 5132a2b0d0 02/48: Handle strings as keys in 'package-vc-ensure-packages', Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes 2364faef93 32/48: Have 'vc-prepare-patch' handle prefix arguments., Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes aca27e0905 10/48: Expand 'package-vc--unpack-1' documentation, Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes 685b4b274b 08/48: Fix the docstring for 'package-vc--version', Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes c29189587b 07/48: Fix 'package-vc-selected-packages' documentation, Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes 6a46e7d3ee 17/48: Move package spec documentation to 'package-vc-selected-packages',
Philip Kaludercic <=
- scratch/package-vc-fixes 58b2a64225 23/48: Fix edebug spec for 'package--with-response-buffer', Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes b45d2fb4b2 29/48: * lisp/emacs-lisp/package-vc.el (package-vc-update-all): Add command, Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes a10cd1b927 36/48: Fix accidental generation of circular lists, Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes bc9c7aee30 34/48: Improve robustness of 'package-vc-update', Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes a89f7bc1dc 27/48: Raise 'wrong-type-argument' when installing package nil, Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes 4730409de9 38/48: Fix the behaviour or 'byte-compile-ignore-files', Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes 663cb70e15 40/48: Remove temporary .texi files if used to build documentation, Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes 6b35279259 45/48: Fix issues related to 'package-vc-install-from-checkout', Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes c383864f96 46/48: Have 'package-delete' handle symlinked packages correctly, Philip Kaludercic, 2022/11/16
- scratch/package-vc-fixes 7815894592 11/48: Remove references to internal symbols from public docstrings, Philip Kaludercic, 2022/11/16