[gnue] r9696 - in trunk/gnue-common: src/utils utils

Author: reinhard
Date: 2007-06-08 14:44:54 -0500 (Fri, 08 Jun 2007)
New Revision: 9696

Modified:
   trunk/gnue-common/src/utils/version.py
   trunk/gnue-common/utils/announce-release
   trunk/gnue-common/utils/release
Log:
Try to be a little less confusing about what is a release, a version, or a
build.


Modified: trunk/gnue-common/src/utils/version.py
===================================================================
--- trunk/gnue-common/src/utils/version.py	2007-06-08 15:26:47 UTC (rev 9695)
+++ trunk/gnue-common/src/utils/version.py	2007-06-08 19:44:54 UTC (rev 9696)
@@ -22,6 +22,48 @@
 # $Id$
 """
 Helper functions for version handling.
+
+About the release process in GNU Enterprise
+===========================================
+
+Releases
+--------
+
+GNU Enterprise is under ongoing development, and once a new set of functions is
+ready to be used, a release is made.
+
+Releases are numbered with a two-part release number, like 0.6 or 1.0 or 2.4.
+
+Builds
+------
+
+A build is a specific version of the software. For every release, several
+builds are made.
+
+Before the release, so called "prerelease" or "unstable" builds are made. The
+version number of these builds consist of the release number of the upcoming
+release, a dash, the name of the phase of the release cycle, and the build
+number within the phase.
+
+The first phase of the release cycle is "alpha", in which the software is
+expected to have bugs, and new features usually are freshly (and probably
+incompletely) implemented. As soon as the software is deemed feature-complete,
+it switches to "beta" phase, in which the bug hunting season starts. Once the
+developers feel that no serious bugs should be left over, the "pre" phase
+begins. In the last phase before the release, the versions are named "rc"
+(meaning "release candidate").
+
+Then the software goes into the stable (read: end user suitable) phase. The
+first stable version of each release ends in ".0", but people will still find
+bugs or major improvements, and there will be further bug fix builds within the
+same release cycle, where the last number is incremented.
+
+Snapshots
+---------
+
+Some people want to be on the bleeding edge of development and use Subversion
+snapshots. The version number of such a snapshot is the version number of the
+last build, a "+" sign, the text "svn", a dot, and the Subversion revision.
 """
 
 import os
@@ -101,8 +143,8 @@
         A version number for a stable snapshot follows the format
         <major>.<minor>.<build>+svn.<svn> (e.g. 1.5.2+svn.9876).
 
-    @ivar major: Major version number
-    @ivar minor: Minor version number
+    @ivar major: Major release number
+    @ivar minor: Minor release number
     @ivar phase: Phase of the release process. Can be C{'alpha'}, C{'beta'},
         C{'pre'}, C{'rc'}, or C{'final'}. If the phase is C{'final'}, it is a
         stable version, otherwise it is an unstable version.

Modified: trunk/gnue-common/utils/announce-release
===================================================================
--- trunk/gnue-common/utils/announce-release	2007-06-08 15:26:47 UTC (rev 9695)
+++ trunk/gnue-common/utils/announce-release	2007-06-08 19:44:54 UTC (rev 9696)
@@ -1,9 +1,9 @@
 #!/bin/bash -e
-# Script to announce a new release
+# Script to announce a new version
 
 # Where to send the mail to
-mail_release="[email protected] [email protected] [email protected]"
-mail_prerelease="[email protected] [email protected]"
+mail_stable="[email protected] [email protected] [email protected]"
+mail_unstable="[email protected] [email protected]"
 
 if [ ! -d "src" ]; then
   echo "Please start this script in the package directory!"
@@ -49,7 +49,7 @@
   )
 )
 
-# Create the release text
+# Create the announcement text
 announcement=$(
   echo "The GNU Enterprise team proudly announces"
   echo ""
@@ -122,7 +122,7 @@
     echo ""
     echo ""
     (
-      echo "You can download this release of $title from"
+      echo "You can download this version of $title from"
       echo "http://www.gnuenterprise.org/tools/$package/$version/"
     ) | fmt --width=72
   else
@@ -142,13 +142,13 @@
 
 # Send the email
 if [ "$phase" == "final" ]; then
-  mail="$mail_release"
+  mail="$mail_stable"
 else
-  mail="$mail_prerelease"
+  mail="$mail_unstable"
 fi
 for recepient in $mail; do
   echo "$announcement" | mail -a "From: [email protected]" \
-                           -s "$title $version released" \
+                           -s "$title $version available" \
                            $recepient
 done
 
@@ -164,7 +164,7 @@
 
     let number="$(ls 1* | tail -1) + 1"
     (
-      echo "Title: $title $version released"
+      echo "Title: $title $version available"
       echo "Author: [email protected]"
       echo "Date: $(date --iso)"
       echo ""

Modified: trunk/gnue-common/utils/release
===================================================================
--- trunk/gnue-common/utils/release	2007-06-08 15:26:47 UTC (rev 9695)
+++ trunk/gnue-common/utils/release	2007-06-08 19:44:54 UTC (rev 9696)
@@ -1,5 +1,5 @@
 #!/bin/bash -e
-# Script for release process
+# Script for build process
 
 if [ ! -d "src" ]; then
   echo "Please start this script in the package directory!"
@@ -29,7 +29,7 @@
 echo "$(date --iso-8601=seconds) Updating documentation"
 (cd ..; gnue-common/utils/update-tool-docs $package)
 
-# Rebuild sample.gnue.conf if we're releaseing common
+# Rebuild sample.gnue.conf if we're building common
 if [ "$package" == "common" ]; then
   echo "$(date --iso-8601=seconds) Updating sample configuration file"
   (cd etc; LANG=C gcvs ../utils/generate-gnue-config.py)