From ba7c2debefdaf3faabd464694059438bbb510fa8 Mon Sep 17 00:00:00 2001 From: Stefan Monnier Date: Wed, 7 Jan 2026 10:55:11 -0500 Subject: [PATCH] * admin/notes/elpa.md: Update to match current reality * admin/notes/elpa: Rename to `elpa.md`. * admin/notes/elpa.md: Rename from `elpa`, adjust to recently changed repository location, mention the "new" NonGNU repository. --- admin/notes/elpa | 35 ----------------------------------- admin/notes/elpa.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 35 deletions(-) delete mode 100644 admin/notes/elpa create mode 100644 admin/notes/elpa.md diff --git a/admin/notes/elpa b/admin/notes/elpa deleted file mode 100644 index afcda71d1dd..00000000000 --- a/admin/notes/elpa +++ /dev/null @@ -1,35 +0,0 @@ -NOTES ON THE EMACS PACKAGE ARCHIVE - -The GNU Emacs package archive, at elpa.gnu.org, is managed using a Git -repository named "elpa", hosted on Savannah. To check it out: - - git clone https://git.savannah.gnu.org/git/emacs/elpa - cd elpa - make setup - -That leaves the elpa/packages directory empty; you must check out the -ones you want. - -If you wish to check out all the packages into the packages directory, -you can run the command: - - make worktrees - -You can check out a specific package into the packages -directory with: - - make packages/ - - -Changes to this repository propagate to elpa.gnu.org via a -"deployment" script run daily. This script generates the content -visible at https://elpa.gnu.org/packages. - -A new package is released as soon as the "version number" of that -package is changed. So you can use 'elpa' to work on a package -without fear of releasing those changes prematurely. And once the -code is ready, just bump the version number to make a new release of -the package. - -It is easy to use the elpa branch to deploy a "local" copy of the -package archive. For details, see the README file in the elpa branch. diff --git a/admin/notes/elpa.md b/admin/notes/elpa.md new file mode 100644 index 00000000000..791f0dec677 --- /dev/null +++ b/admin/notes/elpa.md @@ -0,0 +1,43 @@ +# NOTES ON THE EMACS PACKAGE ARCHIVE + +The Emacs package archives at `elpa.gnu.org` (GNU ELPA and NonGNU ELPA) +are managed using two Git repositories named `gnu.git` and `nongnu.git` +hosted in the `elpa` group on Savannah. +To check them out: + + git clone https://git.savannah.gnu.org/git/elpa/gnu.git + cd gnu + make setup + +resp. + + git clone https://git.savannah.gnu.org/git/elpa/nongnu.git + cd nongnu + make setup + +That leaves the `(non)gnu/packages` directory empty; you must check out the +ones you want. + +If you wish to check out all the packages into the packages directory, +you can run the command: + + make worktrees + +You can check out a specific package into the packages +directory with: + + make packages/ + +Changes to this repository propagate to `elpa.gnu.org` via a +"deployment" script run daily. This script generates the content +visible at https://elpa.gnu.org/packages and https://elpa.nongnu.org/nongnu + +A new package is released as soon as the "version number" of that +package is changed (as found in the `;; Version:` header of the main +ELisp file of the package). So you can use `elpa/(non)gnu.git` to work +on a package without fear of releasing those changes prematurely. +And once the code is ready, just bump the version number to make a new +release of the package. + +It is easy to use these repositories to deploy a "local" copy of the +package archive. For details, see the README file after cloning them.