Add release_notes.rst. Change version to 0.9.5 in preparation for test release.

Changelog

@@ -1,5 +1,5 @@
 Changelog for Percona Toolkit
 
-v0.9.4 released 2011-08-19
+v0.9.5 released 2011-08-04
 
-  * First release candidate.
+  * Forked, combined, and rebranded Maatkit and Aspersa as Percona Toolkit.

config/deb/changelog

@@ -1,5 +1,5 @@
-percona-toolkit (0.9.4) unstable; urgency=low
+percona-toolkit (0.9.5) unstable; urgency=low
 
-  * First release candidate.
+  * Forked, combined, and rebranded Maatkit and Aspersa as Percona Toolkit.
 
- -- Percona Toolkit Developers <toolkit-dev@percona.com>  Tue, 19 Jul 2011 21:14:21 +0000
+ -- Percona Toolkit Developers <toolkit-dev@percona.com>  Thu, 04 Aug 2011 21:00:00 +0000

docs/percona-toolkit.pod

@@ -48,7 +48,7 @@ Extract and log MySQL deadlock information.
 
 =item pt-diskstats
 
-Read a file generated from /proc/diskstats and summarize it.
+Aggregate and summarize F</proc/diskstats>.
 
 =item pt-duplicate-key-checker
 
@@ -84,7 +84,7 @@ Replay MySQL query logs.
 
 =item pt-mext
 
-Aggregate and summarize mysqladmin extended output.
+Look at many samples of MySQL C<SHOW GLOBAL STATUS> side-by-side.
 
 =item pt-mysql-summary
 
@@ -120,7 +120,7 @@ Canonicalize and print MySQL grants so you can effectively replicate, compare an
 
 =item pt-sift
 
-Browses the files created by the collect tool.
+Browses files created by pt-collect.
 
 =item pt-slave-delay
 
@@ -136,7 +136,7 @@ Watch and restart MySQL replication after errors.
 
 =item pt-stalk
 
-Watch MySQL and run the 'collect' program when some condition becomes true.
+Wait for a condition to occur then begin collecting data.
 
 =item pt-summary
 

docs/release_notes.rst

@@ -0,0 +1,12 @@
+Release Notes
+*************
+
+v0.9.5 released 2011-08-04
+==========================
+
+Percona Toolkit 0.9.5 represents the completed transition from Maatkit and Aspersa.  There are no bug fixes or new features, but some features have been removed (like --save-results from pt-query-digest).  This release is the starting point for the 1.0 series where new development will happen, and no more changes will be made to the 0.9 series.
+
+Changelog
+---------
+
+* Forked, combined, and rebranded Maatkit and Aspersa as Percona Toolkit.

docs/user/index.rst

