they are less busy).
2. When the branch date is near: Update the libiberty and config
- directories and the top level configure files.
+ directories and the top level Makefile and configure files. Also
+ consider updating the toplevel libtool files.
+
+
+Approx time to complete from here: 2 hours ....
3. When branch day arrives add markers for the upcoming release to
- the NEWS files in gas, ld, gold and binutils.
+ the NEWS files in gas, ld, and binutils. No need to update NEWS
+ in the gold directory - it has its own release numbering.
Likewise for the ChangeLog files in: bfd, binutils, config, cpu,
- elfcpp, gas, gold, gprof, include, ld, opcodes and toplevel.
+ elfcpp, gas, gold, gprof, include, ld, libctf, libiberty, opcodes
+ and toplevel.
Add a note of the name of the new branch to binutils/BRANCHES.
4. Create the release branch using:
- git branch binutils-2_33-branch
- git push origin binutils-2_33-branch
+ git branch binutils-2_40-branch
+ git push origin binutils-2_40-branch
If you get a message like:
5. Make sure that the branch is there. IE check out the branch sources:
- git clone ssh://sourceware.org/git/binutils-gdb.git -b binutils-2_33-branch 2.33
+ git clone ssh://sourceware.org/git/binutils-gdb.git -b binutils-2_40-branch 2.40
If you get a message about being in a "detached head" state, something
has gone wrong...
- Keep the checked out sources - they are going to be needed in future steps.
+ Keep the checked out sources - they are going to be needed in future
+ steps.
6. Update "BINUTILS_BRANCH" in gdbadmin's crontab:
ask Joel Brobecker <brobecker AT adacore DOT com>.
7. Rename the current HEAD version entry in Bugzilla, and create a
- new one. E.g. rename "2.33 (HEAD)" to 2.33, and create "2.34
- (HEAD)":
+ new one. E.g. rename "2.38 (HEAD)" to 2.38, and create
+ "2.39 (HEAD)":
https://sourceware.org/bugzilla/editversions.cgi?product=binutils
8. Update bfd/version.m4 on HEAD to indicate that is now a snapshot
- of the next release:
+ of the next release and the BRANCH to indicated that it is almost
+ ready for the release.
+
+ So if the release is going to be 2.40 then the version number on
+ the BRANCH should be set to 2.39.90 - ie almost, but not quite 2.40,
+ and the version number on the MAINLINE should be set to 2.40.50 -
+ ie half way to 2.41 release.
+
+ So the branch bfd/version.m4 has:
- m4_define([BFD_VERSION], [2.33.51])
+ m4_define([BFD_VERSION], [2.39.90])
- Update the release number in bfd/version.m4 for the branch.
- The branch only needs the point value set to 90 as the release
- has not actually happened yet.
+ and the mainline has:
- m4_define([BFD_VERSION], [2.32.90])
+ m4_define([BFD_VERSION], [2.40.50])
Regenerate various files on both branch and HEAD by configuring
- with "--enable-maintainer-mode --enable-gold" and then building
- with "make all-binutils all-gas all-gold all-gprof all-ld"
+ with "--enable-maintainer-mode --enable-gold --enable-shared" and then building
+ with "make all-binutils all-gas all-gold all-gprof all-gprofng all-ld"
Add ChangeLog entries for the updated files. Commit the changes.
Make sure that this includes the .pot files as well as the
configure and makefiles.
- 8. Create an initial prerelease:
+ 9. Create an initial pre-release:
- a. Create a source tarball of the BRANCH sources:
+ a. Remove any auto-generated files, in order to force the
+ src-release script to rebuild them.
+
+ cd <branch-sources>
+ git clean -fdx
+
+ b. Create a source tarball of the BRANCH sources:
- cd <branch-sources>
- ./src-release -x binutils
+ ./src-release.sh -x binutils
- b. Build a test target using this tarball.
+ c. Build a test target using this tarball.
- cp binutils-<version>.tar.xz /dev/shm
- cd /dev/shm
- tar xvf binutils-<version>.tar.xz
+ cp binutils-2.39.90.tar.xz /dev/shm
+ pushd /dev/shm
+ tar xvf binutils-2.39.90.tar.xz
mkdir build
cd build
- ../<version>/configure --quiet --enable-gold
+ ../binutils-2.39.90/configure --quiet --enable-gold
make
+ popd
If there are problems, fix them.
- c. Upload the prerelease snapshot to the sourceware FTP site:
+ d. Upload the pre-release snapshot to the sourceware FTP site:
- cd <branch-sources>
- scp binutils-<version>.tar.xz sourceware.org:~ftp/pub/binutils/snapshots
- ssh sourceware.org md5sum ~ftp/pub/binutils/snapshots/binutils-<version>.tar.xz
-
- d. Clean up the source directory.
-
- rm binutils-<version> binutils-<version>.tar binutils-<version>.tar.xz
- rm gas/bfin-lex.c \
- gas/bfin-parse.c \
- gas/bfin-parse.h \
- gas/itbl-lex.c \
- gas/itbl-parse.c \
- gas/itbl-parse.h \
- gas/m68k-parse.c \
- gas/rl78-parse.c \
- gas/rl78-parse.h \
- gas/rx-parse.c \
- gas/rx-parse.h \
- gold/yyscript.c \
- gold/yyscript.h
- rm -fr proto-toplev
-
- 9. Tell the Translation Project where to find the new tarball. <coordinator@translationproject.org>
- qv: http://translationproject.org/html/maintainers.html
+ scp binutils-2.39.90.tar.xz sourceware.org:/var/ftp/pub/binutils/snapshots
+ ssh sourceware.org sha256sum ~ftp/pub/binutils/snapshots/binutils-2.39.90.tar.xz
+
+ e. Clean up the source directory again.
+
+ git clean -fdx
+
+ 10. Tell the Translation Project where to find the new tarball.
+ <coordinator@translationproject.org>
+ qv: https://translationproject.org/html/maintainers.html
------------------------------------------------------------------------
Dear Translation Project
- The 2.31 release branch has been created for the FSF binutils.
+ The 2.40 release branch has been created for the GNU Binutils project.
A snapshot of the branch sources can be found here:
- https://sourceware.org/pub/binutils/snapshots/binutils-2.30.90.tar.xz
+ https://sourceware.org/pub/binutils/snapshots/binutils-2.39.90.tar.xz
- We hope to make the official release of the sources on the 8th July
+ We hope to make the official release of the sources on the <DATE>
although that could change if there are important bugs that need to
be fixed before the release.
------------------------------------------------------------------------
- 10. Announce the availability of the snapshot and the branch on the
+ 11. Announce the availability of the snapshot and the branch on the
binutils mailing list. Set a date for when the release will
actually happen. Something like:
------------------------------------------------------------------------
Hi Everyone,
- The 2.XX branch has now been created:
+ The <NEW_VERSION> branch has now been created:
- git clone git://sourceware.org/git/binutils-gdb.git -b binutils-2_XX-branch 2.XX
+ git clone git://sourceware.org/git/binutils-gdb.git -b binutils-<NEW_VERSION>-branch
A snapshot of the sources is also available here:
- https://sourceware.org/pub/binutils/snapshots/binutils-2.XX.90.tar.xz
+ https://sourceware.org/pub/binutils/snapshots/binutils-<OLD_VERSION>.90.tar.xz
Please could all patches for the branch be run by me.
The rules for the branch are:
* Fixes for testsuite failures are OK.
Ideally I would like to make the release happen in two weeks time,
- i.e. Saturday 27th Jan. Which I hope will be enough time for everyone
+ i.e. <DATE>. Which I hope will be enough time for everyone
to get their final fixes in.
------------------------------------------------------------------------
- 11. Build various different toolchains, test them and nag
+ 12. Build various different toolchains, test them and nag
maintainers to fix any testsuite failures for their
architectures...
+==============================================================================
When the time comes to actually make the release....
patch files (.reg .orig *~) left over.
cd <branch>
- cvsclean | xargs rm
+ git clean -fdx
+
+ 21. a. Update the release number in bfd/version.m4 on the release
+ branch to a whole new minor version number, without a point
+ value. Eg "2.39.90" becomes "2.40".
+
+ b. Change bfd/development.sh to set all values to "false".
+
+ c. Regenerate the configure and makefiles. And *info* files.
+
+ make all-gas all-ld all-binutils all-gprof all-gold all-gprofng
+ make info
+
+ d. Create a ChangeLog from the git refs for all of the commits
+ from when changelog entries were no longer required:
- 21. Update the release number in bfd/version.m4 on the release
- branch to a whole new minor version number, without a point
- value. Eg "2.29.90" becomes "2.30". Change bfd/development.sh
- to set all values to "false". Regenerate the configure and
- makefiles. And *info* files. Add ChangeLog entries for the
- updates and add a "this-is-the-2.XX-release" comment and
- commit. Make sure to include the .gmo files.
+ gitlog-to-changelog --since=2021-07-03 > ChangeLog.git
+ git add ChangeLog.git
+ The gitlog-to-changelog script is part of the sources
+ of the "config" project.
+
+ e. Add ChangeLog entries for all of the updates and add a
+ "this-is-the-2.38-release" comment and commit.
+
+ git commit
+ git push
+
22. Check that your file creation mask will create the
correct file permissions. Eg:
Remove any spurious autom4te.cache files left over from the
reconfiguring:
- % find . -depth -name autom4te.cache -exec rm -r {} \;
+ git clean -fdx
23. Note - check to see if any new files have been added to the top
level of the source directory, but which are not in the
DEVO_SUPPORT variable in the src-release.sh script. If they are
needed then add them.
- Create the release tarballs:
+ Create the release tarballs:
./src-release.sh -b -g -l -x binutils
24. Check that the files in the tarballs have the correct
- permissions.
+ permissions.
+
+ tar tvf binutils-*.tar.bz2 | grep -e "---"
+
+ Also check that the man files are not empty. (cf PR 28144).
+
+ tar tvf binutils-*.tar.xz | grep -e "\.1"
25. Sanity check the release on x86_64-pc-linux-gnu by building and
- running the testsuite. Make the source directory read-only
- before building. Also test "make install". If necessary fix
- any problems.
+ running the testsuites (gas, gold, binutils and ld). Make the
+ source directory read-only before building. (Note - the gprofng
+ sources need a writeable doc/ directory. This is a bug that needs
+ to be fixed).
+ Also test "make install".
+ If necessary fix any problems.
+
+ pushd /dev/shm
+ mkdir delme
+ cd delme
+ tar xvf <path-to-sources>/binutils-2.*.tar.lz
+ chmod -R -w binutils-2.*
+ chmod +w binutils-2.*/gprofng/doc
+ mkdir build
+ cd build
+ ../binutils-2.*/configure --quiet --enable-gold --prefix=`pwd`/install --enable-plugins --enable-shared
+ make all-gas all-gold all-ld all-binutils all-gprof all-gprofng
+ make check-gas check-binutils check-ld check-gold
+ make install-gas install-gold install-ld install-binutils install-gprofng
+
+ # Needed for step 29...
+ make html pdf
+
+ popd
26. Tag the branch with the new release number:
+ [optional: add "-u XXXXX" to sign with a gpg key]
+ enter a tag message such as: "Official GNU Binutils 2.3x release"
- git tag -a binutils-2_XX
- [optional: add "-u XXXXX" to sign with a gpg key]
- git push origin binutils-2_XX
+ git tag -a binutils-2_40 -u DD9E3C4F <=== Be careful to get the tag right
NB/ If you do sign the binaries make sure to use a key
that has been published with the FSF.
- 27. Upload the tarballs to ftp.gnu.org.
+ Then push the release:
+
+ git push origin binutils-2_40
+
+ If you get an error message along the lines of:
+ "Invalid revision range ..." you can ignore it.
+
+ 27. Upload the tarballs to ftp.gnu.org.
- gnupload --to ftp.gnu.org:binutils binutils-X.XX.tar.*
+ gnupload --to ftp.gnu.org:binutils binutils-2.3*.tar.*
- The gnupload script is in the gnulib/build-aux directory.
+ Be prepared to provide the password for the key, if you
+ signed the binaries.
+
+ The gnupload script is in the gnulib/build-aux directory.
- Check for an email response from the upload. If necessary
- fix any problems.
+ Check for an email response from the upload. If necessary
+ fix any problems.
28. Upload the tarballs (and signatures) to sourceware.org:
sftp sourceware.org
cd /sourceware/ftp/pub/binutils/releases
- put binutils-X.XX.tar.*
- chmod 644 binutils-X.XX.tar.*
+ put binutils-2.3*.tar.*
+ chmod 644 binutils-2.3*.tar.*
quit
- FIXME: Should the signatures (created by the gnupload script in
- step 29) be uploaded as well ?
+ FIXME: Are the signatures (created by the gnupload script in step 27)
+ needed ? [The above commands upload them and nobody has complained,
+ so suggest that they are retained].
29. Update web pages. For sourceware.org:
Create a new documentation folder on the sourceware.org web
- pages as /sourceware/www/sourceware/htdocs/binutils/docs-X.XX.
+ pages as /sourceware/www/sourceware/htdocs/binutils/docs-2.3x.
+
+ sftp sourceware.org
+ cd /sourceware/www/sourceware/htdocs/binutils
+ mkdir docs-2.3x
+ cd docs-2.3x
+ mkdir as
+ mkdir bfd
+ mkdir binutils
+ mkdir gprof
+ mkdir ld
+ cd ../docs-2.3(x-1)
+ get index.html
+
+ Update the (local copy of the) index.html file to point to the
+ new documentation and mention the new version and then upload it.
+
+ cd ../docs-2.3x
+ put index.html
+
Make the html documentation locally with the "make html" command
- and then upload and rename the directories as needed. (sftp
- does not appear to support recursive uploads however, so the
- directories will have to be made by hand). Create an
- index.html file and then edit the docs link to point to the new
- docs-X.XX directory.
-
- Update the index.html file in the directory containing the
- docs-X.XX entries to point to the new documentation and mention
- the new version.
+ (see step 25 above). Then upload and rename the directories as
+ needed. (sftp does not appear to support recursive uploads
+ however, so the directories had to be made by hand, as shown above).
+
+ cd as
+ lcd <build-dir>/gas/doc/as
+ put * {be patient - this takes a long time...}
+ lcd ..
+ cd ..
+ put as.html
+ put as.pdf
+ cd bfd
+ lcd ../../bfd/doc/bfd
+ put *
+ cd ..
+ lcd ..
+ put bfd.html
+ put bfd.pdf
+ cd binutils
+ lcd ../../binutils/binutils <=== NB/ Path not like others
+ put *
+ cd ..
+ lcd ../doc
+ put binutils.html
+ put binutils.pdf
+ cd gprof
+ lcd ../../gprof/doc/gprof
+ put *
+ cd ..
+ lcd ../..
+ put gprof.html
+ put gprof.pdf
+ cd ld
+ lcd ../ld/doc/ld
+ put *
+ cd ..
+ lcd ../..
+ put ld.html
+ put ld.pdf
+
+ Edit the top level binutils index.html file to change the links
+ to point to the new documentation.
+
+ cd ../..
+ get index.html
+ [edit]
+ put index.html
+ rm docs
+ ln -s docs-2.3x docs
+ quit
+ Check that the new web page is correct:
+
+ https://sourceware.org/binutils/
+
For the www.gnu.org site you have to email webmasters@gnu.org
- and ask them to make the change(s).
+ and ask them to make the change(s):
+---------------------------------------
+Hi FSF Webmasters,
+
+ Please could the GNU Binutils webpage at:
+
+https://www.gnu.org/software/binutils/binutils.html
+
+ be updated to indicate that there is now a newer version available
+ (2.3x). I have already updated the related page on the sourceware
+ website so this might be useful as a template:
+
+https://sourceware.org/binutils/
+
+ Thanks very much.
+
+Cheers
+--------------------------------------
30. Send emails to binutils@sourceware.org, info-gnu@gnu.org and
David Edelsohn <dje.gcc@gmail.com> announcing the new release.
- Sign the email and include the checksum.
+ Sign the email and include the checksum:
+
+ sha256sum binutils-2.3*.tar.*
+
(The email to Davis is so that he can update the GNU Toolchain
social media). Something like this:
- ------------------------------------------------------------------------
+ -----------------------------------------------------------------------
Hi Everyone,
- We are pleased to announce that version 2.XX of the GNU Binutils project
+ We are pleased to announce that version 2.3x of the GNU Binutils project
sources have been released and are now available for download at:
https://ftp.gnu.org/gnu/binutils
checksums: xxxx
- This release contains numerous bug fixes, and also the
- following new features:
+ This release contains numerous bug fixes, and also the
+ following new features:
<extract info from the NEWS files>
- Our thanks go out to all of the binutils contributors, past and
- present, for helping to make this release possible.
+ For more information see:
+
+ https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;a=blob_plain;f=gas/NEWS;;hb=refs/tags/binutils-2_39
+ https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;a=blob_plain;f=ld/NEWS;hb=refs/tags/binutils-2_39
+ https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;a=blob_plain;f=binutils/NEWS;hb=refs/tags/binutils-2_39
+
+ Our thanks go out to all of the binutils contributors, past and
+ present, for helping to make this release possible.
- --------------------------------------------------------------------------
+ -----------------------------------------------------------------------
- 31. Clean up the source tree. (Use "git status" to find new
- files, and remove them).
+ 31. Clean up the source tree:
- 32. Edit bfd/development.sh on the branch and set
- "development=true". Also bump the version in bfd/version.m4 by
- adding a trailing .0, so that the date suffix keeps the version
- lower than the trunk version. Regenerate files. Commit these
- changes.
+ git clean -fdx .
- 33. Email the binutils list telling everyone that the 2.31 branch
- is now open for business as usual and that patched no longer
+ 32. Edit bfd/development.sh on the branch and set the development flag
+ to "true". (Leave the experimental flag set to "false"). Also bump
+ the version in bfd/version.m4 by adding a trailing .0, so that the
+ date suffix keeps the version lower than the trunk version.
+ Regenerate files. Commit these changes.
+
+ 33. Email the binutils list telling everyone that the 2.3x branch
+ is now open for business as usual and that patches no longer
need special approval.
-
--------------------------------------------------
-How to perform a point release.
--------------------------------------------------
+
+ 34. Examine the bfd/config.bfd file in the mainline sources and move
+ any pending obsolete targets into the definitely obsolete
+ section. Create a changelog entry and commit.
+
+
+
+
+--------------------------------------------------------------------------
+How to perform a POINT release.
+--------------------------------------------------------------------------
A point release is easier than a normal release since a lot of the
work has already been done. The branch has been created, the
3. In the branch sources:
a. Update the minor release number in bfd/version.m4.
- b. Edit bfd/development.sh, set "development=false" and
- "experimental=false".
+ b. Edit bfd/development.sh, set "development=false".
c. Regenerate the configure files.
- c.1. Remove spurious autom4te.cache files:
+ d. Remove spurious autom4te.cache files:
- find . -depth -name autom4te.cache -exec rm -r {} \;
+ git clean -fdx
- d. Commit the updates along with a "this-is-the-2.XX.X-release"
+ e. Commit the updates along with a "this-is-the-2.3x.y-release"
note in all of the changelogs.
- e. Tag the branch with the new release number:
+ f. Tag the branch with the new release number:
- git tag -a binutils-2_XX_X
+ git tag -a binutils-2_3x_y
[optional: add "-u XXXXX" to sign with a gpg key]
- git push origin binutils-2_XX_X
+ git push origin binutils-2_3x_y
- f. Check that your file creation mask will create the
- correct file permissions. Eg:
+ g. Check that your file creation mask will create the
+ correct file permissions. Ie:
umask 022
- g. Create the release tarballs:
+ h. Create the release tarballs:
+
./src-release -b -g -l -x binutils
- h. Check that the files in the tarballs have the correct
+ i. Check that the files in the tarballs have the correct
permissions.
- i. Edit bfd/development.sh and set "development=true".
- j. Commit this change into the git repository.
- k. Clean up the source tree. (Use "git status" to find new
- files, and remove them).
+ j. Clean the source tree again
+
+ git clean -fdx
+
+ k. Edit bfd/development.sh and set "development=true".
+ l. Commit this change.
4. [If paranoid - upload the tarballs to one of the FTP servers and
ask people to test it before going on to step 5].
5. Upload the tarballs to ftp.gnu.org.
- gnupload --to ftp.gnu.org:binutils binutils-X.XX.X.tar.*
+ gnupload --to ftp.gnu.org:binutils binutils-*.tar.*
The gnupload script is in the gnulib/build-aux directory.
sftp sourceware.org
cd /sourceware/ftp/pub/binutils/releases
- put binutils-X.XX.X.tar.*
- chmod 644 binutils-X.XX.X.tar.*
+ put binutils-*.tar.*
+ chmod 644 binutils-*.tar.*
quit
It is OK to upload the signatures as well.
* Log on to sourceware.org
* Go to /sourceware/www/sourceware/htdocs/binutils
- * Edit index.html
+ * Edit index.html and update the latest release number (if this is a latest release)
For the www.gnu.org site you have to email webmasters@gnu.org
and ask them to make the change(s).
David Edelsohn <dje.gcc@gmail.com> announcing the new release.
(The email to Davis is so that he can update the GNU Toolchain
social media). Something like this:
+
------------------------------------------------------------------------
Hi Everyone,
- We are pleased to announce that version 2.XX.X of the GNU Binutils
+ We are pleased to announce that version 2.3x.y of the GNU Binutils
project sources have been released and are now available for download at:
https://ftp.gnu.org/gnu/binutils
https://sourceware.org/pub/binutils/releases/
- This is a point release over the previous 2.XX version, containing bug
+ This is a point release over the previous 2.3x version, containing bug
fixes but no new features.
Our thanks go out to all of the binutils contributors, past and
xx
--------------------------------------------------------------------------
+ 9. Create a new Bugzilla entry for the point release.
+
+ https://sourceware.org/bugzilla/editversions.cgi?product=binutils
+
+ And a new milestone too:
+
+ https://sourceware.org/bugzilla/editmilestones.cgi?product=binutils
\f
-Copyright (C) 2017-2019 Free Software Foundation, Inc.
+Copyright (C) 2017-2022 Free Software Foundation, Inc.
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
projects / binutils-gdb.git / blobdiff