[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa-admin 35ba6e2 055/439: Update README to describe the new r
From: |
Philip Kaludercic |
Subject: |
[nongnu] elpa-admin 35ba6e2 055/439: Update README to describe the new repository layout. |
Date: |
Sun, 17 Oct 2021 15:47:33 -0400 (EDT) |
branch: elpa-admin
commit 35ba6e22141c65590bc7b69ef163350d06f09f12
Author: Chong Yidong <cyd@stupidchicken.com>
Commit: Chong Yidong <cyd@stupidchicken.com>
Update README to describe the new repository layout.
---
README | 69 +++++++++++++++++++++++++++++-------------------------------------
1 file changed, 30 insertions(+), 39 deletions(-)
diff --git a/README b/README
index c8a4fd4..097e430 100644
--- a/README
+++ b/README
@@ -12,8 +12,7 @@ for testing purposes).
* DIRECTORY LAYOUT
-** admin/ -- scripts for deploying the package archive.
- See the DEPLOYMENT section for details.
+** admin/ -- scripts for administering the package archive.
** html/ -- HTML for the elpa.gnu.org website.
** packages/ -- source code for the packages.
@@ -21,60 +20,52 @@ for testing purposes).
* PACKAGES
** Contents of the packages/ directory:
-
-This directory holds the package sources. Unlike the deployed package
-archive, multi-file packages are present here as directories, not tar
-files. So, edits to the sources can be easily managed by Bzr.
-
-*** Package sources
-In the form of *.el files for simple (1-file) packages, or
-subdirectories for multi-file packages.
+This directory holds the package sources, with one subdirectory for
+each package.
** To add a package:
-*** Add a simple (1-file) package as packages/NAME-VERSION.el.
+*** Add a simple (1-file) package as packages/NAME/NAME.el.
-*** Add a multi-file package a directory, packages/NAME-VERSION.
+*** Add a multi-file package as a directory, packages/NAME.
-*** Commit your changes
-This is done the usual way ("bzr add", "bzr commit", etc).
+*** Commit your changes the usual way ("bzr add", "bzr commit", etc).
Changes in the Bzr repository do not immediately propagate to the
user-facing archive (what users see when they do `M-x list-packages').
-That is done by deploying the archive (see below).
+That is done by deploying the archive.
* DEPLOYMENT
-** The package-update.sh script
+** To use the package repository as a "site installation" of packages:
-Use the script admin/package-update.sh to deploy a partial or full
-copy of the package archive. To run a partial deployment:
+ make site
- /PATH/TO/admin/package-update.sh DEST
+This compiles and generates autoloads for all the packages in the
+packages/ directory, and creates a site/ directory containing symlinks
+to the package directories.
-This deploys the packages in packages/ to DEST/packages.
+Now you have to add this site/ directory to `package-directory-list',
+and all the packages will be available.
-To run a full deployment:
+** To deploy the package repository as a remotely-accessible archive:
- /PATH/TO/admin/package-update.sh DEST 1
+ make archive
-A full deployment additionally copies the admin scripts to DEST/admin,
-creates a full tarball in DEST/packages/emacs-packages-latest.tgz, and
-fetches externally hosted packages (currently, the Org daily builds)
-and adds them to the archive.
+or
-The package-update.sh script only works if it lives in a bzr
-repository. It uses `bzr export' to deploy from the repository to the
-destination directory. If you have uncommitted changes in the working
-copy, those changes are not deployed.
+ make archive-full
-You can view the deployment log at DEST/update-log.
+This deploys the packages to the archive/ directory. Unlike "make
+site", this makes a full copy of the packages, and tars up multi-file
+packages.
-The other scripts in the admin/ subdirectory are used for fetching the
-Org dailies.
+A full deployment also copies the admin scripts to archive/admin, and
+fetches externally hosted packages (currently, the Org daily builds)
+and adds them to the archive.
-** Accessing a deployed archive
+** To access a deployed archive
To access the archive via HTPP, have a symlink (say) /var/www/packages
pointing to DEST/packages, and set up Emacs with
@@ -94,13 +85,13 @@ logging in (login access set up by FSF admins), and
su elpa
cd ~elpa/elpa
bzr up
-./admin/package-update /home/elpa/staging/ 1
-The symlink /var/www/packages points to /home/elpa/staging/packages.
+Then make a full archive deployment, as discussed above. The symlink
+/var/www/packages points to the staging package directory under
+/home/elpa/.
-The Org mode dailies are fetched and added by the script
-admin/org-synch.sh, which is run as a cron job (we also run this
-script during deployment).
+The Org mode dailies are also fetched and added by the script
+admin/org-synch.sh, run as a cron job.
This file is part of GNU Emacs.
- [nongnu] elpa-admin bd19e1f 015/439: Start to use load-relative. dbgr-core.el: fix bug in dbgr-term-sentinal, (continued)
- [nongnu] elpa-admin bd19e1f 015/439: Start to use load-relative. dbgr-core.el: fix bug in dbgr-term-sentinal, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin ab46aeb 014/439: Relative loads for Emacs Lisp files. Adds functions __FILE__ and, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 5bb5972 016/439: load-relative.el: Add provide-me and make GPL v3., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin d656221 020/439: Track original positions in the face of possible edits. Intended use in debugging where one might edit the file but continue editing., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 487ee79 022/439: Update README to note dependencies and what debugger's we've got., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin a53e009 023/439: Merge branch 'master' of github.com:rocky/emacs-dbgr, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 8b07a20 027/439: * README: Explain how to run the repo build script., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 370423c 026/439: * COPYING, ChangeLog, README, admin/org-synch.el,, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin a703bf2 025/439: Merge branch 'master' of github.com:rocky/emacs-load-relative, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 14ac0ef 040/439: Merge branch 'action', Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 35ba6e2 055/439: Update README to describe the new repository layout.,
Philip Kaludercic <=
- [nongnu] elpa-admin 4866cb7 057/439: admin/archive-contents.el (archive--delete-elc-files): Delete backup files too., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 3ca74c1 011/439: preparing for new rst format document, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 7b9d56b 038/439: README: Move copyright and license text to the end, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 1329950 024/439: Administrivia. Add COPYING, update README and .gitignore, bump version number., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin f545af1 036/439: Rephrase some parts of README, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 1761424 031/439: Use archive-contents.el script., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 5bbab91 030/439: * packages/all-1.0.el: Change version. Address byte-compiler warnings., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 06a86aa 043/439: Add an explicit OPERATION-MODE "nil" in README's examples, Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin c51af29 058/439: Reorganize repository layout, allowing site installation., Philip Kaludercic, 2021/10/17
- [nongnu] elpa-admin 988d3f5 059/439: Add a table of contents to README file, Philip Kaludercic, 2021/10/17