diff options
author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-11-02 18:32:35 -0700 |
---|---|---|
committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-11-02 19:33:52 -0700 |
commit | a6f01f42733110b191d95cb9f48357c92a796f08 (patch) | |
tree | 87b5b557a42e820258cefd94794e3a86cdebf1dd | |
parent | 61aab1e0b6c5b4435e34f3aeb4ee0843ee1ce9b0 (diff) |
Convert Versions doc from DocBook SGML to DocBook XML
Uses newer tools for formatting, better matching other new docs
Moved from sgml/Versions.sgml to general/Versions.xml
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r-- | general/Makefile.am | 3 | ||||
-rw-r--r-- | general/Versions.xml (renamed from sgml/Versions.sgml) | 342 | ||||
-rw-r--r-- | sgml/Makefile.am | 6 |
3 files changed, 173 insertions, 178 deletions
diff --git a/general/Makefile.am b/general/Makefile.am index 57a13d9..a3857e2 100644 --- a/general/Makefile.am +++ b/general/Makefile.am @@ -5,7 +5,8 @@ SUBDIRS = fonts input graphics doc_sources = \ License.xml \ README.xml \ - ReleaseNotes.xml + ReleaseNotes.xml \ + Versions.xml xmldir = $(docdir) dist_xml_DATA = $(doc_sources) diff --git a/sgml/Versions.sgml b/general/Versions.xml index 00f0995..c7d83da 100644 --- a/sgml/Versions.sgml +++ b/general/Versions.xml @@ -1,55 +1,55 @@ -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [ -<!ENTITY % defs SYSTEM "X11/defs.ent"> %defs; +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ ]> -<Article> +<article> <articleinfo> -<Title>X.Org and XFree86 Version Numbering Schemes</Title> -<AUTHOR> -<FirstName>The XFree86 Project, Inc</FirstName> -</AUTHOR> -<author> -<FirstName>Updated for X11R&relvers; by Keith Packard and Kevin E. Martin</FirstName> -</author> -<PubDate>22 May 2006</PubDate> +<title>X.Org and XFree86 Version Numbering Schemes</title> +<corpauthor> +The XFree86 Project, Inc +</corpauthor> +<corpauthor> +Updated for X.Org by Keith Packard and Kevin E. Martin +</corpauthor> +<pubdate>22 May 2006</pubdate> -<Abstract> +<abstract> -<Para> +<para> 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> +</para> -</Abstract> +</abstract> </articleinfo> -<Sect1> -<Title>Releases, Development Streams and Branches</Title> +<sect1> +<title>Releases, Development Streams and Branches</title> -<Para> +<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 the main development stream, where all new work and work for future releases is done. -</Para> +</para> -<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>". +branch for the current release is called "<literal remap="tt">XORG-7_1-branch</literal>". 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 releases. -</Para> +</para> -<Para> +<para> The X.Org Foundation is planning to make full releases from the main 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 @@ -63,220 +63,220 @@ 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> -<Para> +<para> The next full release will be version 7.2. -</Para> +</para> -<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 has an identifiable version number. -</Para> +</para> -</Sect1> +</sect1> -<Sect1> -<Title>Current (new) Version Numbering Scheme</Title> +<sect1> +<title>Current (new) Version Numbering Scheme</title> -<Para> +<para> Starting with the main development branch after X11R6.7, the X.Org versions are numbered according to the scheme outlined here. -</Para> +</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 +<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 +snapshot number <literal remap="tt">s</literal> is present only for between-release snapshots of the development and stable branches. -</Para> +</para> -<Sect2> -<Title>Development Branch</Title> +<sect2> +<title>Development Branch</title> -<Para> +<para> 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_m_P_s</Literal>". When the development branch enters feature +"<literal remap="tt">XORG-M_m_P_s</literal>". 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_m-branch</Literal>". The +When it is, the branch is called "<literal remap="tt">XORG-M_m-branch</literal>". The snapshot number is incremented from there until the release is finalised. Each of these snapshots is a "release candidate". When the release is finalised, the minor version is incremented, the patch level is set to zero, and the snapshot number removed. -</Para> +</para> -<Para> +<para> Here's an example which shows the version number sequence for the development leading up to version 6.8: -</Para> +</para> -<Para> -<VariableList> +<para> +<variablelist> -<VarListEntry> -<Term><Literal remap="tt">6.7.99.1</Literal></Term> -<ListItem> -<Para> +<varlistentry> +<term><literal remap="tt">6.7.99.1</literal></term> +<listitem> +<para> The first snapshot of the pre-6.8 development branch. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.7.99.23</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.7.99.23</literal></term> +<listitem> +<para> The twenty-third snapshot of the pre-6.8 development branch. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.7.99.900</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.7.99.900</literal></term> +<listitem> +<para> The start of the 6.8 feature freeze. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.7.99.903</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.7.99.903</literal></term> +<listitem> +<para> The third 6.8 release candidate. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.8.0</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.8.0</literal></term> +<listitem> +<para> The 6.8 release. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.8.99.1</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.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. -</Para> -</ListItem> -</VarListEntry> -</VariableList> -</Para> +</para> +</listitem> +</varlistentry> +</variablelist> +</para> -</Sect2> +</sect2> -<Sect2> -<Title>Stable Branch</Title> +<sect2> +<title>Stable Branch</title> -<Para> +<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 +candidates", which is indicated by setting <literal remap="tt">s</literal> 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. -</Para> +(<literal remap="tt">P</literal>) is incremented for each update release. +</para> -<Para> +<para> Here's an example which shows a version number sequence for a 6.8.x stable branch: -</Para> +</para> -<Para> -<VariableList> +<para> +<variablelist> -<VarListEntry> -<Term><Literal remap="tt">6.8.0</Literal></Term> -<ListItem> -<Para> +<varlistentry> +<term><literal remap="tt">6.8.0</literal></term> +<listitem> +<para> The 6.8 release. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.8.0.901</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.8.0.901</literal></term> +<listitem> +<para> The first pre 6.8.1 snapshot. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.8.0.903</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.8.0.903</literal></term> +<listitem> +<para> The third pre 6.8.1 snapshot, also known as the third 6.8.1 release candidate. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.8.1</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.8.1</literal></term> +<listitem> +<para> The 6.8.1 release. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.8.1.901</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.8.1.901</literal></term> +<listitem> +<para> The first pre 6.8.2 snapshot. -</Para> -</ListItem> -</VarListEntry> -<VarListEntry> -<Term><Literal remap="tt">6.8.2</Literal></Term> -<ListItem> -<Para> +</para> +</listitem> +</varlistentry> +<varlistentry> +<term><literal remap="tt">6.8.2</literal></term> +<listitem> +<para> The 6.8.2 release. -</Para> -</ListItem> -</VarListEntry> -</VariableList> -</Para> +</para> +</listitem> +</varlistentry> +</variablelist> +</para> -</Sect2> +</sect2> -</Sect1> +</sect1> -<Sect1> -<Title>Finding the X.Org X Server Version From a Client</Title> +<sect1> +<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 +<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 this value wasn't set correctly. The rules for interpreting this value as well as the known exceptions are outlined here. -</Para> +</para> -<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 * 10000000 + m * 100000 + P * 1000 + s</Literal>. -</Para> +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 * 10000000 + m * 100000 + P * 1000 + s</literal>. +</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. -</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. +</para> -<Para> +<para> -<Screen> +<programlisting> if (strstr(ServerVendor(dpy), "X.Org")) { int vendrel = VendorRelease(dpy); @@ -289,10 +289,10 @@ how the <Literal remap="tt">VendorRelease</Literal> information can be interpret printf(".%d", vendrel % 1000); } } -</Screen> +</programlisting> -</Para> +</para> -</Sect1> +</sect1> -</Article> +</article> diff --git a/sgml/Makefile.am b/sgml/Makefile.am index 6647267..68fb762 100644 --- a/sgml/Makefile.am +++ b/sgml/Makefile.am @@ -21,9 +21,3 @@ # Process this file with autoconf to create configure. SUBDIRS = platforms - -x11docdir = $(docdir) -SGML_FILES = \ - Versions.sgml - -include $(top_srcdir)/sgmlrules.in |