Versions.xml: Update to reflect current state

- Explain xorg-server vs. X11R7.x numbering and why versions
  reported by the server went backwards.
- Use 1.8.x instead of 6.8.x in examples to reinforce current versioning
- Show git tag/branch name format instead of CVS
- Stop claiming to speak for XFree86

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>

1 files changed, 103 insertions, 72 deletions

diff --git a/general/Versions.xml b/general/Versions.xml
index c7d83da..913b562 100644
--- a/general/Versions.xml
+++ b/general/Versions.xml
@@ -6,14 +6,14 @@
 
 <articleinfo>
 
-<title>X.Org and XFree86 Version Numbering Schemes</title>
+<title>X.Org Version Numbering Schemes</title>
 <corpauthor>
 The XFree86 Project, Inc
 </corpauthor>
 <corpauthor>
-Updated for X.Org by Keith Packard and Kevin E. Martin
+Updated for X.Org by Keith Packard, Kevin E. Martin, and Alan Coopersmith
 </corpauthor>
-<pubdate>22 May 2006</pubdate>
+<pubdate>November 2010</pubdate>
 
 <abstract>
 
@@ -21,8 +21,6 @@ Updated for X.Org by Keith Packard and Kevin E. Martin
 X.Org has adopted the same basic numbering scheme used by the XFree86
 Project, Inc. for their releases.  The actual numbers are different, but the
 basic scheme is the same.  This document reflects the policy that X.Org uses.
-The version numbering schemes used by XFree86 have changed from time to
-time.
 </para>
 
 </abstract>
@@ -30,19 +28,46 @@ time.
 </articleinfo>
 
 <sect1>
+<title>Module Versions</title>
+
+<para>
+Starting with the X11R7.0 release, each module has its own version number.
+For those without a natural starting point, the version numbers started at
+1.0.   For instance, the X11R7.0 release included the xorg-server 1.0
+module.   As modules are released independently from the rest of the
+window system, the module version is the most accurate source of version
+information.   For instance, there are many X server releases in a year,
+but generally only one window system release, so an X server version number
+such as 1.7.7 is more informative than the X11R7.5 version for the window
+system <quote>katamari</quote> release.
+</para>
+
+<para>
+Unfortunately, up through the X server 1.3 release, the X server
+used the Window System version when reporting its version number
+in log files, the -version option, and the connection setup string
+(displayed by xdpyinfo).   This was corrected with X server 1.3, which
+caused the visible version number string to appear to jump backwards
+from 7.2 to 1.3.
+</para>
+</sect1>
+
+<sect1>
 <title>Releases, Development Streams and Branches</title>
 
 <para>
-As of the release of version X11R6.7 in March 2004, X.Org has three
-release branches.  First is the trunk of the CVS repository.  This is
+X.Org has two release branches for the X server software, and several
+other modules with active ongoing development.
+First is the trunk of the git repository.  This is
 the main development stream, where all new work and work for future
 releases is done.
 </para>
 
 <para>
-Second is the stable bugfix branch for the latest full release
-(7.1.0).  It is created around the time of the release.  The
-branch for the current release is called "<literal remap="tt">XORG-7_1-branch</literal>".
+Second is the stable bugfix branch for the latest full release.  It is
+created around the time of the release.  The branch will be named for the
+release version, such as <quote><literal>server-1.9-branch</literal></quote>
+for the X server 1.9.x series of releases.
 Fixes for bugs found in the release will be added to this branch (as
 well as the trunk), and updates to this release (if any) will be cut
 from this branch.  Similar stable branches are present for previous full
@@ -55,30 +80,23 @@ development stream at regular intervals in the 6-12 month range.  The
 feature freezes for these releases will usually be 2-3 months before the
 release dates.  This general plan is a goal, not a binding commitment.
 The actual release intervals and dates will depend to a large degree on
-the resource available to X.Org.  Full releases consist of full source
-code tarballs, plus full binary distributions for a range of supported
-platforms.  Update/bugfix releases will be made on an as-required basis,
+the resource available to X.Org.
+Update/bugfix releases will be made on an as-required basis,
 depending also on the availability of resources, and will generally be
 limited to serious bug and security fixes.  New features will not
-usually be added in update releases.  Update/bugfix releases will not be
-full releases, and will consist of source code patches, plus binary
-updates to be layered on top of the previous full release.
-</para>
-
-<para>
-The next full release will be version 7.2.
+usually be added in update releases.
 </para>
 
 <para>
 Aside from actual releases, snapshots of the active release branches
-are tagged in the CVS repository from time to time.  Each such snapshot
+are tagged in the git repository from time to time.  Each such snapshot
 has an identifiable version number.
 </para>
 
 </sect1>
 
 <sect1>
