Document the branching scheme for 2.10.12.
authorMichael Poole <mdpoole@troilus.org>
Thu, 15 Sep 2005 01:17:02 +0000 (01:17 +0000)
committerMichael Poole <mdpoole@troilus.org>
Thu, 15 Sep 2005 01:17:02 +0000 (01:17 +0000)
git-svn-id: file:///home/klmitch/undernet-ircu/undernet-ircu-svn/ircu2/trunk@1488 c9e4aea6-c8fd-4c43-8297-357d70d61c8c

ChangeLog
doc/readme.cvs

index e52765499917434a5a441fa69e938e44028fba23..989ed8226208d2f541adc7ff4ddcb67cf02d7f1f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2005-09-14  Michael Poole <mdpoole@troilus.org>
+
+       * doc/readme.cvs: Document the branching scheme for 2.10.12.
+
 2005-09-14  Michael Poole <mdpoole@troilus.org>
 
        * include/patchlevel.h (PATCHLEVEL): Increment to reflect the
index 2a160f9244a2001e5f8b15b9c8539f3f1c3090d7..cf02bfb77b23e860d90040bf3173c85f0315d2fc 100644 (file)
@@ -1,92 +1,42 @@
-Notes on checking out from the Undernet CVS archive and maintenance.
-
-General Strategy:
-The main trunk of the tree will be used for ongoing development only
-(alpha) this code is not intended to be used on the production network.
-When development has reached a point of relative stability a tag will be
-applied to the development branch and a beta tag will be applied to that
-branch. For beta test servers only the tagged branches will be used.
-When a tag is applied we will also produce a snapshot tarball of the
-tag. Once a beta tagged release has been proven stable any fixes will be
-merged into the main tagged version and the code will be voted on for
-release. Fixes after release will be tagged with a patchlevel tag.
-
-You check out a tagged release by specifying the -r tag option to cvs.
-This is the command to check out the most recent tagged version of
-ircu2.10.07:
-cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -r u2_10_07_pl6 -P ircu2.10
-
-Developers doing maintenance and bug fixes should only check out the
-current tagged patchlevel for the affected version. Once the fix has
-proven stable, it will be merged into the tree the fix is relative to.
-
-We will not merge the changes that have been made to ircu2.10.07 since
-it's release into the development branch, the 2.10.07 branch is a
-maintenance only branch.
-
-If you have any questions on how to check out tagged versions check out
-the coder-com web page http://coder-com.undernet.org/cvs.html or the cvs
-manual page. If you're really stumped feel free to ask in #coder-com.
-
-We will put out new tarballs for every tagged release which will be
-available on the coder-com web page.
-
-Naming Conventions:
-
-Tag Names:
-Major release - u2_10_10
-Beta release  - u2_10_10_beta01
-Production patch - u2_10_07_pl9
-
-The tree currently looks like this:
-
-Trunk: development only
-------------------------------------------------
-  \                       \
-   \----- u2_10_07         \---- u2_10_10 --- release ---------
-       \                      \                        \
-        \--- u2_10_07_pl9      \--- u2_10_10_beta06     \ u2_10_10_pl01
-
-Patches will be rolled into the tagged branch and eventually rolled into
-the development branch. All new development should be relative to the
-trunk, only bugfixes and maintenance coding should be applied to any
-tagged version. Developers doing maintenance should only check out the
-latest pl or beta tag and apply the changes relative to that tag. These
-changes will be committed to the tag they were checked out from and once
-proven stable they will be merged into the main tagged trunk by the
-maintainer.
-
-Where to get CVS:
-http://www.cvshome.org
-
-Checking out:
-First you need to login to cvs: 
-cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu login
-
-It will prompt you for a password. There is no password so hit enter.
-
-To check out the recommended patchlevel for ircu2.10.07 use: 
-cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -r u2_10_07_pl6 -P ircu2.10
-
-For the ircu2.10.10 beta archive use: 
-cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -r u2_10_10_beta06 -P ircu2.10
-
-To check out the current development archive use: 
-cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -P ircu2.10
-
-For the ircu3 pipedream archive use: 
-cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -P ircu3
-
-When you want to update your source tree later to the latest version, use 
-cvs update -P
-
-inside  ircu2.10/,  the directory ircu2.10 was checked out to. 
-
-How to find the most current available release:
-We will announce the most current release tag when we make it available, in general
-you will check out the main branch of any given tree, if you want the current production
-release use the "u2_10_07" tag, for patched versions use a patchlevel tag "u2_10_07_pl6".
-You can always find the most recent tag for any version by looking at the Undernet
-Coder Com CVS archive: http://coder-com.undernet.org/cgi-bin/cvsweb.cgi
-
-
+Notes on checking out from the Undernet CVS archive.
+
+The main trunk of the tree (HEAD) will be used for development only.
+When the maintainers believe the code is stable enough to prepare for
+a release, they will make a branch for that release series.
+
+Each branch will have a base name, which is the name of the release
+series where dots are replaced with underscores.  The branch name will
+be the base name with the suffix "_branch".  Once an official release
+is made, each release branch will have one or more fixed tags and one
+moving tag.  The fixed tags will indicate specific patchlevels, and
+have the base name with a suffix giving the zero-based patchlevel.
+The moving tag's name will be the base name, and will always point to
+the same state as some fixed tag on the branch.
+
+This allows developers to easily track the most recent version of any
+branch (by checking out using the branch's name), and allows server
+admins to easily track the most recent release on the branch (by
+checking out using the branch's base name).
+
+For example, for the ircu2.10.12 release series, the branch's base
+name is u2_10_12.  The branch's name is u2_10_12_branch.  The first
+release (ircu2.10.12) would be permanently tagged as u2_10_12_0, and
+until an update is released, it would also have the tag u2_10_12.
+When the first update is released, it would be permanently tagged as
+u2_10_12_1, and the tag u2_10_12 would be changed to point to it.
+
+If the current stable series is 2.10.12, server admins should check
+out the code using the command:
+  cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -r u2_10_12 -P ircu2.10
+Admins may only run unreleased code on Undernet with coder-com
+approval.  The command above will retrieve the most recent release.
+
+Developers should check out the release branch using the command:
+  cvs -d :pserver:anonymous@cvs.undernet.org:/cvsroot/undernet-ircu co -r u2_10_12_branch -P ircu2.10
+
+http://sourceforge.net/cvs/?group_id=63470 gives more information on
+using CVS to access the ircu code; http://www.nongnu.org/cvs/ gives
+more information on using CVS in general.
+
+NOTE: Release before ircu2.10.12 used a different branching scheme.
+Older revisions of this readme.cvs explain that system.