[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
ELPA notes, README
From: |
Stephen Leake |
Subject: |
ELPA notes, README |
Date: |
Sun, 10 Jan 2021 15:05:18 -0800 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.1 (windows-nt) |
I'm starting to work on documenting how to bundle Gnu ELPA packages in
the Emacs distribution tarball.
As a first step, I checked out the current documentation, and I have
some suggested improvements even without the bundling option.
In Emacs admin/notes/elpa: see attached elpa_notes.diff. This reflects
recent changes to elpa.
In ELPA README: see attached elpa_readme.diff. This moves 'make
packages/<pkgname>' to the "getting the source" section, and documents
the need for 'make setup'.
Ok to commit?
Next step: I'll go thru the recent thread and compile the policy and
process info into emacs/admin/notes/elpa (without committing anything).
--
-- Stephe
diff --git a/admin/notes/elpa b/admin/notes/elpa
index ea6c132fe1..1e9e7a9f52 100644
--- a/admin/notes/elpa
+++ b/admin/notes/elpa
@@ -5,17 +5,31 @@ repository named "elpa", hosted on Savannah. To check it out:
git clone git://git.sv.gnu.org/emacs/elpa
cd elpa
- git remote set-url --push origin git+ssh://git.sv.gnu.org/srv/git/emacs/elpa
- [create task branch for edits, etc.]
+ make setup
-Changes to this branch propagate to elpa.gnu.org via a "deployment" script run
-daily. This script (which is kept in elpa/admin/update-archive.sh) generates
-the content visible at https://elpa.gnu.org/packages.
+That leaves the elpa/packages directory empty; you must check out the
+ones you want.
-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.
+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 <pkgname> into the packages
+directory with:
+
+ make packages/<pkgname>
+
+
+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/README b/README
index d6114a852c..9e77d6c1f3 100644
--- a/README
+++ b/README
@@ -23,6 +23,36 @@ for testing purposes).
Start with source that is cloned directly from Savannah. See
[[https://savannah.gnu.org/git/?group=emacs][the Savannah page]]
and look for "ELPA". Using a clone of a clone does not work.
+You must then do some setup:
+#+begin_src shell
+ make setup
+#+end_src
+
+That leaves the =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:
+
+#+begin_src shell
+ make worktrees
+#+end_src
+
+You can check out a specific package =<pkgname>= into the =packages=
+directory with this command:
+
+#+begin_src
+ make packages/<pkgname>
+#+end_src
+
+If you already have a =packages/<pkgname>= directory with a previous
+checkout, you can update it like this:
+
+#+begin_src
+ cd packages/PACKAGE
+ git pull
+#+end_src
+
* Directory layout
** =admin/= -- scripts for administering the package archive.
@@ -221,28 +251,6 @@ and push that change to the master branch of =elpa=.
After it's added to
the =elpa-packages= file, the package can be maintained just by
pushing changes to the =externals/<pkgname>= branch.
-If you wish to check out all the packages into the =packages=
-directory, you can run the command:
-
-#+begin_src shell
- make worktrees
-#+end_src
-
-You can check out a specific package =<pkgname>= into the =packages=
-directory with these commands:
-
-#+begin_src
- make packages/<pkgname>
-#+end_src
-
-If you already have a =packages/<pkgname>= directory with a previous
-checkout, you can update it like this:
-
-#+begin_src
- cd packages/PACKAGE
- git pull
-#+end_src
-
** Public incubation
If you want to develop a package publicly prior to its first release (to
- ELPA notes, README,
Stephen Leake <=