-<title>Current (new) Version Numbering Scheme</title>
+<title>Current Version Numbering Scheme</title>
 
 <para>
 Starting with the main development branch after X11R6.7, the X.Org
@@ -86,13 +104,16 @@ versions are numbered according to the scheme outlined here.
 </para>
 
 <para>
-The version numbering format is <literal remap="tt">M.m.P.s</literal>, where <literal remap="tt">M</literal> is
-the major version number, <literal remap="tt">m</literal> is the minor version number,
-<literal remap="tt">P</literal> is the patch level, and <literal remap="tt">s</literal> is the snapshot number.
-Full releases have <literal remap="tt">P</literal> set to zero, and it is incremented for
-each subsequent bug fix release on the post-release stable branch.  The
-snapshot number <literal remap="tt">s</literal> is present only for between-release snapshots
-of the development and stable branches.
+The version numbering format is <literal remap="tt">M.m.P.s</literal>,
+where <replaceable>M</replaceable> is the major version number,
+<replaceable>m</replaceable> is the minor version number,
+<replaceable>P</replaceable> is the patch level, and
+<replaceable>s</replaceable> is the snapshot number.
+Full releases have <replaceable>P</replaceable> set to zero, and it is
+incremented for each subsequent bug fix release on the post-release
+stable branch.  The snapshot number <replaceable>s</replaceable> is
+present only for between-release snapshots of the development and
+stable branches.
 </para>
 
 <sect2>
@@ -102,71 +123,73 @@ of the development and stable branches.
 Immediately after forming a release stable branch, the patch level
 number for the main development branch is bumped to 99, and the snapshot
 number is reset.  The snapshot number is incremented for each tagged
-development snapshot.  The CVS tag for snapshots is
-"<literal remap="tt">XORG-M&lowbar;m&lowbar;P&lowbar;s</literal>".  When the development branch enters feature
+development snapshot.  The git tag for snapshots is
+<quote><literal remap="tt">xorg-server-M.m.P.s</literal></quote>.
+When the development branch enters feature
 freeze, the snapshot number is bumped to 900.  A stable branch may be
 created for the next full release at any time after the feature freeze.
-When it is, the branch is called "<literal remap="tt">XORG-M&lowbar;m-branch</literal>".  The
+When it is, the branch is called
+<quote><literal remap="tt">server-M.m-branch</literal></quote>.  The
 snapshot number is incremented from there until the release is
-finalised.  Each of these snapshots is a "release candidate".  When the
+finalised.  Each of these snapshots is a <quote>release candidate</quote>.  When the
 release is finalised, the minor version is incremented, the patch level
 is set to zero, and the snapshot number removed.
 </para>
 
 <para>
 Here's an example which shows the version number sequence for the
-development leading up to version 6.8:
+development leading up to version 1.8:
 </para>
 
 <para>
 <variablelist>
 
 <varlistentry>
-<term><literal remap="tt">6.7.99.1</literal></term>
+<term><literal remap="tt">1.7.99.1</literal></term>
 <listitem>
 <para>
-The first snapshot of the pre-6.8 development branch.
+The first snapshot of the pre-1.8 development branch.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.7.99.23</literal></term>
+<term><literal remap="tt">1.7.99.23</literal></term>
 <listitem>
 <para>
-The twenty-third snapshot of the pre-6.8 development branch.
+The twenty-third snapshot of the pre-1.8 development branch.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.7.99.900</literal></term>
+<term><literal remap="tt">1.7.99.900</literal></term>
 <listitem>
 <para>
-The start of the 6.8 feature freeze.
+The start of the 1.8 feature freeze.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.7.99.903</literal></term>
+<term><literal remap="tt">1.7.99.903</literal></term>
 <listitem>
 <para>
-The third 6.8 release candidate.
+The third 1.8 release candidate.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.8.0</literal></term>
+<term><literal remap="tt">1.8.0</literal></term>
 <listitem>
 <para>
-The 6.8 release.
+The 1.8 release.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.8.99.1</literal></term>
+<term><literal remap="tt">1.8.99.1</literal></term>
 <listitem>
 <para>
-The first pre-6.9 development snapshot, which  is the first main
-branch snapshot after creating the 6.8 stable branch.
+The first pre-1.9 development snapshot, which  is the first main
+branch snapshot after creating the 1.8 stable branch.
 </para>
 </listitem>
 </varlistentry>
@@ -181,15 +204,16 @@ branch snapshot after creating the 6.8 stable branch.
 <para>
 After a full release, the stable branch for the release will be
 maintained with bug fixes and important updates until the next full
