Re: ELPA ada-mode.release not updating

[Stephen Leake <stephen_leake@stephe-leake.org>]

[-- Attachment #1: Type: text/plain, Size: 893 bytes --]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> Ok, I've pushed externals-release/ada-mode and externals-release/wisi,
>> and deleted the other branches.
>
> Looks like it worked (it first bumped into a bug in `elpa-admin.el`,
> but I got that sorted out).
>
>> Attached is a patch for README; ok to commit?
>
> AFAICT this is a patch for the `README` of the `main` branch of
> `elpa.git`.  There's a separate `README` in `admin` (one that's
> supposed to be generic and document the functionality of the code,
> e.g. mentioning "externals" there doesn't make sense there since that
> name comes from the `elpa-config` file in `main` branch of `elpa.git`).
>
> Part of the story is explained in the first paragraph of those
> `README` files.

Ok, I compared the two REAMEs with ediff; there were a couple other
differences, and I fixed one typo. Attached are two patches.

-- 
-- Stephe

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: elpa-readme.diff --]
[-- Type: text/x-patch, Size: 2724 bytes --]

diff --git a/README b/README
index b0bb6fc67d..5952a007d0 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 #+TITLE: GNU ELPA README
-#+DATE: 2022-06-05
+#+DATE: 2022-10-26
 
 Copyright (C) 2010-2022 Free Software Foundation, Inc. \\
 See the end of the file for license conditions.
@@ -7,7 +7,7 @@ See the end of the file for license conditions.
 #+BEGIN_COMMENT
 This file exists in two branches ~elpa-admin~ and ~elpa~.  The two version
 differ slightly.  The introductory text before the first heading
-differs and their are minor differences concerning the ~externals/*~ to
+differs and there are minor differences concerning the ~externals/*~ to
 ~elpa/*~ transition.  Please make sure you always update this file in
 both locations to avoid introducing additional differences.  This
 duplication will be removed eventually.
@@ -158,6 +158,14 @@ and only if the version number in the development branch indicates that it
 contains development code (i.e. a "snapshot" version, according to
 `version-to-list`).
 
+If there is no upstream (:url is nil), the presence of :release-branch
+just indicates that release and devel branches in elpa.git are desired
+(the name given in :release-branch is ignored). The release branch is
+named `externals-release/<pkg-name>' for GNU ELPA and
+`elpa-release/<pkg-name>` for NonGNU ELPA. The standard package branch
+externals/<pkg-name> is the devel branch in GNU ELPA; the standard
+branch elpa/<pkg-name> is the devel branch in non-GNU ELPA.
+
 ** =:ignored-files FILES=
 Names of files or directories that should not be included in the tarballs.
 
@@ -171,7 +179,8 @@ having to specify it here.
 ** =:readme FILE=
 Name of the file to use as the description of the package.  By default
 we try to use README, README.rst, README.org, or the Commentary section
-in the main file.
+in the main file.  If ~ignore~, ignore any matching file and use the Commentary
+section.
 
 ** =:news FILE=
 Name of the file that contains the list of changes in recent versions
@@ -287,7 +296,6 @@ Delete all the files generated by =make packages/[PKGNAME]=.
 * Packages
 
 ** Contents of the =packages/= directory:
-
 This directory holds the package sources, with one subdirectory for
 each package.
 
@@ -414,7 +422,7 @@ and the web-pages from this source code:
   auto-generated from it.
 - Every package should have both a =Version:= /and/ a =Maintainer:=.
 - The =Version:= must be acceptable to =version-to-list=.
-- The =URL:= header can be used to specify the website
+- The =URL:= header can be used to specify the home page
   of the package, if it's maintained externally.
 - A =News:= section (or "NEWS" file) can/should be used to list the
   user-visible changes of each version.

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: elpa-admin-readme.diff --]
[-- Type: text/x-patch, Size: 2442 bytes --]

diff --git a/README b/README
index 4ff305047a..62021e3ca0 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 #+TITLE: ELPA-Admin README
-#+DATE: 2022-01-06
+#+DATE: 2022-10-26
 
 Copyright (C) 2010-2022 Free Software Foundation, Inc. \\
 See the end of the file for license conditions.
@@ -7,7 +7,7 @@ See the end of the file for license conditions.
 #+BEGIN_COMMENT
 This file exists in two branches ~elpa-admin~ and ~elpa~.  The two version
 differ slightly.  The introductory text before the first heading
-differs and their are minor differences concerning the ~externals/*~ to
+differs and there are minor differences concerning the ~externals/*~ to
 ~elpa/*~ transition.  Please make sure you always update this file in
 both locations to avoid introducing additional differences.  This
 duplication will be removed eventually.
@@ -19,7 +19,7 @@ the [[https://elpa.gnu.org/][GNU ELPA]] and NonGNU ELPA archives.
 * Getting the source
 
 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.
+and look for "GNU ELPA".  Using a clone of a clone does not work.
 
 You must then do some setup:
 #+begin_src shell
@@ -119,6 +119,14 @@ and only if the version number in the development branch indicates that it
 contains development code (i.e. a "snapshot" version, according to
 `version-to-list`).
 
+If there is no upstream (:url is nil), the presence of :release-branch
+just indicates that release and devel branches in elpa.git are desired
+(the name given in :release-branch is ignored). The release branch is
+named `externals-release/<pkg-name>' for GNU ELPA and
+`elpa-release/<pkg-name>` for NonGNU ELPA. The standard package branch
+externals/<pkg-name> is the devel branch in GNU ELPA; the standard
+branch elpa/<pkg-name> is the devel branch in non-GNU ELPA.
+
 ** =:ignored-files FILES=
 Names of files or directories that should not be included in the tarballs.
 
@@ -254,7 +262,8 @@ each package.
 
 Each directory in here corresponds to a package.
 
-A nightly cron job refreshes the GNU ELPA archive from this repository.
+A nightly cron job on the server hosting =elpa.gnu.org= refreshes the
+GNU ELPA archive from this repository.
 
 This cron job only creates a new package when the "version" (as specified in
 the =Version:= header) of a package is modified.  This means that you can