[gimp] docs: Update the release instructions to be more water-tight



commit 355ce0b6ec3ff489406818b979fd580f1a766624
Author: Mukund Sivaraman <muks banu com>
Date:   Thu Feb 2 16:30:36 2012 +0530

    docs: Update the release instructions to be more water-tight

 devel-docs/release-howto.txt |   57 ++++++++++++++++++++++++++---------------
 1 files changed, 36 insertions(+), 21 deletions(-)
---
diff --git a/devel-docs/release-howto.txt b/devel-docs/release-howto.txt
index 18a9ab6..e755173 100644
--- a/devel-docs/release-howto.txt
+++ b/devel-docs/release-howto.txt
@@ -14,42 +14,56 @@
      bugzilla.gimp.org and to the news section on www.gimp.org, or that
      someone can do the changes for you.
 
- ( ) Make sure the checkout is up to date, clean from uncommitted changes.
+ ( ) Check if NEWS, authors.xml (and the generated AUTHORS), README or
+     INSTALL need to be updated, as well as any release notes on
+     gimp.org. Don't forget to add any "Index of new symbols in GIMP
+     2.x" to the gtk-doc generated devel-docs.
 
- ( ) Check that the version number is correct in configure.ac
+ ( ) Does the splash screen need to be changed?
 
- ( ) Run 'make maintainer-clean -k' or 'git clean -x -d -f'
+ ( ) Check that the version number is correct in configure.ac. It should
+     be the version number of the release you are about to make.
 
- ( ) Run ./autogen.sh --enable-gtk-doc
+ ( ) Make dist tarballs:
 
- ( ) Do a complete build of the source tree.
+     [ ] Start with a checkout of the GIMP tree. Make sure the checkout
+         is up to date, clean from uncommitted changes.
 
- ( ) Check if NEWS, authors.xml, README or INSTALL need to be updated,
-     as well as any release notes on gimp.org. Don't forget to add any
-     "Index of new symbols in GIMP 2.x" to the gtk-doc generated
-     devel-docs.
+     [ ] Run 'git clean -x -d -f' (Warning: you will lose any files that
+         are not added).
 
- ( ) Does the splash screen need to be changed?
+     [ ] Run 'git diff'. This should not generate any output, or your
+         tree has local modifications.
+
+     [ ] Run ./autogen.sh --enable-gtk-doc
 
- ( ) Run 'make distcheck'. Avoid passing make -j since that can cause
-     mysterious fails
+     [ ] Run 'make' to do a complete build of the source tree.
 
- ( ) If there are problems with 'make distcheck', fix them and try again.
+     [ ] Run 'make distcheck'. Avoid passing make -j since that can
+         cause mysterious fails.
 
- ( ) Commit changes that you had to do to get 'make distcheck' running.
+     [ ] If changes to generated files are made by the above command
+         (run 'git diff' to find out), commit+push them and repeat from
+         the beginning of this sub-section.
 
- ( ) Run 'make dist' to create the final tarball. This will generate
-     ChangeLog. Note that we don't bother with any release commit,
-     that's what tags are for (see below).
+     [ ] If there are problems reported by 'make distcheck', fix
+         them. If you made changes in the tree to get 'make distcheck'
+         running, commit+push them and repeat from the beginning of this
+         sub-section.
+
+     [ ] If 'make distcheck' passed and created tarballs, go to the next
+         item.
+
+ [ ] A successful run of the 'make distcheck' would create the final
+     dist tarballs. It will include a ChangeLog generated from the 'git
+     log'. Note that we don't bother with any release commit, that's
+     what tags are for (see below).
 
  ( ) Use md5sum to create a checksum of the tarball (tar.bz2).
 
  ( ) Upload the tarball (tar.bz2) and the .md5 file to your home directory
      on ftp.gimp.org.  Keep a copy of the .md5 file around.
 
- ( ) Commit the changes to generated files that were changed by
-     running 'make dist'.
-
  ( ) Tag the release (don't forget to push the tag)
         git tag -s GIMP_2_x_y
         git push origin GIMP_2_x_y
@@ -69,7 +83,8 @@
      downloads/index.htrw.  Commit this change, the web server should
      then update itself soon (usually less than an hour).
 
- ( ) Bump the version number in configure.ac and commit this change.
+ ( ) Bump the version number (past the tagged version) in configure.ac
+     and commit this change.
 
  ( ) Grab a properly chilled beverage and enjoy yourself.
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]