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 configure files.
29 3. When branch day arrives add markers for the upcoming release to
30 the NEWS files in gas, ld, gold and binutils.
32 Likewise for the ChangeLog files in: bfd, binutils, config, cpu,
33 elfcpp, gas, gold, gprof, include, ld, opcodes and toplevel.
35 Add a note of the name of the new branch to binutils/BRANCHES.
39 4. Create the release branch using:
41 git branch binutils-2_33-branch
42 git push origin binutils-2_33-branch
44 If you get a message like:
46 remote: fatal: Invalid revision range 0000000000000000000000000000000000000000..f974f26cb16cc6fe3946f163c787a05e713fb77b
48 It appears that this can be ignored...
50 5. Make sure that the branch is there. IE check out the branch sources:
52 git clone ssh://sourceware.org/git/binutils-gdb.git -b binutils-2_33-branch 2.33
54 If you get a message about being in a "detached head" state, something
57 Keep the checked out sources - they are going to be needed in future
60 6. Update "BINUTILS_BRANCH" in gdbadmin's crontab:
62 Log in as gdbadmin on sourceware.org, and then:
66 [change BINUTILS_BRANCH]
70 If you do not have access to this account, please feel free to
71 ask Joel Brobecker <brobecker AT adacore DOT com>.
73 7. Rename the current HEAD version entry in Bugzilla, and create a
74 new one. E.g. rename "2.33 (HEAD)" to 2.33, and create "2.34
77 https://sourceware.org/bugzilla/editversions.cgi?product=binutils
79 8. Update bfd/version.m4 on HEAD to indicate that is now a snapshot
82 m4_define([BFD_VERSION], [2.33.51])
84 Update the release number in bfd/version.m4 for the branch.
85 The branch only needs the point value set to 90 as the release
86 has not actually happened yet.
88 m4_define([BFD_VERSION], [2.32.90])
90 Regenerate various files on both branch and HEAD by configuring
91 with "--enable-maintainer-mode --enable-gold" and then building
92 with "make all-binutils all-gas all-gold all-gprof all-ld"
94 Add ChangeLog entries for the updated files. Commit the changes.
95 Make sure that this includes the .pot files as well as the
96 configure and makefiles.
98 8. Create an initial pre-release:
100 a. Remove any auto-generated files, in order to force the
101 src-release script to rebuild them.
106 b. Create a source tarball of the BRANCH sources:
108 ./src-release -x binutils
110 c. Build a test target using this tarball.
112 cp binutils-<version>.tar.xz /dev/shm
114 tar xvf binutils-<version>.tar.xz
117 ../<version>/configure --quiet --enable-gold
120 If there are problems, fix them.
122 d. Upload the pre-release snapshot to the sourceware FTP site:
125 scp binutils-<version>.tar.xz sourceware.org:~ftp/pub/binutils/snapshots
126 ssh sourceware.org md5sum ~ftp/pub/binutils/snapshots/binutils-<version>.tar.xz
128 e. Clean up the source directory again.
132 9. Tell the Translation Project where to find the new tarball.
133 <coordinator@translationproject.org>
134 qv: http://translationproject.org/html/maintainers.html
136 ------------------------------------------------------------------------
137 Dear Translation Project
139 The 2.3x release branch has been created for the FSF binutils.
141 A snapshot of the branch sources can be found here:
143 https://sourceware.org/pub/binutils/snapshots/binutils-2.3x.90.tar.xz
145 We hope to make the official release of the sources on the 8th July
146 although that could change if there are important bugs that need to
147 be fixed before the release.
148 ------------------------------------------------------------------------
150 10. Announce the availability of the snapshot and the branch on the
151 binutils mailing list. Set a date for when the release will
152 actually happen. Something like:
154 ------------------------------------------------------------------------
157 The 2.3x branch has now been created:
159 git clone git://sourceware.org/git/binutils-gdb.git -b binutils-2_3x-branch 2.3x
161 A snapshot of the sources is also available here:
163 https://sourceware.org/pub/binutils/snapshots/binutils-2.3x.90.tar.xz
165 Please could all patches for the branch be run by me.
166 The rules for the branch are:
169 * Target specific bug fixes are OK.
170 * Generic bug fixes are OK if they are important and widely tested.
171 * Documentation updates/fixes are OK.
172 * Translation updates are OK.
173 * Fixes for testsuite failures are OK.
175 Ideally I would like to make the release happen in two weeks time,
176 i.e. Saturday 27th Jan. Which I hope will be enough time for everyone
177 to get their final fixes in.
178 ------------------------------------------------------------------------
180 11. Build various different toolchains, test them and nag
181 maintainers to fix any testsuite failures for their
185 When the time comes to actually make the release....
188 20. Make sure that the branch sources still build, test and install
189 correctly. Make sure that the sources are clean, without any
190 patch files (.reg .orig *~) left over.
195 21. Update the release number in bfd/version.m4 on the release
196 branch to a whole new minor version number, without a point
197 value. Eg "2.29.90" becomes "2.30". Change bfd/development.sh
198 to set all values to "false". Regenerate the configure and
199 makefiles. And *info* files. Add ChangeLog entries for the
200 updates and add a "this-is-the-2.3x-release" comment and
203 22. Check that your file creation mask will create the
204 correct file permissions. Eg:
209 Remove any spurious autom4te.cache files left over from the
212 % find . -depth -name autom4te.cache -exec rm -r {} \;
214 23. Note - check to see if any new files have been added to the top
215 level of the source directory, but which are not in the
216 DEVO_SUPPORT variable in the src-release.sh script. If they are
217 needed then add them.
219 Create the release tarballs:
221 ./src-release.sh -b -g -l -x binutils
223 24. Check that the files in the tarballs have the correct
226 25. Sanity check the release on x86_64-pc-linux-gnu by building and
227 running the testsuites (gas, gold, binutils and ld). Make the
228 source directory read-only before building. Also test
229 "make install". If necessary fix any problems.
231 26. Tag the branch with the new release number:
233 git tag -a binutils-2_3x
234 [optional: add "-u XXXXX" to sign with a gpg key]
235 git push origin binutils-2_3x
237 NB/ If you do sign the binaries make sure to use a key
238 that has been published with the FSF.
240 27. Upload the tarballs to ftp.gnu.org.
242 gnupload --to ftp.gnu.org:binutils binutils-2.3x.tar.*
244 The gnupload script is in the gnulib/build-aux directory.
246 Check for an email response from the upload. If necessary
249 28. Upload the tarballs (and signatures) to sourceware.org:
252 cd /sourceware/ftp/pub/binutils/releases
253 put binutils-2.3x.tar.*
254 chmod 644 binutils-2.3x.tar.*
257 FIXME: Should the signatures (created by the gnupload script in
258 step 29) be uploaded as well ?
260 29. Update web pages. For sourceware.org:
262 Create a new documentation folder on the sourceware.org web
263 pages as /sourceware/www/sourceware/htdocs/binutils/docs-2.3x.
266 cd /sourceware/www/sourceware/htdocs/binutils
269 mkdir as bfd binutils gprof ld
273 Update the (local copy of the) index.html file to point to the
274 new documentation and mention the new version and then upload it.
279 Make the html documentation locally with the "make html" command
280 and then upload and rename the directories as needed. (sftp
281 does not appear to support recursive uploads however, so the
282 directories will have to be made by hand).
285 lcd <build-dir>/gas/doc/as.html
288 lcd ../../../bfd/doc/bfd.html
291 lcd ../../../binutils/doc/binutils.html
294 lcd ../../../gprof/gprof.html
300 Edit the top level binutils index.html file to change the links
301 to the new documentation.
309 Check that the new web page is correct.
311 For the www.gnu.org site you have to email webmasters@gnu.org
312 and ask them to make the change(s).
314 30. Send emails to binutils@sourceware.org, info-gnu@gnu.org and
315 David Edelsohn <dje.gcc@gmail.com> announcing the new release.
316 Sign the email and include the checksum.
317 (The email to Davis is so that he can update the GNU Toolchain
318 social media). Something like this:
319 -----------------------------------------------------------------------
322 We are pleased to announce that version 2.3x of the GNU Binutils project
323 sources have been released and are now available for download at:
325 https://ftp.gnu.org/gnu/binutils
326 https://sourceware.org/pub/binutils/releases/
330 This release contains numerous bug fixes, and also the
331 following new features:
333 <extract info from the NEWS files>
335 Our thanks go out to all of the binutils contributors, past and
336 present, for helping to make this release possible.
338 -----------------------------------------------------------------------
340 31. Clean up the source tree:
344 32. Edit bfd/development.sh on the branch and set the development flag
345 to "true". (Leave the experimental flag set to "false"). Also bump
346 the version in bfd/version.m4 by adding a trailing .0, so that the
347 date suffix keeps the version lower than the trunk version.
348 Regenerate files. Commit these changes.
350 33. Email the binutils list telling everyone that the 2.3x branch
351 is now open for business as usual and that patched no longer
352 need special approval.
354 34. Examine the bfd/config.bfd file and move any pending obsolete
355 targets into the definitely obsolete section. Create a
356 changelog entry and commit.
358 -------------------------------------------------
359 How to perform a point release.
360 -------------------------------------------------
362 A point release is easier than a normal release since a lot of the
363 work has already been done. The branch has been created, the
364 translations updated and the documentation uploaded. So the procedure
367 0. Decide that a point release is necessary.
369 Usually this only happens when a sufficient number of serious
370 bugs have been found and fixed since the previous release, and a
371 new official release is not imminent.
373 1. Tell the community that a point release is happening. Ask
374 maintainers to ensure that their ports are up to date on the
375 release branch. Ask the community if there are any bug fixes
376 which are missing from the branch. Allow some time for the
377 responses to this step.
379 2. Make sure that the branch sources build, test and install
382 2.5 Prepare a list of the bugs which have been fixed. This
383 will be needed for step 8.
385 3. In the branch sources:
387 a. Update the minor release number in bfd/version.m4.
388 b. Edit bfd/development.sh, set "development=false".
389 c. Regenerate the configure files.
390 c.1. Remove spurious autom4te.cache files:
392 find . -depth -name autom4te.cache -exec rm -r {} \;
394 d. Commit the updates along with a "this-is-the-2.3x.y-release"
395 note in all of the changelogs.
396 e. Tag the branch with the new release number:
398 git tag -a binutils-2_3x_y
399 [optional: add "-u XXXXX" to sign with a gpg key]
400 git push origin binutils-2_3x_y
402 f. Check that your file creation mask will create the
403 correct file permissions. Eg:
407 g. Create the release tarballs:
409 ./src-release -b -g -l -x binutils
411 h. Check that the files in the tarballs have the correct
414 i. Edit bfd/development.sh and set "development=true".
415 j. Commit this change into the git repository.
416 k. Clean up the source tree.
420 4. [If paranoid - upload the tarballs to one of the FTP servers and
421 ask people to test it before going on to step 5].
423 5. Upload the tarballs to ftp.gnu.org.
425 gnupload --to ftp.gnu.org:binutils binutils-2.3x.y.tar.*
427 The gnupload script is in the gnulib/build-aux directory.
429 6. Upload the tarballs to sourceware.org:
432 cd /sourceware/ftp/pub/binutils/releases
433 put binutils-2.3x.y.tar.*
434 chmod 644 binutils-2.3x.y.tar.*
437 It is OK to upload the signatures as well.
439 7. Update web pages. For sourceware.org:
441 * Log on to sourceware.org
442 * Go to /sourceware/www/sourceware/htdocs/binutils
445 For the www.gnu.org site you have to email webmasters@gnu.org
446 and ask them to make the change(s).
448 8. Send an emails to the binutils list, info-gnu@gnu.org and
449 David Edelsohn <dje.gcc@gmail.com> announcing the new release.
450 (The email to Davis is so that he can update the GNU Toolchain
451 social media). Something like this:
452 ------------------------------------------------------------------------
455 We are pleased to announce that version 2.3x.y of the GNU Binutils
456 project sources have been released and are now available for download at:
458 https://ftp.gnu.org/gnu/binutils
459 https://sourceware.org/pub/binutils/releases/
461 This is a point release over the previous 2.3x version, containing bug
462 fixes but no new features.
464 Our thanks go out to all of the binutils contributors, past and
465 present, for helping to make this release possible.
467 Here is a list of the bugs that have been fixed:
472 --------------------------------------------------------------------------
475 Copyright (C) 2017-2019 Free Software Foundation, Inc.
477 Copying and distribution of this file, with or without modification,
478 are permitted in any medium without royalty provided the copyright
479 notice and this notice are preserved.