From 87a61eba1b8287d63b318d4af6ce47169ba574fd Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Thu, 13 Feb 2025 16:36:40 +0100 Subject: [PATCH] Move 'package-archives' documentation to emacs manual * doc/lispref/package.texi (Package Archives): Move documentation of package-archives variable from here... * doc/emacs/package.texi (Package Installation): ...to here. (Bug#76266) --- doc/emacs/package.texi | 19 ++++++++++++++++++- doc/lispref/package.texi | 19 ------------------- 2 files changed, 18 insertions(+), 20 deletions(-) diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi index 6e8f0a53868..42ac383e6a7 100644 --- a/doc/emacs/package.texi +++ b/doc/emacs/package.texi @@ -407,7 +407,6 @@ package is somehow unavailable, Emacs signals an error and stops installation.) A package's requirements list is shown in its help buffer. -@vindex package-archives By default, packages are downloaded from a single package archive maintained by the Emacs developers. This is controlled by the variable @code{package-archives}, whose value is a list of package @@ -418,6 +417,24 @@ name of the package archive directory. You can alter this list if you wish to use third party package archives---but do so at your own risk, and use only third parties that you think you can trust! +@defopt package-archives +The value of this variable is an alist of package archives recognized +by the Emacs package manager. + +Each alist element corresponds to one archive, and should have the +form @code{(@var{id} . @var{location})}, where @var{id} is the name of +the archive (a string) and @var{location} is its @dfn{base location} +(a string). + +If the base location starts with @samp{http:} or @samp{https:}, it +is treated as an HTTP(S) URL, and packages are downloaded from this +archive via HTTP(S) (as is the case for the default GNU archive). + +Otherwise, the base location should be a directory name. In this +case, Emacs retrieves packages from this archive via ordinary file +access. Such local archives are mainly useful for testing. +@end defopt + @anchor{Package Signing} @cindex package security @cindex package signing diff --git a/doc/lispref/package.texi b/doc/lispref/package.texi index 0d8dc6db0eb..a5102d33789 100644 --- a/doc/lispref/package.texi +++ b/doc/lispref/package.texi @@ -309,25 +309,6 @@ hosted on @url{https://elpa.gnu.org, GNU ELPA} and @url{https://elpa.nongnu.org, non-GNU ELPA}. This section describes how to set up and maintain a package archive. -@cindex base location, package archive -@defopt package-archives -The value of this variable is an alist of package archives recognized -by the Emacs package manager. - -Each alist element corresponds to one archive, and should have the -form @code{(@var{id} . @var{location})}, where @var{id} is the name of -the archive (a string) and @var{location} is its @dfn{base location} -(a string). - -If the base location starts with @samp{http:} or @samp{https:}, it -is treated as an HTTP(S) URL, and packages are downloaded from this -archive via HTTP(S) (as is the case for the default GNU archive). - -Otherwise, the base location should be a directory name. In this -case, Emacs retrieves packages from this archive via ordinary file -access. Such local archives are mainly useful for testing. -@end defopt - A package archive is simply a directory in which the package files, and associated files, are stored. If you want the archive to be reachable via HTTP, this directory must be accessible to a web server;