FYI: maint: update release procedure

[Akim Demaille]

Installed in maint.

From 4d4777c786d627f40809d5ecf8b86cc13c7cd362 Mon Sep 17 00:00:00 2001
From: Akim Demaille <address@hidden>
Date: Wed, 23 May 2012 15:17:35 +0200
Subject: [PATCH] maint: update release procedure

* bootstrap.conf: Request do-release-commit-and-tag and readme-release.
* README-hacking: Adjust.
---
 .gitignore           |    1 +
 README-hacking       |  103 +++++++++++++++++++++++++++-----------------------
 bootstrap.conf       |   11 +++++-
 build-aux/.gitignore |    1 +
 4 files changed, 66 insertions(+), 50 deletions(-)

diff --git a/.gitignore b/.gitignore
index a2ac6ce..a81896f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -31,3 +31,4 @@
 /patches
 /releases
 /stamp-h*
+/README-release
diff --git a/README-hacking b/README-hacking
index 97c73a8..b3364ac 100644
--- a/README-hacking
+++ b/README-hacking
@@ -70,8 +70,9 @@ out-of-date version of the C code, but the process is not 
foolproof.
 Also, you may run into similar problems yourself if you modify Bison.
 
 Only building the initial full source tree will be a bit painful.
-Later, after synchronizing from the repository a plain `make' should
-be sufficient.
+Later, after synchronizing from the repository a plain 'make' should
+be sufficient.  Note, however, that when gnulib is updated, running
+'./bootstrap' again might be needed.
 
 ** First checkout
 
@@ -118,14 +119,14 @@ explicitly by the user.
 
 *** Updating Bison
 
-If you pull a newer version of a branch, say via `git pull', you might
-import requests for updated submodules.  A simple `git diff' will
+If you pull a newer version of a branch, say via "git pull", you might
+import requests for updated submodules.  A simple "git diff" will
 reveal if the current version of the submodule (i.e., the actual
 contents of the gnulib directory) and the current request from the
 subscriber (i.e., the reference of the version of gnulib that the
 Bison reporitory requests) differ.  To upgrade the submodules (i.e.,
 to check out the version that is actually requested by the subscriber,
-run `git submodule update'.
+run "git submodule update".
 
         $ git pull
         $ git submodule update
@@ -177,39 +178,43 @@ release:
   that 1. Bison compiles cleanly, 2. the parsers it produces compile
   cleanly too.
 
