gdbsupport: re-indent ptrace.m4
[deliverable/binutils-gdb.git] / binutils / README-how-to-make-a-release
index 38edac20ebf939ddf20dc162b0508499fde9331b..db962e2f550b4ad221058a3e36888b4562b7ee11 100644 (file)
@@ -27,10 +27,11 @@ How to perform a release.
      directories and the top level configure files.
 
   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, opcodes and toplevel.
 
      Add a note of the name of the new branch to binutils/BRANCHES.
 
@@ -38,8 +39,8 @@ How to perform a release.
 
   4. Create the release branch using:
 
-       git branch binutils-2_33-branch
-        git push origin binutils-2_33-branch
+       git branch binutils-2_36-branch
+        git push origin binutils-2_36-branch
 
      If you get a message like:
      
@@ -49,7 +50,7 @@ How to perform a release.
 
   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_36-branch 2.36
 
      If you get a message about being in a "detached head" state, something
      has gone wrong...
@@ -71,7 +72,7 @@ How to perform a release.
      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
+     new one.  E.g. rename "2.36 (HEAD)" to 2.36, and create "2.37
      (HEAD)":
      
         https://sourceware.org/bugzilla/editversions.cgi?product=binutils
@@ -79,13 +80,13 @@ How to perform a release.
   8. Update bfd/version.m4 on HEAD to indicate that is now a snapshot
      of the next release:
      
-       m4_define([BFD_VERSION], [2.33.51])
+       m4_define([BFD_VERSION], [2.36.50])
        
-     Update the release number in bfd/version.m4 for the branch.
+     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.
 
-       m4_define([BFD_VERSION], [2.32.90])
+       m4_define([BFD_VERSION], [2.35.90])
 
      Regenerate various files on both branch and HEAD by configuring
      with "--enable-maintainer-mode --enable-gold" and then building
@@ -95,81 +96,72 @@ How to perform a release.
      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 -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
+           cp binutils-<OLD_VERSION>.90.tar.xz /dev/shm
           cd /dev/shm
-          tar xvf binutils-<version>.tar.xz
+          tar xvf binutils-<OLD_VERSION>.90.tar.xz
           mkdir build
           cd build
-          ../<version>/configure --quiet --enable-gold
+          ../binutils-<OLD_VERSION>.90/configure --quiet --enable-gold
           make
 
         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.
+          scp binutils-<OLD_VERSION>.90.tar.xz sourceware.org:~ftp/pub/binutils/snapshots
+          ssh sourceware.org sha256sum ~ftp/pub/binutils/snapshots/binutils-<OLD_VERSION>.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: http://translationproject.org/html/maintainers.html
 
 ------------------------------------------------------------------------
 Dear Translation Project
 
-  The 2.31 release branch has been created for the FSF binutils.
+  The <NEW_VERSION> release branch has been created for the GNU binutils.
 
   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-<OLD_VERSION>.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 <NEW_VERSION>
 
   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:
@@ -182,14 +174,15 @@ Hi Everyone,
     * 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....
 
@@ -199,15 +192,15 @@ When the time comes to actually make the release....
       patch files (.reg .orig *~) left over.
 
          cd <branch>
-        cvsclean | xargs rm
+        git clean -dfx .
 
   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
+      value.  Eg "2.35.90" becomes "2.36".  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.
+      updates and add a  "this-is-the-2.3x-release" comment and
+      commit.
 
   22. Check that your file creation mask will create the
       correct file permissions.  Eg:
@@ -218,7 +211,7 @@ When the time comes to actually make the release....
       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
@@ -230,25 +223,46 @@ When the time comes to actually make the release....
             ./src-release.sh -b -g -l -x binutils
 
   24. Check that the files in the tarballs have the correct
-      permissions. 
+      permissions.  (FIXME: How to do this ?)
 
   25. Sanity check the release on x86_64-pc-linux-gnu by building and
       running the testsuites (gas, gold, binutils and ld).  Make the
       source directory read-only before building.  Also test
       "make install".  If necessary fix any problems.
 
+        cd /dev/shm
+       mkdir delme
+       cd delme
+       tar xvf <path-to-sources>/binutils-2.X.tar.xz
+       chmod -R -w binutils-2.X
+       mkdir build
+       cd build
+       ../binutils-2.X/configure --enable-gold --prefix=`pwd`/install --enable-plugins
+       make all-gas all-gold all-ld all-binutils all-gprof
+       make check-gas check-binutils check-ld check-gold
+        make install-gas install-gold install-ld install-binutils
+
+        # Needed for step 29...
+        make html
+
   26. Tag the branch with the new release number:
 
