[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] elpa-admin 35ba6e2 055/357: Update README to describe the new rep
From: |
Stefan Monnier |
Subject: |
[elpa] elpa-admin 35ba6e2 055/357: Update README to describe the new repository layout. |
Date: |
Thu, 10 Dec 2020 18:06:14 -0500 (EST) |
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.
- [elpa] elpa-admin dbbb145 035/357: Clearer reference to the license text, (continued)
- [elpa] elpa-admin dbbb145 035/357: Clearer reference to the license text, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin d9cdf2a 008/357: Added comment about installing with multiple emacsen., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin da5ff0a 003/357: Added to CVS (formerly not under RCS)., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin ae7a3df 034/357: Copy Emacs wiki page's content to new README file, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 051b643 041/357: README: Add a section about source code repository, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 5fefd44 048/357: Update archive-contents to add package versions from contents., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 14ac0ef 040/357: Merge branch 'action', Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 18bfa15 069/357: Add coffee-mode., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 06a86aa 043/357: Add an explicit OPERATION-MODE "nil" in README's examples, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 45792fe 051/357: Remove version numbers from filenames in packages/ dir., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 35ba6e2 055/357: Update README to describe the new repository layout.,
Stefan Monnier <=
- [elpa] elpa-admin 99b8d94 054/357: admin/archive-contents.el (batch-make-archive, archive--process-simple-package): Use write-region, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 782beee 061/357: Merge branch 'action-autoselect', Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 4eaf276 078/357: * admin/archive-contents.el (batch-make-archive): Don't demote errors., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 26ce878 006/357: # Updated for SourceForge, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 938c532 010/357: add README file., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 3f66070 019/357: Turn README back into text. Add special redcloth version., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 6de6395 017/357: See if changing the name from README to README.markup gives github a clue, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 1329950 024/357: Administrivia. Add COPYING, update README and .gitignore, bump version number., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 03e28d1 028/357: README: Document usage of this repository in detail., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 5bbab91 030/357: * packages/all-1.0.el: Change version. Address byte-compiler warnings., Stefan Monnier, 2020/12/10