-- Build with -DGNULIB_POSIXCHECK.  It suggests gnulib modules that can
-  fix portability issues.
+- Maybe build with -DGNULIB_POSIXCHECK, which suggests gnulib modules
+  that can fix portability issues.  See if you really want to pay
+  attention to its warnings; there's no need to obey blindly to it
+  (<http://lists.gnu.org/archive/html/bison-patches/2012-05/msg00057.html>).
 
-- Check with `make syntax-check' if there are issues diagnosed by
+- Check with "make syntax-check" if there are issues diagnosed by
   gnulib.
 
-- run `make maintainer-check' which:
-  - runs `valgrind -q bison' to run Bison under Valgrind.
+- run "make maintainer-check" which:
+  - runs "valgrind -q bison" to run Bison under Valgrind.
   - runs the parsers under Valgrind.
   - runs the test suite with G++ as C compiler...
 
-- run `make maintainer-push-check', which runs `make maintainer-check'
+- run "make maintainer-push-check", which runs "make maintainer-check"
   while activating the push implementation and its pull interface wrappers
   in many test cases that were originally written to exercise only the
   pull implementation.  This makes certain the push implementation can
   perform every task the pull implementation can.
 
-- run `make maintainer-xml-check', which runs `make maintainer-check'
+- run "make maintainer-xml-check", which runs "make maintainer-check"
   while checking Bison's XML automaton report for every working grammar
   passed to Bison in the test suite.  The check just diffs the output of
   Bison's included XSLT style sheets with the output of --report=all and
   --graph.
 
-- running `make maintainer-release-check' takes care of running
+- running "make maintainer-release-check" takes care of running
   maintainer-check, maintainer-push-check and maintainer-xml-check.
 
 - Change tests/atlocal/CFLAGS to add your preferred options.  For
-  instance, `-traditional' to check that the parsers are K&R.  Note
-  that it does not make sense for glr.c, which should be ANSI,
-  but currently is actually GNU C, nor for lalr1.cc.
+  instance, "-traditional" to check that the parsers are K&R.  Note
+  that it does not make sense for glr.c, which should be ANSI, but
+  currently is actually GNU C, nor for lalr1.cc.
 
 
 * Release Procedure
+This section needs to be updated to take into account features from
+gnulib.  In particular, be sure to read README-release.
 
 ** Update the submodules.  See above.
 
@@ -225,7 +230,7 @@ This helps: grep -l '\<_(' *
 See above.
 
 ** Update the foreign files
-Running `./bootstrap' in the top level should update them all for you.
+Running "./bootstrap" in the top level should update them all for you.
 This covers PO files too.  Sometimes a PO file contains problems that
 causes it to be rejected by recent Gettext releases; please report
 these to the Translation Project.
@@ -237,7 +242,7 @@ Bison sources.
 
 ** Check copyright years.
 We update years in copyright statements throughout Bison once at the
-start of every year by running `make update-copyright'.  However, before
+start of every year by running "make update-copyright".  However, before
 a release, it's good to verify that it's actually been run.  Besides the
 copyright statement for each Bison file, check the copyright statements
 that the skeletons insert into generated parsers, and check all
@@ -248,55 +253,57 @@ The version number, *and* the date of the release 
(including for
 betas).
 
 ** Mention the release name in a commit message
-Should have an entry similar to `Version 2.3b.'.
+Should have an entry similar to "Version 2.3b.".
 
 ** Tag the release
 Before Bison will build with the right version number, you must tag
 the release in git.  Do this after all other changes.  The command is
 similar to:
 
-  git tag -a v2.3b
+  git tag -a v2.3b -m "Bison 2.3b."
 
-The commit message can be simply:
+** Push
+Once "make distcheck" passes, push your changes and the tag.
+"git push" without arguments will not push the tag.
 
-  Bison 2.3b
+** make alpha, beta, or release
+See README-release.
 
-** Push
-Once `make distcheck' passes, push your changes and the tag.
-`git push' without arguments will not push the tag.
+** Upload
+There are two ways to upload the tarballs to the GNU servers: using
+gnupload (from gnulib), or by hand.  Obviously prefer the former.  But
+in either case, be sure to read the following paragraph.
+
+*** Setup
+You need "gnupg".
 
-** make alpha
-FIXME: `make alpha' is not maintained and is broken.  These
-instructions need to be replaced or removed.
+Make sure your public key has been uploaded at least to
+keys.gnupg.net.  You can upload it with:
 
-Running `make alpha' is absolutely perfect for beta releases: it makes
-the tarballs, the xdeltas, and prepares (in /tmp/) a proto
-announcement.  It is so neat, that that's what I use anyway for
-genuine releases, but adjusting things by hand (e.g., the urls in the
-announcement file, the ChangeLog which is not needed etc.).
+  gpg --keyserver keys.gnupg.net --send-keys F125BDF3
 
-If it fails, you're on your own...
+where F125BDF3 should be replaced with your key ID.
 
-It requires GNU Make.
+*** Using gnupload
+You need "ncftp".
+
+At the end "make release" (or alpha/beta) will display the prodecure
+to run.  Just copy and paste it in your shell.
+
+*** By hand
 
-** Upload
 The generic GNU upload procedure is at:
 
   http://www.gnu.org/prep/maintain/maintain.html#Automated-FTP-Uploads
 
 Follow the instructions there to register your information so you're permitted
-to upload.  Make sure your public key has been uploaded at least to
-keys.gnupg.net.  You can upload it with:
-
-  gpg --keyserver keys.gnupg.net --send-keys F125BDF3
-
-where F125BDF3 should be replaced with your key ID.
+to upload.
 
 Here's a brief reminder of how to roll the tarballs and upload them:
 
 *** make distcheck
 *** gpg -b bison-2.3b.tar.gz
-*** In a file named `bison-2.3b.tar.gz.directive', type:
+*** In a file named "bison-2.3b.tar.gz.directive", type:
 
       version: 1.1
       directory: bison
@@ -362,10 +369,10 @@ replaced with your key ID.
 Complete/fix the announcement file.  The generated list of recipients
 (address@hidden, address@hidden, address@hidden,
 address@hidden, and address@hidden) is
-appropriate for a stable release or a ``serious beta''.  For any other
-release, drop at least address@hidden  For an example of how to fill
-out the rest of the template, search the mailing list archives for the
-most recent release announcement.
+appropriate for a stable release or a "serious beta".  For any other
+release, drop at least address@hidden  For an example of how to
+fill out the rest of the template, search the mailing list archives
+for the most recent release announcement.
 
 For a stable release, send the same announcement on the comp.compilers
 newsgroup by sending email to address@hidden  Do not make any Cc as
@@ -373,7 +380,7 @@ the moderator will throw away anything cross-posted or 
Cc'ed.  It really
 needs to be a separate message.
 
 ** Bump the version number
-In configure.ac.  Run `make'.  So that developers don't accidentally add new
+In configure.ac.  Run "make".  So that developers don't accidentally add new
 items to the old NEWS entry, create a new empty NEWS entry something like:
 
   Changes in version ?.? (????-??-??):
diff --git a/bootstrap.conf b/bootstrap.conf
index 3303ef3..76c1ea5 100644
--- a/bootstrap.conf
+++ b/bootstrap.conf
@@ -18,12 +18,17 @@
 # gnulib modules used by this package.
 gnulib_modules='
   announce-gen argmatch assert calloc-posix close closeout config-h c-strcase
-  configmake dirname error extensions fdl fopen-safer gendocs getopt-gnu
+  configmake
+  dirname
+  do-release-commit-and-tag
+  error extensions fdl fopen-safer gendocs getopt-gnu
   gettext git-version-gen gitlog-to-changelog
   gpl-3.0 hash inttypes isnan javacomp-script
   javaexec-script ldexpl maintainer-makefile malloc-gnu mbschr mbsrchr
   mbswidth obstack perror progname
-  quote quotearg realloc-posix
+  quote quotearg
+  readme-release
+  realloc-posix
   spawn-pipe stdbool stpcpy strdup-posix strerror strtoul strverscmp
   unistd unistd-safer unlocked-io update-copyright unsetenv verify
   warnings
@@ -76,6 +81,8 @@ bootstrap_epilogue()
   # Make sure we don't need src/bison, which usually doesn't exist at
   # the time of a bootstrap.
   touch src/parse-gram.[ch]
+
+  perl -pi -e "s/address@hidden@/$package/g" README-release
 }
 
 # Keep our bootstrap script in sync with gnulib's.  If we ever need to
diff --git a/build-aux/.gitignore b/build-aux/.gitignore
index f09add4..3733f46 100644
--- a/build-aux/.gitignore
+++ b/build-aux/.gitignore
@@ -23,3 +23,4 @@
 /vc-list-files
 /warn-on-use.h
 /ylwrap
+/do-release-commit-and-tag
-- 
1.7.10.2