1 README for MAKING BINUTILS RELEASES
3 This is a collection of notes on how to perform a binutils release. A
4 lot of this information can also be found in the maintain.texi file in
7 https://www.gnu.org/software/gnulib/
9 It is useful to have a cloned copy of the sources of this project as
10 it also contains an upload script used to install tarballs on the GNU
13 Make sure that you have upload authority on sourceware and fencepost.
14 Beware - this is an involved process and can take weeks to complete.
15 See the maintain.texi file for details on how to obtain these
18 -------------------------------------------------
19 How to perform a release.
20 -------------------------------------------------
22 1. Send an email out warning contributors about the forthcoming
23 branch. Set a date for the branch (weekends are better because
26 2. When the branch date is near: Update the libiberty and config
27 directories and the top level Makefile and configure files. Also
28 consider updating the toplevel libtool files.
31 Approx time to complete from here: 2 hours ....
33 3. When branch day arrives add markers for the upcoming release to
34 the NEWS files in gas, ld, and binutils. No need to update NEWS
35 in the gold directory - it has its own release numbering.
37 Likewise for the ChangeLog files in: bfd, binutils, config, cpu,
38 elfcpp, gas, gold, gprof, include, ld, libctf, opcodes and toplevel.
40 Add a note of the name of the new branch to binutils/BRANCHES.
44 4. Create the release branch using:
46 git branch binutils-2_37-branch
47 git push origin binutils-2_37-branch
49 If you get a message like:
51 remote: fatal: Invalid revision range 0000000000000000000000000000000000000000..f974f26cb16cc6fe3946f163c787a05e713fb77b
53 It appears that this can be ignored...
55 5. Make sure that the branch is there. IE check out the branch sources:
57 git clone ssh://sourceware.org/git/binutils-gdb.git -b binutils-2_37-branch 2.37
59 If you get a message about being in a "detached head" state, something
62 Keep the checked out sources - they are going to be needed in future
65 6. Update "BINUTILS_BRANCH" in gdbadmin's crontab:
67 Log in as gdbadmin on sourceware.org, and then:
71 [change BINUTILS_BRANCH]
75 If you do not have access to this account, please feel free to
76 ask Joel Brobecker <brobecker AT adacore DOT com>.
78 7. Rename the current HEAD version entry in Bugzilla, and create a
79 new one. E.g. rename "2.37 (HEAD)" to 2.37, and create
82 https://sourceware.org/bugzilla/editversions.cgi?product=binutils
84 8. Update bfd/version.m4 on HEAD to indicate that is now a snapshot
87 m4_define([BFD_VERSION], [2.37.50])
89 Update the release number in bfd/version.m4 for the BRANCH.
90 The branch only needs the point value set to 90 as the release
91 has not actually happened yet.
93 m4_define([BFD_VERSION], [2.36.90])
95 Regenerate various files on both branch and HEAD by configuring
96 with "--enable-maintainer-mode --enable-gold" and then building
97 with "make all-binutils all-gas all-gold all-gprof all-ld"
99 Add ChangeLog entries for the updated files. Commit the changes.
100 Make sure that this includes the .pot files as well as the
101 configure and makefiles.
103 9. Create an initial pre-release:
105 a. Remove any auto-generated files, in order to force the
106 src-release script to rebuild them.
111 b. Create a source tarball of the BRANCH sources:
113 ./src-release -x binutils
115 c. Build a test target using this tarball.
117 cp binutils-2.36.90.tar.xz /dev/shm
119 tar xvf binutils-2.36.90.tar.xz
122 ../binutils-2.36.90/configure --quiet --enable-gold
126 If there are problems, fix them.
128 d. Upload the pre-release snapshot to the sourceware FTP site:
130 scp binutils-2.36.90.tar.xz sourceware.org:~ftp/pub/binutils/snapshots
131 ssh sourceware.org sha256sum ~ftp/pub/binutils/snapshots/binutils-2.36.90.tar.xz
133 e. Clean up the source directory again.
137 10. Tell the Translation Project where to find the new tarball.
138 <coordinator@translationproject.org>
139 qv: https://translationproject.org/html/maintainers.html
141 ------------------------------------------------------------------------
142 Dear Translation Project
144 The <NEW_VERSION> release branch has been created for the GNU binutils.
146 A snapshot of the branch sources can be found here:
148 https://sourceware.org/pub/binutils/snapshots/binutils-<OLD_VERSION>.90.tar.xz
150 We hope to make the official release of the sources on the <DATE>
151 although that could change if there are important bugs that need to
152 be fixed before the release.
153 ------------------------------------------------------------------------
155 11. Announce the availability of the snapshot and the branch on the
156 binutils mailing list. Set a date for when the release will
157 actually happen. Something like:
159 ------------------------------------------------------------------------
162 The <NEW_VERSION> branch has now been created:
164 git clone git://sourceware.org/git/binutils-gdb.git -b binutils-<NEW_VERSION>-branch <NEW_VERSION>
166 A snapshot of the sources is also available here:
168 https://sourceware.org/pub/binutils/snapshots/binutils-<OLD_VERSION>.90.tar.xz
170 Please could all patches for the branch be run by me.
171 The rules for the branch are:
174 * Target specific bug fixes are OK.
175 * Generic bug fixes are OK if they are important and widely tested.
176 * Documentation updates/fixes are OK.
177 * Translation updates are OK.
178 * Fixes for testsuite failures are OK.
180 Ideally I would like to make the release happen in two weeks time,
181 i.e. <DATE>. Which I hope will be enough time for everyone
182 to get their final fixes in.
183 ------------------------------------------------------------------------
185 12. Build various different toolchains, test them and nag
186 maintainers to fix any testsuite failures for their
189 ==============================================================================
191 When the time comes to actually make the release....
194 20. Make sure that the branch sources still build, test and install
195 correctly. Make sure that the sources are clean, without any
196 patch files (.reg .orig *~) left over.
201 21. Update the release number in bfd/version.m4 on the release
202 branch to a whole new minor version number, without a point
203 value. Eg "2.36.90" becomes "2.37". Change bfd/development.sh
204 to set all values to "false". Regenerate the configure and
205 makefiles. And *info* files. Add ChangeLog entries for the
206 updates and add a "this-is-the-2.3x-release" comment and
209 22. Check that your file creation mask will create the
210 correct file permissions. Eg:
215 Remove any spurious autom4te.cache files left over from the
220 23. Note - check to see if any new files have been added to the top
221 level of the source directory, but which are not in the
222 DEVO_SUPPORT variable in the src-release.sh script. If they are
223 needed then add them.
225 Create the release tarballs:
227 ./src-release.sh -b -g -l -x binutils
229 24. Check that the files in the tarballs have the correct
230 permissions. (FIXME: How to do this ?)
232 25. Sanity check the release on x86_64-pc-linux-gnu by building and
233 running the testsuites (gas, gold, binutils and ld). Make the
234 source directory read-only before building. Also test
235 "make install". If necessary fix any problems.
240 tar xvf <path-to-sources>/binutils-2.*.tar.xz
241 chmod -R -w binutils-2.*
244 ../binutils-2.X/configure --enable-gold --prefix=`pwd`/install --enable-plugins
245 make all-gas all-gold all-ld all-binutils all-gprof
246 make check-gas check-binutils check-ld check-gold
247 make install-gas install-gold install-ld install-binutils
249 # Needed for step 29...
252 26. Tag the branch with the new release number:
254 git tag -a binutils-2_3x <=== Be careful to get the tag right
255 [optional: add "-u XXXXX" to sign with a gpg key]
256 enter a tag message such as: "Official Binutils 2.3x release"
258 NB/ If you do sign the binaries make sure to use a key
259 that has been published with the FSF.
261 Then push the release:
263 git push origin binutils-2_3x
265 If you get an error message along the lines of "Invalid revision range ..." you can ignore it.
267 27. Upload the tarballs to ftp.gnu.org.
269 gnupload --to ftp.gnu.org:binutils binutils-2.3*.tar.*
271 Be prepared to provide the password for the key, if you signed the binaries.
273 The gnupload script is in the gnulib/build-aux directory.
275 Check for an email response from the upload. If necessary
278 28. Upload the tarballs (and signatures) to sourceware.org:
281 cd /sourceware/ftp/pub/binutils/releases
282 put binutils-2.3*.tar.*
283 chmod 644 binutils-2.3x.tar.*
286 FIXME: Are the signatures (created by the gnupload script in step 27) needed ?
287 [The above commands upload them and nobody has complained, so suggest that they
290 29. Update web pages. For sourceware.org:
292 Create a new documentation folder on the sourceware.org web
293 pages as /sourceware/www/sourceware/htdocs/binutils/docs-2.3x.
296 cd /sourceware/www/sourceware/htdocs/binutils
307 Update the (local copy of the) index.html file to point to the
308 new documentation and mention the new version and then upload it.
313 Make the html documentation locally with the "make html" command
314 (see step 25 above). Then upload and rename the directories as
315 needed. (sftp does not appear to support recursive uploads
316 however, so the directories had to be made by hand, as shown above).
319 lcd <build-dir>/gas/doc/as.html
320 put * {be patient - this takes a long time...}
322 lcd ../../../bfd/doc/bfd.html
325 lcd ../../../binutils/doc/binutils.html
328 lcd ../../../gprof/gprof.html
334 Edit the top level binutils index.html file to change the links
335 to point to the new documentation.
345 Check that the new web page is correct:
347 https://sourceware.org/binutils/
349 For the www.gnu.org site you have to email webmasters@gnu.org
350 and ask them to make the change(s):
351 ---------------------------------------
354 Please could the GNU Binutils webpage at:
356 https://www.gnu.org/software/binutils/binutils.html
358 be updated to indicate that there is now a newer version available
359 (2.3x). I have already updated the related page on the sourceware
360 website so this might be useful as a template:
362 https://sourceware.org/binutils/
367 --------------------------------------
369 30. Send emails to binutils@sourceware.org, info-gnu@gnu.org and
370 David Edelsohn <dje.gcc@gmail.com> announcing the new release.
371 Sign the email and include the checksum:
373 sha256sum binutils-2.3*.tar.*
375 (The email to Davis is so that he can update the GNU Toolchain
376 social media). Something like this:
377 -----------------------------------------------------------------------
380 We are pleased to announce that version 2.3x of the GNU Binutils project
381 sources have been released and are now available for download at:
383 https://ftp.gnu.org/gnu/binutils
384 https://sourceware.org/pub/binutils/releases/
388 This release contains numerous bug fixes, and also the
389 following new features:
391 <extract info from the NEWS files>
393 Our thanks go out to all of the binutils contributors, past and
394 present, for helping to make this release possible.
396 -----------------------------------------------------------------------
398 31. Clean up the source tree:
402 32. Edit bfd/development.sh on the branch and set the development flag
403 to "true". (Leave the experimental flag set to "false"). Also bump
404 the version in bfd/version.m4 by adding a trailing .0, so that the
405 date suffix keeps the version lower than the trunk version.
406 Regenerate files. Commit these changes.
408 33. Email the binutils list telling everyone that the 2.3x branch
409 is now open for business as usual and that patches no longer
410 need special approval.
412 34. Examine the bfd/config.bfd file in the mainline sources and move
413 any pending obsolete targets into the definitely obsolete
414 section. Create a changelog entry and commit.
419 --------------------------------------------------------------------------
420 How to perform a POINT release.
421 --------------------------------------------------------------------------
423 A point release is easier than a normal release since a lot of the
424 work has already been done. The branch has been created, the
425 translations updated and the documentation uploaded. So the procedure
428 0. Decide that a point release is necessary.
430 Usually this only happens when a sufficient number of serious
431 bugs have been found and fixed since the previous release, and a
432 new official release is not imminent.
434 1. Tell the community that a point release is happening. Ask
435 maintainers to ensure that their ports are up to date on the
436 release branch. Ask the community if there are any bug fixes
437 which are missing from the branch. Allow some time for the
438 responses to this step.
440 2. Make sure that the branch sources build, test and install
443 2.5 Prepare a list of the bugs which have been fixed. This
444 will be needed for step 8.
446 3. In the branch sources:
448 a. Update the minor release number in bfd/version.m4.
449 b. Edit bfd/development.sh, set "development=false".
450 c. Regenerate the configure files.
451 d. Remove spurious autom4te.cache files:
455 e. Commit the updates along with a "this-is-the-2.3x.y-release"
456 note in all of the changelogs.
457 f. Tag the branch with the new release number:
459 git tag -a binutils-2_3x_y
460 [optional: add "-u XXXXX" to sign with a gpg key]
461 git push origin binutils-2_3x_y
463 g. Check that your file creation mask will create the
464 correct file permissions. Ie:
468 h. Create the release tarballs:
470 ./src-release -b -g -l -x binutils
472 i. Check that the files in the tarballs have the correct
475 j. Clean the source tree again
479 k. Edit bfd/development.sh and set "development=true".
480 l. Commit this change.
482 4. [If paranoid - upload the tarballs to one of the FTP servers and
483 ask people to test it before going on to step 5].
485 5. Upload the tarballs to ftp.gnu.org.
487 gnupload --to ftp.gnu.org:binutils binutils-*.tar.*
489 The gnupload script is in the gnulib/build-aux directory.
491 6. Upload the tarballs to sourceware.org:
494 cd /sourceware/ftp/pub/binutils/releases
496 chmod 644 binutils-*.tar.*
499 It is OK to upload the signatures as well.
501 7. Update web pages. For sourceware.org:
503 * Log on to sourceware.org
504 * Go to /sourceware/www/sourceware/htdocs/binutils
505 * Edit index.html and update the latest release number (if this is a latest release)
507 For the www.gnu.org site you have to email webmasters@gnu.org
508 and ask them to make the change(s).
510 8. Send an emails to the binutils list, info-gnu@gnu.org and
511 David Edelsohn <dje.gcc@gmail.com> announcing the new release.
512 (The email to Davis is so that he can update the GNU Toolchain
513 social media). Something like this:
515 ------------------------------------------------------------------------
518 We are pleased to announce that version 2.3x.y of the GNU Binutils
519 project sources have been released and are now available for download at:
521 https://ftp.gnu.org/gnu/binutils
522 https://sourceware.org/pub/binutils/releases/
524 This is a point release over the previous 2.3x version, containing bug
525 fixes but no new features.
527 Our thanks go out to all of the binutils contributors, past and
528 present, for helping to make this release possible.
530 Here is a list of the bugs that have been fixed:
535 --------------------------------------------------------------------------
537 9. Create a new Bugzilla entry for the point release.
539 https://sourceware.org/bugzilla/editversions.cgi?product=binutils
541 And a new milestone too:
543 https://sourceware.org/bugzilla/editmilestones.cgi?product=binutils
545 Copyright (C) 2017-2021 Free Software Foundation, Inc.
547 Copying and distribution of this file, with or without modification,
548 are permitted in any medium without royalty provided the copyright
549 notice and this notice are preserved.