@@ -31,3 +31,4 @@ developed by Percona, visit `http://www.percona.com/software/ <http://www.percon
    authors
    copyright_license_and_warranty
    version
+   release_notes

docs/user/release_notes.rst

@@ -0,0 +1,13 @@
+Release Notes
+*************
+
+v0.9.5 released 2011-08-04
+==========================
+
+Percona Toolkit 0.9.5 represents the completed transition from Maatkit and Aspersa.  There are no bug fixes or new features, but some features have been removed (like --save-results from pt-query-digest).  This release is the starting point for the 1.0 series where new development will happen, and no more changes will be made to the 0.9 series.
+
+Changelog
+---------
+
+* Forked, combined, and rebranded Maatkit and Aspersa as Percona Toolkit.
+* Foo

util/build-packages

@@ -43,6 +43,7 @@ warn() {
    exit_status=1
 }
 
+cwd=$PWD
 PERCONA_TOOLKIT_BRANCH=${PERCONA_TOOLKIT_BRANCH:-""}
 if [ -n "$PERCONA_TOOLKIT_BRANCH" ]; then
    BRANCH=$PERCONA_TOOLKIT_BRANCH
@@ -57,6 +58,7 @@ else
    fi
    BRANCH=`pwd`
 fi
+cd $cwd
 
 # ############################################################################
 # Paths
@@ -109,6 +111,15 @@ check_changelog() {
    echo "OK"
 }
 
+check_rel_notes() {
+   echo -n "Checking release_notes.rst: "
+   cd $DOCS_DIR
+   if [ -n "$(grep "^v$VERSION" release_notes.rst)" ]; then
+      die "Entries for v$VERSION already exist"
+   fi
+   echo "OK"
+}
+
 update_version() {
    echo -n "Updating version in tools... "
    cd $BRANCH/bin
@@ -237,7 +248,7 @@ update_changelog() {
    echo "percona-toolkit ($VERSION) unstable; urgency=low
 " > /tmp/changelog.tmp
 
-   cat $BRANCH/Changelog | $BRANCH/util/log-entries -v version="$VERSION" >> /tmp/changelog.tmp
+   cat $BRANCH/Changelog | $BRANCH/util/log-entries $VERSION >> /tmp/changelog.tmp
    echo >> /tmp/changelog.tmp
    echo " -- Percona Toolkit Developers <toolkit-dev@percona.com>  $DEB_DATE
 " >> /tmp/changelog.tmp 
@@ -246,6 +257,35 @@ update_changelog() {
    echo "OK"
 }
 
+update_rel_notes() {
+   echo -n "Updating release_notes.rst: "
+   cd $DOCS_DIR
+
+   head -n 3 release_notes.rst > /tmp/release_notes.tmp
+
+   local line="v$VERSION released $DATE"
+   local len=${#line}
+   local ul=$(printf "%${len}s")
+   echo $line                             >> /tmp/release_notes.tmp
+   echo ${ul// /=}                        >> /tmp/release_notes.tmp
+   echo                                   >> /tmp/release_notes.tmp
+   (cd $cwd && cat $REL_NOTES             >> /tmp/release_notes.tmp)
+   echo                                   >> /tmp/release_notes.tmp
+   echo "Changelog"                       >> /tmp/release_notes.tmp
+   echo "---------"                       >> /tmp/release_notes.tmp
+   echo                                   >> /tmp/release_notes.tmp
+   cat $BRANCH/Changelog | $BRANCH/util/log-entries $VERSION \
+                         | sed -e 's/^ *//g'                 \
+                                          >> /tmp/release_notes.tmp
+   echo                                   >> /tmp/release_notes.tmp
+
+   tail -n +4 release_notes.rst >> /tmp/release_notes.tmp
+
+   mv /tmp/release_notes.tmp release_notes.rst
+
+   echo "OK"
+}
+
 prep_release_dir() {
    echo -n "Preparing release directory: "
    cd $BRANCH
@@ -338,8 +378,14 @@ build_deb() {
 # Script starts here
 # ############################################################################
 
-if [ $# -eq 0 ]; then
+if [ $# -lt 2 ]; then
-   die "Usage: $0 VERSION"
+   die "Usage: $0 VERSION RELEASE_NOTES"
+fi
+VERSION=$1
+REL_NOTES=$2
+
+if [ ! -f $REL_NOTES ]; then
+   die "$REL_NOTES does not exist"
 fi
 
 # My machine's language is not English.  This affects DEB_DATE because
@@ -350,7 +396,6 @@ LANG='en_US.UTF-8'
 YEAR=$(date -u +'%Y')                      # for updating copyright year
 DATE=$(date -u +'%F')                      # for updating release date
 DEB_DATE=$(date -u +'%a, %d %b %Y %T %z')  # for updating deb/changelog
-VERSION=$1                                 # for PKG 
 PKG="percona-toolkit-$VERSION"             # what we're building
 
 # mktemp -d doesn't work on Mac OS X, so we'll do it the old-fashioned way.
@@ -366,6 +411,7 @@ if [ $CHECK -eq 1 ]; then
    check_branch
    check_version
    check_changelog
+   check_rel_notes
 fi
 
 # These items need to be updated automatically for each release.
@@ -376,6 +422,7 @@ if [ $UPDATE -eq 1 ]; then
    update_manifest
    update_percona_toolkit_pod
    update_changelog
+   update_rel_notes
 fi
 
 # Now that those ^ items are updated, you need to commit and push one more

util/log-entries

@@ -1,21 +1,27 @@
-#!/usr/bin/awk -f
+#!/usr/bin/env bash
 
+version=$1
+if [ -z "$version" ]; then
+   echo "Usage: log-entires VERSION" >&2
+   echo "Example: cat Changelog | log-entries 1.0.1" >&2
+   exit 1
+fi
+
+awk "
 BEGIN {
-   if ( version == "" ) {
+   start = \"^v\" \"$version\"
-      print "Usage: log-entries VERSION"
-      exit
-   }
-
-   start = "^v" version
 }
 
-$0 ~ start {
+\$0 ~ start {
    while ( getline ) {
-      if ( $0 ~ /^v[0-9]/ )
+      if ( \$0 ~ /^v[0-9]/ )
          exit
-      if ( $0 ~ /^$/ )
+      if ( \$0 ~ /^\$/ )
          continue
       
       print
    }
 }
+"
+
+exit $?

util/write-user-docs

@@ -108,6 +108,8 @@ write_index() {
       echo "   $section_filename" >> $RST/index.rst
    done
 
+   echo "   release_notes" >> $RST/index.rst
+
    echo ".. toctree::" >> $RST/tools.rst
    echo "   :hidden:"  >> $RST/tools.rst
    echo                >> $RST/tools.rst
@@ -130,10 +132,15 @@ if [ $# -gt 0 ]; then
    done
 fi
 
-if [ "$DOCS/percona-toolkit.pod" -nt "$RST/index.rst" ]; then
+if [ ! -f "$RST/index.rst" ] || [ "$DOCS/percona-toolkit.pod" -nt "$RST/index.rst" ]; then
    write_index
 fi
 
+if [ ! -f "$RST/release_notes.rst" ] || [ "$DOCS/release_notes.rst" -nt "$RST/release_notes.rst" ]; then
+   cp $DOCS/release_notes.rst $RST/
+   echo "Wrote $RST/release_notes.rst"
+fi
+
 BUILD=${BUILD:-1}
 if [ $BUILD -eq 1 ]; then
    # -W treats warnings as errors; remove it to ignore warnings if you must.