[binutils-gdb] Add notes on how to make a branch and a pre-release snapshot.

[Nick Clifton <nickc at sourceware dot org>]

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=98ab9e9603cdf52faab5b838c078c24be4e1364b

commit 98ab9e9603cdf52faab5b838c078c24be4e1364b
Author: Nick Clifton <nickc@redhat.com>
Date:   Fri Jan 12 17:52:38 2018 +0000

    Add notes on how to make a branch and a pre-release snapshot.
    
    	* README-how-to-make-a-release: Add notes on how to make the
    	branch and prelease snapshot.
    	* BRANCHES: Add binutils-2_29-branch.

Diff:
---
 binutils/BRANCHES                     |  1 +
 binutils/ChangeLog                    |  6 +++
 binutils/README-how-to-make-a-release | 73 +++++++++++++++++++++++++++++++++++
 3 files changed, 80 insertions(+)

diff --git a/binutils/BRANCHES b/binutils/BRANCHES
index 27db17c..9318d5e 100644
--- a/binutils/BRANCHES
+++ b/binutils/BRANCHES
@@ -44,6 +44,7 @@ binutils-2_25-branch
 binutils-2_26-branch
 binutils-2_27-branch
 binutils-2_28-branch
+binutils-2_29-branch
 
 Copyright (C) 2012-2018 Free Software Foundation, Inc.
 
diff --git a/binutils/ChangeLog b/binutils/ChangeLog
index 4a0dbbb..b18bc88 100644
--- a/binutils/ChangeLog
+++ b/binutils/ChangeLog
@@ -1,3 +1,9 @@
+2018-01-12  Nick Clifton  <nickc@redhat.com>
+
+	* README-how-to-make-a-release: Add notes on how to make the
+	branch and prelease snapshot.
+	* BRANCHES: Add binutils-2_29-branch.
+
 2018-01-10  Nick Clifton  <nickc@redhat.com>
 
 	* MAINTAINERS: Note that it is now the configure.ac file and not
diff --git a/binutils/README-how-to-make-a-release b/binutils/README-how-to-make-a-release
index 8146692..5cdc980 100644
--- a/binutils/README-how-to-make-a-release
+++ b/binutils/README-how-to-make-a-release
@@ -19,6 +19,70 @@ permissions.
 How to perform a release.
 -------------------------------------------------
 
+  1. Send an email out warning contributors about the forthcoming
+     branch.  Set a date for the branch (weekends are better because
+     they are less busy).
+  
+  2. Update the libiberty and config directories and the top level
+     configure files.  
+
+  3. When branch day arrives add markers for the upcoming release to
+     gas, ld, gold and binutils NEWS files.  Likewise for all of the
+     ChangeLog files.  Add a note of the name of the new branch to
+     binutils/BRANCHES.  Commit these changes.
+     
+  4. Create the release branch using:
+
+	git tag -a binutils-2_30-branch   [eg for the 2.30 branch...]
+        git push --tags origin binutils-2_30-branch
+
+  5. Update bfd/configure and bfd/configure.ac on HEAD to indicate
+     snapshot of the following release.
+
+  6. Rename the current HEAD version entry in Bugzilla, and create a
+     new one.  E.g. rename "2.30 (HEAD)" to 2.30, and create "2.31
+     (HEAD)".  Go to "Edit products" from the bottom toolbar, click on
+     "binutils", then on "Edit versions".  If you don't have
+     permissions to do this, either ask Daniel Berlin to fix your
+     account or ask Daniel Jacobowitz to do it.
+
+  7. Regenerate various files on both branch and HEAD by configuring
+     with --enable-maintainer-mode.  No need to check in changes to
+     the autoconf/automake/etc files, but be sure the .pot files are
+     up to date.
+
+  8. Create an initial prerelease:
+
+     a. Bump the version on the branch, and check this in.
+
+     b. Create a source tarball:
+     
+          git clean -f -d -x
+          CFLAGS="-O -g0" ./src-release.sh -b binutils
+          rm -rf $release_dir/proto-toplev
+          rm $release_dir/binutils-$version
+          rm $release_dir/binutils-$version.tar
+          mv $release_dir/binutils-$version.tar.lzip ..
+ 
+     c. Build a test target using this tarball.
+
+     d. Upload the prerelease snapshot to the FTP:
+
+          scp ../binutils-$version.tar.bz2 sourceware.org:~ftp/pub/binutils/snapshots
+          ssh sourceware.org md5sum \~ftp/pub/binutils/snapshots/binutils-$version.tar.bz2
+          md5sum ../binutils-$version.tar.bz2
+
+   9. Send it to the Translation Project:
+   
+        http://translationproject.org/html/maintainers.html
+	
+      Sending mail for one of the POT files is sufficient.
+
+  10. Announce the availability of the snapshot and the branch on the
+      binutils mailing list.  Set a date for when the release will
+      actually happen.  Nag maintainers to fix any testsuite failures
+      for their architectures...
+
 xxx -- fill in stuff here -- xxx
 
 -------------------------------------------------
@@ -45,6 +109,9 @@ looks like this:
   2. Make sure that the branch sources build, test and install
      correctly.
 
+  2.5 Prepare a list of the bugs which have been fixed.  This
+      will be needed for step 8.
+      
   3. In the branch sources:
   
        a. Update the minor release number in bfd/version.m4.
@@ -124,6 +191,12 @@ Hi Everyone,
 
   Our thanks go out to all of the binutils contributors, past and
   present, for helping to make this release possible.
+
+  Here is a list of the bugs that have been fixed:
+    xx
+    xx
+    xx
+    xx
 --------------------------------------------------------------------------