-release.  Any snapshots on this branch are considered "release
-candidates", which is indicated by setting <literal remap="tt">s</literal> to a number above
+release.  Any snapshots on this branch are considered <quote>release
+candidates,</quote> which is indicated by setting <replaceable>s</replaceable>
+to a number above
 900.  The snapshot number is incremented for each release candidate
 until the update release is finalised.  The patch level value
-(<literal remap="tt">P</literal>) is incremented for each update release.
+(<replaceable>P</replaceable>) is incremented for each update release.
 </para>
 
 <para>
-Here's an example which shows a version number sequence for a 6.8.x
+Here's an example which shows a version number sequence for a 1.8.x
 stable branch:
 </para>
 
@@ -197,51 +221,51 @@ stable branch:
 <variablelist>
 
 <varlistentry>
-<term><literal remap="tt">6.8.0</literal></term>
+<term><literal remap="tt">1.8.0</literal></term>
 <listitem>
 <para>
-The 6.8 release.
+The 1.8 release.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.8.0.901</literal></term>
+<term><literal remap="tt">1.8.0.901</literal></term>
 <listitem>
 <para>
-The first pre 6.8.1 snapshot.
+The first pre 1.8.1 snapshot.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.8.0.903</literal></term>
+<term><literal remap="tt">1.8.0.903</literal></term>
 <listitem>
 <para>
-The third pre 6.8.1 snapshot, also known as the third 6.8.1 release
+The third pre 1.8.1 snapshot, also known as the third 1.8.1 release
 candidate.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.8.1</literal></term>
+<term><literal remap="tt">1.8.1</literal></term>
 <listitem>
 <para>
-The 6.8.1 release.
+The 1.8.1 release.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.8.1.901</literal></term>
+<term><literal remap="tt">1.8.1.901</literal></term>
 <listitem>
 <para>
-The first pre 6.8.2 snapshot.
+The first pre 1.8.2 snapshot.
 </para>
 </listitem>
 </varlistentry>
 <varlistentry>
-<term><literal remap="tt">6.8.2</literal></term>
+<term><literal remap="tt">1.8.2</literal></term>
 <listitem>
 <para>
-The 6.8.2 release.
+The 1.8.2 release.
 </para>
 </listitem>
 </varlistentry>
@@ -256,28 +280,35 @@ The 6.8.2 release.
 <title>Finding the X.Org X Server Version From a Client</title>
 
 <para>
-The X.Org X servers report a <literal remap="tt">VendorRelease</literal> value that matches
-the X.Org version number.  There have been some cases of releases where
+The X.Org X servers report a <function>VendorRelease</function> value that
+matches the X.Org version number.  There have been some cases of releases where
 this value wasn't set correctly.  The rules for interpreting this value
 as well as the known exceptions are outlined here.
 </para>
 
 <para>
-For post-6.7.0 development and release versions using the new numbering
-scheme, the <literal remap="tt">VendorRelease</literal> value is <literal remap="tt">MMmmPPsss</literal>.  That
-is, version <literal remap="tt">M.m.P.s</literal> has <literal remap="tt">VendorRelease</literal> set to
-<literal remap="tt">M&nbsp;*&nbsp;10000000&nbsp;+&nbsp;m&nbsp;*&nbsp;100000&nbsp;+&nbsp;P&nbsp;*&nbsp;1000&nbsp;+&nbsp;s</literal>.
+As noted above, the version reported by <function>VendorRelease</function>
+changed from the window system version to the X server version starting in
+the xorg-server 1.3 release.
 </para>
 
 <para>
-The following is a code fragment taken from <literal remap="tt">xdpyinfo.c</literal> that shows
-how the <literal remap="tt">VendorRelease</literal> information can be interpreted.
+For all X.Org development and release versions using this numbering
+scheme, the <function>VendorRelease</function> value is
+<replaceable>MMmmPPsss</replaceable>.  That is, version
+<replaceable>M.m.P.s</replaceable> has <function>VendorRelease</function> set to
+<code>M&nbsp;*&nbsp;10000000&nbsp;+&nbsp;m&nbsp;*&nbsp;100000&nbsp;+&nbsp;P&nbsp;*&nbsp;1000&nbsp;+&nbsp;s</code>.
 </para>
 
 <para>
+The following is a code fragment taken from <filename>xdpyinfo.c</filename>
+that shows how the <function>VendorRelease</function> information can be
+interpreted.
+</para>
 
-<programlisting>
+<para>
 
+<programlisting>
     if (strstr(ServerVendor(dpy), "X.Org")) {
         int vendrel = VendorRelease(dpy);