binutils/README-how-to-make-a-release

   1                 README for MAKING BINUTILS RELEASES
   2
   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
   5 the gnulib project:
   6
   7   https://www.gnu.org/software/gnulib/
   8
   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
  11 FTP server.
  12
  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
  16 permissions.
  17
  18 -------------------------------------------------
  19 How to perform a release.
  20 -------------------------------------------------
  21
  22   1. Send an email out warning contributors about the forthcoming
  23      branch.  Set a date for the branch (weekends are better because
  24      they are less busy).
  25
  26   2. When the branch date is near:  Update the libiberty and config
  27      directories and the top level configure files.
  28
  29   3. When branch day arrives add markers for the upcoming release to
  30      the NEWS files in gas, ld, gold and binutils.
  31
  32      Likewise for the ChangeLog files in: bfd, binutils, config, cpu,
  33      elfcpp, gas, gold, gprof, include, ld, libctf, opcodes and toplevel.
  34
  35      Add a note of the name of the new branch to binutils/BRANCHES.
  36
  37      Commit these changes.
  38
  39   4. Create the release branch using:
  40
  41         git branch binutils-2_33-branch
  42         git push origin binutils-2_33-branch
  43
  44      If you get a message like:
  45
  46        remote: fatal: Invalid revision range 0000000000000000000000000000000000000000..f974f26cb16cc6fe3946f163c787a05e713fb77b
  47
  48      It appears that this can be ignored...
  49
  50   5. Make sure that the branch is there.  IE check out the branch sources:
  51
  52         git clone ssh://sourceware.org/git/binutils-gdb.git -b binutils-2_33-branch 2.33
  53
  54      If you get a message about being in a "detached head" state, something
  55      has gone wrong...
  56
  57      Keep the checked out sources - they are going to be needed in future
  58      steps.
  59
  60   6. Update "BINUTILS_BRANCH" in gdbadmin's crontab:
  61
  62      Log in as gdbadmin on sourceware.org, and then:
  63
  64         $ cd crontab
  65         $ vi crontab
  66         [change BINUTILS_BRANCH]
  67         $ cvs ci crontab
  68         $ crontab crontab
  69
  70      If you do not have access to this account, please feel free to
  71      ask Joel Brobecker <brobecker AT adacore DOT com>.
  72
  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
  75      (HEAD)":
  76
  77         https://sourceware.org/bugzilla/editversions.cgi?product=binutils
  78
  79   8. Update bfd/version.m4 on HEAD to indicate that is now a snapshot
  80      of the next release:
  81
  82        m4_define([BFD_VERSION], [2.33.51])
  83
  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.
  87
  88        m4_define([BFD_VERSION], [2.32.90])
  89
  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"
  93
  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.
  97
  98   8. Create an initial pre-release:
  99
 100      a. Remove any auto-generated files, in order to force the
 101         src-release script to rebuild them.
 102
 103           cd <branch-sources>
 104           git clean -fdx .
 105
 106      b. Create a source tarball of the BRANCH sources:
 107
 108           ./src-release -x binutils
 109
 110      c. Build a test target using this tarball.
 111
 112            cp binutils-<version>.tar.xz /dev/shm
 113            cd /dev/shm
 114            tar xvf binutils-<version>.tar.xz
 115            mkdir build
 116            cd build
 117            ../<version>/configure --quiet --enable-gold
 118            make
 119
 120         If there are problems, fix them.
 121
 122      d. Upload the pre-release snapshot to the sourceware FTP site:
 123
 124           cd <branch-sources>
 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
 127
 128      e. Clean up the source directory again.
 129
 130          git clean -fdx .
 131
 132    9. Tell the Translation Project where to find the new tarball.
 133       <coordinator@translationproject.org>
 134       qv: http://translationproject.org/html/maintainers.html
 135
 136 ------------------------------------------------------------------------
 137 Dear Translation Project
 138
 139   The 2.3x release branch has been created for the FSF binutils.
 140
 141   A snapshot of the branch sources can be found here:
 142
 143     https://sourceware.org/pub/binutils/snapshots/binutils-2.3x.90.tar.xz
 144
 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 ------------------------------------------------------------------------
 149
 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:
 153
 154 ------------------------------------------------------------------------
 155 Hi Everyone,
 156
 157   The 2.3x branch has now been created:
 158
 159      git clone git://sourceware.org/git/binutils-gdb.git -b binutils-2_3x-branch 2.3x
 160
 161   A snapshot of the sources is also available here:
 162
 163     https://sourceware.org/pub/binutils/snapshots/binutils-2.3x.90.tar.xz
 164
 165   Please could all patches for the branch be run by me.
 166   The rules for the branch are:
 167
 168     * No new features.
 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.
 174
 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 ------------------------------------------------------------------------
 179
 180   11. Build various different toolchains, test them and nag
 181       maintainers to fix any testsuite failures for their
 182       architectures...
 183
 184
 185 When the time comes to actually make the release....
 186
 187
 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.
 191
 192          cd <branch>
 193          git clean -dfx .
 194
 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
 201       commit.
 202
 203   22. Check that your file creation mask will create the
 204       correct file permissions.  Eg:
 205
 206             % umask
 207             22
 208
 209       Remove any spurious autom4te.cache files left over from the
 210       reconfiguring:
 211
 212             % find . -depth -name autom4te.cache -exec rm -r {} \;
 213
 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.
 218
 219        Create the release tarballs:
 220
 221             ./src-release.sh -b -g -l -x binutils
 222
 223   24. Check that the files in the tarballs have the correct
 224       permissions.
 225
 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.
 230
 231   26. Tag the branch with the new release number:
 232
 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
 236
 237         NB/ If you do sign the binaries make sure to use a key
 238         that has been published with the FSF.
 239
 240   27. Upload the tarballs to ftp.gnu.org.
 241
 242        gnupload --to ftp.gnu.org:binutils binutils-2.3x.tar.*
 243
 244       The gnupload script is in the gnulib/build-aux directory.
 245
 246       Check for an email response from the upload.  If necessary
 247       fix any problems.
 248
 249   28. Upload the tarballs (and signatures) to sourceware.org:
 250
 251        sftp sourceware.org
 252          cd /sourceware/ftp/pub/binutils/releases
 253          put binutils-2.3x.tar.*
 254          chmod 644 binutils-2.3x.tar.*
 255          quit
 256
 257       FIXME: Should the signatures (created by the gnupload script in
 258       step 29) be uploaded as well ?
 259
 260   29. Update web pages.  For sourceware.org:
 261
 262       Create a new documentation folder on the sourceware.org web
 263       pages as /sourceware/www/sourceware/htdocs/binutils/docs-2.3x.
 264
 265        sftp sourceware.org
 266          cd /sourceware/www/sourceware/htdocs/binutils
 267          mkdir docs-2.3x
 268          cd docs-2.3x
 269          mkdir as bfd binutils gprof ld
 270          cd ../docs-2.3(x-1)
 271          get index.html
 272
 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.
 275
 276          cd ../docs-2.3x
 277          put index.html
 278
 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).
 283
 284          cd as
 285          lcd <build-dir>/gas/doc/as.html
 286          put *
 287          cd ../bfd
 288          lcd ../../../bfd/doc/bfd.html
 289          put *
 290          cd ../binutils
 291          lcd ../../../binutils/doc/binutils.html
 292          put *
 293          cd ../gprof
 294          lcd ../../../gprof/gprof.html
 295          put *
 296          cd ../ld
 297          lcd ../../ld/ld.html
 298          put *
 299
 300       Edit the top level binutils index.html file to change the links
 301       to the new documentation.
 302
 303          cd ../../..
 304          get index.html
 305          [edit]
 306          put index.html
 307          rm docs
 308          ln -s docs-2.3x docs
 309          quit
 310
 311       Check that the new web page is correct.
 312
 313       For the www.gnu.org site you have to email webmasters@gnu.org
 314       and ask them to make the change(s).
 315
 316   30. Send emails to binutils@sourceware.org, info-gnu@gnu.org and
 317       David Edelsohn <dje.gcc@gmail.com> announcing the new release.
 318       Sign the email and include the checksum.
 319       (The email to Davis is so that he can update the GNU Toolchain
 320       social media).  Something like this:
 321       -----------------------------------------------------------------------
 322         Hi Everyone,
 323
 324         We are pleased to announce that version 2.3x of the GNU Binutils project
 325         sources have been released and are now available for download at:
 326
 327           https://ftp.gnu.org/gnu/binutils
 328           https://sourceware.org/pub/binutils/releases/
 329
 330           checksums: xxxx
 331
 332        This release contains numerous bug fixes, and also the
 333        following new features:
 334
 335           <extract info from the NEWS files>
 336
 337        Our thanks go out to all of the binutils contributors, past and
 338        present, for helping to make this release possible.
 339
 340       -----------------------------------------------------------------------
 341
 342   31. Clean up the source tree:
 343
 344         git clean -fdx .
 345
 346   32. Edit bfd/development.sh on the branch and set the development flag
 347       to "true".  (Leave the experimental flag set to "false").  Also bump
 348       the version in bfd/version.m4 by adding a trailing .0, so that the
 349       date suffix keeps the version lower than the trunk version.
 350       Regenerate files.  Commit these changes.
 351
 352   33. Email the binutils list telling everyone that the 2.3x branch
 353       is now open for business as usual and that patched no longer
 354       need special approval.
 355
 356   34. Examine the bfd/config.bfd file and move any pending obsolete
 357       targets into the definitely obsolete section.  Create a
 358       changelog entry and commit.
 359
 360 -------------------------------------------------
 361 How to perform a point release.
 362 -------------------------------------------------
 363
 364 A point release is easier than a normal release since a lot of the
 365 work has already been done.  The branch has been created, the
 366 translations updated and the documentation uploaded.  So the procedure
 367 looks like this:
 368
 369   0. Decide that a point release is necessary.
 370
 371      Usually this only happens when a sufficient number of serious
 372      bugs have been found and fixed since the previous release, and a
 373      new official release is not imminent.
 374
 375   1. Tell the community that a point release is happening.  Ask
 376      maintainers to ensure that their ports are up to date on the
 377      release branch.  Ask the community if there are any bug fixes
 378      which are missing from the branch.  Allow some time for the
 379      responses to this step.
 380
 381   2. Make sure that the branch sources build, test and install
 382      correctly.
 383
 384   2.5 Prepare a list of the bugs which have been fixed.  This
 385       will be needed for step 8.
 386
 387   3. In the branch sources:
 388
 389        a. Update the minor release number in bfd/version.m4.
 390        b. Edit bfd/development.sh, set "development=false".
 391        c. Regenerate the configure files.
 392        c.1. Remove spurious autom4te.cache files:
 393
 394           find . -depth -name autom4te.cache -exec rm -r {} \;
 395
 396        d. Commit the updates along with a "this-is-the-2.3x.y-release"
 397           note in all of the changelogs.
 398        e. Tag the branch with the new release number:
 399
 400             git tag -a binutils-2_3x_y
 401               [optional: add "-u XXXXX" to sign with a gpg key]
 402             git push origin binutils-2_3x_y
 403
 404        f. Check that your file creation mask will create the
 405           correct file permissions.  Eg:
 406
 407             umask 022
 408
 409        g. Create the release tarballs:
 410
 411             ./src-release -b -g -l -x binutils
 412
 413        h. Check that the files in the tarballs have the correct
 414           permissions.
 415
 416        i. Edit bfd/development.sh and set "development=true".
 417        j. Commit this change into the git repository.
 418        k. Clean up the source tree.
 419
 420             git clean -dfx .
 421
 422   4. [If paranoid - upload the tarballs to one of the FTP servers and
 423       ask people to test it before going on to step 5].
 424
 425   5. Upload the tarballs to ftp.gnu.org.
 426
 427        gnupload --to ftp.gnu.org:binutils binutils-2.3x.y.tar.*
 428
 429      The gnupload script is in the gnulib/build-aux directory.
 430
 431   6. Upload the tarballs to sourceware.org:
 432
 433        sftp sourceware.org
 434          cd /sourceware/ftp/pub/binutils/releases
 435          put binutils-2.3x.y.tar.*
 436          chmod 644 binutils-2.3x.y.tar.*
 437          quit
 438
 439     It is OK to upload the signatures as well.
 440
 441   7. Update web pages.  For sourceware.org:
 442
 443       * Log on to sourceware.org
 444       * Go to /sourceware/www/sourceware/htdocs/binutils
 445       * Edit index.html
 446
 447       For the www.gnu.org site you have to email webmasters@gnu.org
 448       and ask them to make the change(s).
 449
 450   8. Send an emails to the binutils list, info-gnu@gnu.org and
 451      David Edelsohn <dje.gcc@gmail.com> announcing the new release.
 452      (The email to Davis is so that he can update the GNU Toolchain
 453      social media).  Something like this:
 454 ------------------------------------------------------------------------
 455 Hi Everyone,
 456
 457   We are pleased to announce that version 2.3x.y of the GNU Binutils
 458   project sources have been released and are now available for download at:
 459
 460     https://ftp.gnu.org/gnu/binutils
 461     https://sourceware.org/pub/binutils/releases/
 462
 463   This is a point release over the previous 2.3x version, containing bug
 464   fixes but no new features.
 465
 466   Our thanks go out to all of the binutils contributors, past and
 467   present, for helping to make this release possible.
 468
 469   Here is a list of the bugs that have been fixed:
 470     xx
 471     xx
 472     xx
 473     xx
 474 --------------------------------------------------------------------------
 475
 476 \f
 477 Copyright (C) 2017-2019 Free Software Foundation, Inc.
 478
 479 Copying and distribution of this file, with or without modification,
 480 are permitted in any medium without royalty provided the copyright
 481 notice and this notice are preserved.