X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2FVERSIONING;h=3ed1c7eefabf604ca2855f06e1f91185989de59c;hb=4991f179f6794d9d64d69fbb39338e738522881a;hp=30f5f61ea426f89b8c6ce325bafdf4b043535bbb;hpb=8ff435735e6912b1ced2aaf7769192a53a9a9b33;p=fs%2Flustre-release.git

diff --git a/lustre/doc/VERSIONING b/lustre/doc/VERSIONING
index 30f5f61..3ed1c7e 100644
--- a/lustre/doc/VERSIONING
+++ b/lustre/doc/VERSIONING
@@ -1,42 +1,52 @@
 Lustre versioning
 =================
 
-0.0.1  2/19/2002 <braam@clusterfs.com>
-
 This document describes versioning of source and binaries for Lustre.
 
-CVS
-===
+Versions
+========
+
+The Lustre build version is set in lustre/autoconf/lustre-version.ac
+file with the LUSTRE_MAJOR, LUSTRE_MINOR, LUSTRE_PATCH, and LUSTRE_FIX
+fields.  These are used to generate the LUSTRE_VERSION string and the
+LUSTRE_VERSION_CODE in lustre/include/lustre_ver.h.
+
+LUSTRE_VERSION_CODE can be used in conjunction with OBD_OCD_VERSION()
+to conditionally enable functionality by Lustre version, or to mark
+some part of code obsolete when a future version of Lustre is built.
+It is preferable to mark code obsolete starting at the x.y.50 build
+so that it is removed early in the development cycle.
 
-Versions will have 4 digits:
-                     major.minor.patch.test
+Packages
+========
 
-Such versions will be tagged in CVS as:  
-                     v1_2_11_7
-and referred to as:
-                     1.2.11.7
-encoded as:
-                     0x01021107
+Major releases should get a 3-digit version x.y.0, and if a maintenance
+release is needed it will increment the 3rd digit.  During development,
+versions start at x.y.50 and increment toward the x.(y+1).0 release.
 
-Usage: 
+Release candidate versions must have the proper build version for the
+release, but are tagged in Git as v2_1_0_RC1.  Final release versions
+are tagged in Git as both v2_1_0_0 and 2.1.0.
+
+Usage:
 ------
 
-New numbers are used as follows: 
+New numbers are used as follows:
 
-1. major: 
+1. major:
  - increased when major new functionality becomes available
-2. minor: 
- - even: for each new release with new functionality
- - odd : when a new development cycle starts after a release
+2. minor:
+ - for each new release with new functionality
 3. patch:
- - when a development snapshot or release update becomes available
- - all these are announced on lustre-devel@lists.sf.net
-4. test: 
+ - for a stable maintenance release or development snapshot
+4. test:
  - when developers feel it is time to exchange a named version
 
-What will run, what won't:
+What will run, what won't ?
+---------------------------
 
-1. If the test level is non-zero no guarantees of any kind are made. 
-2. For three digit releases/tags the code should perform 
-   according to the announcement.
+1. If the test level is non-zero, i.e. there are 4 digits in the
+   version, no guarantees of any kind are made.
 
+2. For three digit releases/tags the code should perform
+   according to the announcement.