-            git tag -a binutils-2_XX
+            git tag -a binutils-2_3x
              [optional: add "-u XXXXX" to sign with a gpg key]
-           git push origin binutils-2_XX
-
+             enter a tag message such as: "Official Binutils 2.3x release"
+             
         NB/ If you do sign the binaries make sure to use a key
        that has been published with the FSF.
 
+        Then push the release:
+       
+           git push origin binutils-2_3x
+
+        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.3x.tar.*
 
       The gnupload script is in the gnulib/build-aux directory.
 
@@ -259,40 +273,45 @@ When the time comes to actually make the release....
 
        sftp sourceware.org
          cd /sourceware/ftp/pub/binutils/releases
-        put binutils-X.XX.tar.*
-        chmod 644 binutils-X.XX.tar.*
+        put binutils-2.3x.tar.*
+        chmod 644 binutils-2.3x.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-X.XX
-        cd docs-X.XX
-        mkdir as bfd binutils gprof ld
-        cd ../docs-X.(XX-1)
+        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-X.XX
+        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).
+      directories had to be made by hand, as shown above).
 
          cd as
         lcd <build-dir>/gas/doc/as.html
-        put *
+        put *      {be patient - this takes a long time...}
         cd ../bfd
         lcd ../../../bfd/doc/bfd.html
         put *
@@ -307,28 +326,52 @@ When the time comes to actually make the release....
         put *
         
       Edit the top level binutils index.html file to change the links
-      to the new documentation.
+      to point to the new documentation.
 
-         cd ../../..
-        get indexl.html
+         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.
-
+      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.3x.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
@@ -336,34 +379,19 @@ When the time comes to actually make the release....
 
           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.
+        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).
-
-          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
+  31. Clean up the source tree:
+
+        git clean -fdx .
 
   32. Edit bfd/development.sh on the branch and set the development flag
       to "true".  (Leave the experimental flag set to "false").  Also bump
@@ -371,17 +399,17 @@ When the time comes to actually make the release....
       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.XX branch
-      is now open for business as usual and that patched no longer
+  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.
 
-  34. Examine the bfd/config.bfd file and move any pending obsolete
-      targets into the definitely obsolete section.  Create a
-      changelog entry and commit.
+  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
@@ -409,20 +437,19 @@ looks like this:
   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:
 
           find . -depth -name autom4te.cache -exec rm -r {} \;
          
-       d. Commit the updates along with a "this-is-the-2.XX.X-release"
+       d. 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:
 
-            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:
@@ -430,6 +457,7 @@ looks like this:
            umask 022
 
        g. Create the release tarballs:
+       
             ./src-release -b -g -l -x binutils
 
        h. Check that the files in the tarballs have the correct
@@ -437,15 +465,13 @@ looks like this:
 
        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).
 
   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-2.3x.y.tar.*
 
      The gnupload script is in the gnulib/build-aux directory.
 
@@ -453,8 +479,8 @@ looks like this:
 
        sftp sourceware.org
          cd /sourceware/ftp/pub/binutils/releases
-        put binutils-X.XX.X.tar.*
-        chmod 644 binutils-X.XX.X.tar.*
+        put binutils-2.3x.y.tar.*
+        chmod 644 binutils-2.3x.y.tar.*
         quit
 
     It is OK to upload the signatures as well.
@@ -472,16 +498,21 @@ looks like this:
      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:
+
+  9. Create a new Bugzilla entry for the point release.
+     
+        https://sourceware.org/bugzilla/editversions.cgi?product=binutils
+
 ------------------------------------------------------------------------
 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
@@ -493,9 +524,15 @@ Hi Everyone,
     xx
     xx
 --------------------------------------------------------------------------
+  9. Clean up the source tree.
+       
+            git clean -dfx .
+
+ 10. Edit bfd/development.sh on the branch and set the development flag
+     to "true".  Commit this change.
 
 \f
-Copyright (C) 2017-2019 Free Software Foundation, Inc.
+Copyright (C) 2017-2020 Free Software Foundation, Inc.
 
 Copying and distribution of this file, with or without modification,
 are permitted in any medium without royalty provided the copyright
This page took 0.033255 seconds and 4 git commands to generate.