2006-11-07 Havoc Pennington <hp@redhat.com>

	* HACKING: Update release instructions to include stuff about
	stable releases, branching, etc. May not be totally correct,
	please fix if needed, but keep instructions up-to-date so we do
	each stable release consistently in the future.

1 files changed, 36 insertions, 2 deletions

diff --git a/HACKING b/HACKING
index 3b069cf6..96b91e5e 100644
--- a/HACKING
+++ b/HACKING
@@ -71,11 +71,16 @@ To make a release of D-Bus, do the following:
 
  - update the file NEWS based on the ChangeLog
 
+ - update the AUTHORS file based on the ChangeLog
+
  - add a ChangeLog entry containing the version number 
    you're releasing ("Released 0.3" or something)
    so people can see which changes were before and after
    a given release.
 
+ - The version number should have major.minor.micro even
+   if micro is 0, i.e. "1.0.0" and "1.2.0" not "1.0"/"1.2"
+
  - "make distcheck" (DO NOT just "make dist" - pass the check!)
 
  - if make distcheck fails, fix it.
@@ -90,7 +95,8 @@ To make a release of D-Bus, do the following:
 
  - bump the version number up in configure.in, and commit
    it.  Make sure you do this *after* tagging the previous
-   release!
+   release! The idea is that CVS has a newer version number
+   than anything released.
 
  - scp your tarball to freedesktop.org server and copy it 
    to /srv/dbus.freedesktop.org/www/releases. This should 
@@ -109,6 +115,33 @@ To make a release of D-Bus, do the following:
  - post to dbus@lists.freedesktop.org announcing the release.
  
 
+After making a ".0" stable release
+===
+
+After releasing, when you increment the version number in CVS, also
+move the ChangeLog to ChangeLog.pre-X-Y where X-Y is what you just
+released, e.g. ChangeLog.pre-1-0. Then create and cvs add a new empty
+ChangeLog. The last entry in ChangeLog.pre-1-0 should be the one about
+"Released 1.0". 
+
+Add ChangeLog.pre-X-Y to EXTRA_DIST in Makefile.am.
+
+We create a branch for each stable release; sometimes the branch is
+not done immediately, instead it's possible to wait until someone has
+a not-suitable-for-stable change they want to make and then branch to
+allow committing that change.
+
+The branch name should be DBUS_X_Y_BRANCH which is a branch that has
+releases versioned X.Y.Z
+
+To branch, tag HEAD with DBUS_X_Y_BRANCHPOINT:
+ cvs tag DBUS_X_Y_BRANCHPOINT
+then create the branch from that tag:
+ cvs rtag -b -r DBUS_X_Y_BRANCHPOINT DBUS_X_Y_BRANCH dbus
+
+Note that DBUS_X_Y_BRANCHPOINT may not tag the same revision as the
+DBUS_X_Y_Z release, since we may not branch immediately.
+
 Environment variables
 ===
 
@@ -195,6 +228,7 @@ rules are:
 
 The reviewer group that can approve patches: Havoc Pennington, Michael
 Meeks, Alex Larsson, Zack Rusin, Joe Shaw, Mikael Hallendal, Richard
-Hult, Owen Fraser-Green, Olivier Andrieu, Colin Walters.
+Hult, Owen Fraser-Green, Olivier Andrieu, Colin Walters, Thiago
+Macieira, John Palmieri.