mirror of
https://git.savannah.gnu.org/git/bison.git
synced 2026-03-21 18:23:03 +00:00
doc: remove obsolete release instructions
* README-hacking.md: here.
This commit is contained in:
Akim Demaille
@@ -398,171 +398,8 @@ re-run the tests, run:
|
|||||||
Release Procedure
|
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.
|
|
||||||
|
|
||||||
## Update maintainer tools, such as Autoconf. See above.
|
|
||||||
|
|
||||||
## Try to get the *.pot files to the Translation Project at least one
|
|
||||||
week before a stable release, to give them time to translate them. Before
|
|
||||||
generating the *.pot files, make sure that po/POTFILES.in and
|
|
||||||
runtime-po/POTFILES.in list all files with translatable strings. This
|
|
||||||
helps: `grep -l '\<_(' *`.
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
See above.
|
|
||||||
|
|
||||||
## Update the foreign files
|
|
||||||
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.
|
|
||||||
|
|
||||||
## Update README
|
|
||||||
Make sure the information in README is current. Most notably, make sure it
|
|
||||||
recommends a version of GNU M4 that is compatible with the latest 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 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 occurrences of
|
|
||||||
`PACKAGE_COPYRIGHT_YEAR` in configure.ac.
|
|
||||||
|
|
||||||
## Update NEWS, commit and tag.
|
|
||||||
See do-release-commit-and-tag in README-release. For a while, we used beta
|
|
||||||
names such as `2.6_rc1`. Now that we use gnulib in the release procedure,
|
|
||||||
we must use `2.5.90`, which has the additional benefit of being properly
|
|
||||||
sorted in `git tag -l`.
|
|
||||||
|
|
||||||
## make alpha, beta, or stable
|
|
||||||
See README-release.
|
See README-release.
|
||||||
|
|
||||||
## 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 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.
|
|
||||||
|
|
||||||
### Using gnupload
|
|
||||||
You need `ncftp`.
|
|
||||||
|
|
||||||
At the end `make stable` (or alpha/beta) will display the procedure to run.
|
|
||||||
Just copy and paste it in your shell.
|
|
||||||
|
|
||||||
### By hand
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
version: 1.1
|
|
||||||
directory: bison
|
|
||||||
filename: bison-2.3b.tar.gz
|
|
||||||
|
|
||||||
### gpg --clearsign bison-2.3b.tar.gz.directive
|
|
||||||
### ftp ftp-upload.gnu.org # Log in as anonymous.
|
|
||||||
### cd /incoming/alpha # cd /incoming/ftp for full release.
|
|
||||||
### put bison-2.3b.tar.gz # This can take a while.
|
|
||||||
### put bison-2.3b.tar.gz.sig
|
|
||||||
### put bison-2.3b.tar.gz.directive.asc
|
|
||||||
### Repeat all these steps for bison-2.3b.tar.xz.
|
|
||||||
|
|
||||||
## Update Bison manual on www.gnu.org.
|
|
||||||
|
|
||||||
The instructions below are obsolete, and left in case one would like to run
|
|
||||||
the commands by hand. Today, one just needs to run
|
|
||||||
|
|
||||||
$ make web-manual-update
|
|
||||||
|
|
||||||
See README-release.
|
|
||||||
|
|
||||||
### You need a non-anonymous checkout of the web pages directory.
|
|
||||||
|
|
||||||
$ cvs -d YOUR_USERID@cvs.savannah.gnu.org:/web/bison checkout bison
|
|
||||||
|
|
||||||
### Get familiar with the instructions for web page maintainers.
|
|
||||||
http://www.gnu.org/server/standards/readme_index.html
|
|
||||||
http://www.gnu.org/server/standards/README.software.html
|
|
||||||
especially the note about symlinks.
|
|
||||||
|
|
||||||
### Build the web pages.
|
|
||||||
Assuming BISON_CHECKOUT refers to a checkout of the Bison dir, and
|
|
||||||
BISON_WWW_CHECKOUT refers to the web directory created above, do:
|
|
||||||
|
|
||||||
$ cd $BISON_CHECKOUT/doc
|
|
||||||
$ make stamp-vti
|
|
||||||
$ ../build-aux/gendocs.sh -o "$BISON_WWW_CHECKOUT/manual" \
|
|
||||||
bison "Bison - GNU parser generator"
|
|
||||||
$ cd $BISON_WWW_CHECKOUT
|
|
||||||
|
|
||||||
Verify that the result looks sane.
|
|
||||||
|
|
||||||
### Commit the modified and the new files.
|
|
||||||
|
|
||||||
### Remove old files.
|
|
||||||
Find the files which have not been overwritten (because they belonged to
|
|
||||||
sections that have been removed or renamed):
|
|
||||||
|
|
||||||
$ cd manual/html_node
|
|
||||||
$ ls -lt
|
|
||||||
|
|
||||||
Remove these files and commit their removal to CVS. For each of these
|
|
||||||
files, add a line to the file .symlinks. This will ensure that hyperlinks
|
|
||||||
to the removed files will redirect to the entire manual; this is better than
|
|
||||||
a 404 error.
|
|
||||||
|
|
||||||
## Announce
|
|
||||||
The "make release" command just created a template,
|
|
||||||
`$HOME/announce-bison-X.Y`. Otherwise, to generate it, run:
|
|
||||||
|
|
||||||
make RELEASE_TYPE=alpha gpg_key_ID=F125BDF3 announcement
|
|
||||||
|
|
||||||
where alpha can be replaced by `beta` or `table` and F125BDF3 should be
|
|
||||||
replaced with your key ID.
|
|
||||||
|
|
||||||
Complete/fix the announcement file. The generated list of recipients
|
|
||||||
(info-gnu@gnu.org, bison-announce@gnu.org, bug-bison@gnu.org,
|
|
||||||
help-bison@gnu.org, bison-patches@gnu.org, and
|
|
||||||
coordinator@translationproject.org) is appropriate for a stable release or a
|
|
||||||
"serious beta". For any other release, drop at least info-gnu@gnu.org. 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 compilers@iecc.com. Do not make any Cc as the
|
|
||||||
moderator will throw away anything cross-posted or Cc'ed. It really needs
|
|
||||||
to be a separate message.
|
|
||||||
|
|
||||||
## Prepare NEWS
|
|
||||||
So that developers don't accidentally add new items to the old NEWS entry,
|
|
||||||
create a new empty entry in line 3 (without the two leading spaces):
|
|
||||||
|
|
||||||
* Noteworthy changes in release ?.? (????-??-??) [?]
|
|
||||||
|
|
||||||
Push these changes.
|
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
|
||||||
Copyright (C) 2002-2005, 2007-2015, 2018-2020 Free Software Foundation,
|
Copyright (C) 2002-2005, 2007-2015, 2018-2020 Free Software Foundation,
|
||||||
|
|||||||
Reference in New Issue
Block a user