components/x11/xorg-docs/src/Versions.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>X.Org Version Numbering Schemes</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_9276" /><meta name="description" content="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." /><style xmlns="" type="text/css">/*
   4  * Copyright (c) 2011 Gaetan Nadon
   5  * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the next
  15  * paragraph) shall be included in all copies or substantial portions of the
  16  * Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  */
  26
  27 /*
  28  * Shared stylesheet for X.Org documentation translated to HTML format
  29  * http://www.sagehill.net/docbookxsl/UsingCSS.html
  30  * http://www.w3schools.com/css/default.asp
  31  * https://addons.mozilla.org/en-US/firefox/addon/web-developer/developers
  32  * https://addons.mozilla.org/en-US/firefox/addon/font-finder/
  33  */
  34
  35 /*
  36  * The sans-serif fonts are considered more legible on a computer screen
  37  * http://dry.sailingissues.com/linux-equivalents-verdana-arial.html
  38  *
  39  */
  40 body {
  41   font-family: "Bitstream Vera Sans", "DejaVu Sans", Tahoma, Geneva, Arial, Sans-serif;
  42   /* In support of using "em" font size unit, the w3c recommended method */
  43   font-size: 100%;
  44 }
  45
  46 /*
  47  * Selection: all elements requiring mono spaced fonts.
  48  *
  49  * The family names attempt to match the proportionally spaced font
  50  * family names such that the same font name is used for both.
  51  * We'd like to use Bitstream, for example, in both proportionally and
  52  * mono spaced font text.
  53  */
  54 .command,
  55 .errorcode,
  56 .errorname,
  57 .errortype,
  58 .filename,
  59 .funcsynopsis,
  60 .function,
  61 .parameter,
  62 .programlisting,
  63 .property,
  64 .screen,
  65 .structname,
  66 .symbol,
  67 .synopsis,
  68 .type
  69 {
  70   font-family:  "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Courier, "Liberation Mono", Monospace;
  71 }
  72
  73 /*
  74  * Books have a title page, a preface, some chapters and appendices,
  75  * a glossary, an index and a bibliography, in that order.
  76  *
  77  * An Article has no preface and no chapters. It has sections, appendices,
  78  * a glossary, an index and a bibliography.
  79  */
  80
  81 /*
  82  * Selection: book main title and subtitle
  83  */
  84 div.book>div.titlepage h1.title,
  85 div.book>div.titlepage h2.subtitle {
  86   text-align: center;
  87 }
  88
  89 /*
  90  * Selection: article main title and subtitle
  91  */
  92 div.article>div.titlepage h2.title,
  93 div.article>div.titlepage h3.subtitle,
  94 div.article>div.sect1>div.titlepage h2.title,
  95 div.article>div.section>div.titlepage h2.title {
  96   text-align: center;
  97 }
  98
  99 /*
 100  * Selection: various types of authors and collaborators, individuals or corporate
 101  *
 102  * These authors are not always contained inside an authorgroup.
 103  * They can be contained inside a lot of different parent types where they might
 104  * not be centered.
 105  * Reducing the margin at the bottom makes a visual separation between authors
 106  * We specify here the ones on the title page, others may be added based on merit.
 107  */
 108 div.titlepage .authorgroup,
 109 div.titlepage .author,
 110 div.titlepage .collab,
 111 div.titlepage .corpauthor,
 112 div.titlepage .corpcredit,
 113 div.titlepage .editor,
 114 div.titlepage .othercredit {
 115   text-align: center;
 116   margin-bottom: 0.25em;
 117 }
 118
 119 /*
 120  * Selection: the affiliation of various types of authors and collaborators,
 121  * individuals or corporate.
 122  */
 123 div.titlepage .affiliation {
 124   text-align: center;
 125 }
 126
 127 /*
 128  * Selection: product release information (X Version 11, Release 7)
 129  *
 130  * The releaseinfo element can be contained inside a lot of different parent
 131  * types where it might not be centered.
 132  * We specify here the one on the title page, others may be added based on merit.
 133  */
 134 div.titlepage p.releaseinfo {
 135   font-weight: bold;
 136   text-align: center;
 137 }
 138
 139 /*
 140  * Selection: publishing date
 141  */
 142 div.titlepage .pubdate {
 143   text-align: center;
 144 }
 145
 146 /*
 147  * The legal notices are displayed in smaller sized fonts
 148  * Justification is only supported in IE and therefore not requested.
 149  *
 150  */
 151 .legalnotice {
 152   font-size: small;
 153   font-style: italic;
 154 }
 155
 156 /*
 157  * For documentation having multiple licenses, the copyright and legalnotice
 158  * elements sequence cannot instantiated multiple times.
 159  * The copyright notice and license text are therefore coded inside a legalnotice
 160  * element. The role attribute on the paragraph is used to allow styling of the
 161  * copyright notice text which should not be italicized.
 162  */
 163 p.multiLicensing {
 164   font-style: normal;
 165   font-size: medium;
 166 }
 167
 168 /*
 169  * Selection: book or article main ToC title
 170  * A paragraph is generated for the title rather than a level 2 heading.
 171  * We do not want to select chapters sub table of contents, only the main one
 172  */
 173 div.book>div.toc>p,
 174 div.article>div.toc>p {
 175   font-size: 1.5em;
 176   text-align: center;
 177 }
 178
 179 /*
 180  * Selection: major sections of a book or an article
 181  *
 182  * Unlike books, articles do not have a titlepage element for appendix.
 183  * Using the selector "div.titlepage h2.title" would be too general.
 184  */
 185 div.book>div.preface>div.titlepage h2.title,
 186 div.book>div.chapter>div.titlepage h2.title,
 187 div.article>div.sect1>div.titlepage h2.title,
 188 div.article>div.section>div.titlepage h2.title,
 189 div.book>div.appendix>div.titlepage h2.title,
 190 div.article>div.appendix h2.title,
 191 div.glossary>div.titlepage h2.title,
 192 div.index>div.titlepage h2.title,
 193 div.bibliography>div.titlepage h2.title {
 194    /* Add a border top over the major parts, just like printed books */
 195    /* The Gray color is already used for the ruler over the main ToC. */
 196   border-top-style: solid;
 197   border-top-width: 2px;
 198   border-top-color: Gray;
 199   /* Put some space between the border and the title */
 200   padding-top: 0.2em;
 201   text-align: center;
 202 }
 203
 204 /*
 205  * A Screen is a verbatim environment for displaying text that the user might
 206  * see on a computer terminal. It is often used to display the results of a command.
 207  *
 208  * http://www.css3.info/preview/rounded-border/
 209  */
 210 .screen {
 211   background: #e0ffff;
 212   border-width: 1px;
 213   border-style: solid;
 214   border-color: #B0C4DE;
 215   border-radius: 1.0em;
 216   /* Browser's vendor properties prior to CSS 3 */
 217   -moz-border-radius: 1.0em;
 218   -webkit-border-radius: 1.0em;
 219   -khtml-border-radius: 1.0em;
 220   margin-left: 1.0em;
 221   margin-right: 1.0em;
 222   padding: 0.5em;
 223 }
 224
 225 /*
 226  * Emphasis program listings with a light shade of gray similar to what
 227  * DocBook XSL guide does: http://www.sagehill.net/docbookxsl/ProgramListings.html
 228  * Found many C API docs on the web using like shades of gray.
 229  */
 230 .programlisting {
 231   background: #F4F4F4;
 232   border-width: 1px;
 233   border-style: solid;
 234   border-color: Gray;
 235   padding: 0.5em;
 236 }
 237
 238 /*
 239  * Emphasis functions synopsis using a darker shade of gray.
 240  * Add a border such that it stands out more.
 241  * Set the padding so the text does not touch the border.
 242  */
 243 .funcsynopsis, .synopsis {
 244   background: #e6e6fa;
 245   border-width: 1px;
 246   border-style: solid;
 247   border-color: Gray;
 248   clear: both;
 249   margin: 0.5em;
 250   padding: 0.25em;
 251 }
 252
 253 /*
 254  * Selection: paragraphs inside synopsis
 255  *
 256  * Removes the default browser margin, let the container set the padding.
 257  * Paragraphs are not always used in synopsis
 258  */
 259 .funcsynopsis p,
 260 .synopsis p {
 261   margin: 0;
 262   padding: 0;
 263 }
 264
 265 /*
 266  * Selection: variable lists, informal tables and tables
 267  *
 268  * Note the parameter name "variablelist.as.table" in xorg-xhtml.xsl
 269  * A table with rows and columns is constructed inside div.variablelist
 270  *
 271  * Set the left margin so it is indented to the right
 272  * Display informal tables with single line borders
 273  */
 274 table {
 275   margin-left: 0.5em;
 276   border-collapse: collapse;
 277 }
 278
 279 /*
 280  * Selection: paragraphs inside tables
 281  *
 282  * Removes the default browser margin, let the container set the padding.
 283  * Paragraphs are not always used in tables
 284  */
 285 td p {
 286   margin: 0;
 287   padding: 0;
 288 }
 289
 290 /*
 291  * Add some space between the left and right column.
 292  * The vertical alignment helps the reader associate a term
 293  * with a multi-line definition.
 294  */
 295 td, th {
 296   padding-left: 1.0em;
 297   padding-right: 1.0em;
 298   vertical-align: top;
 299 }
 300
 301 .warning {
 302   border: 1px solid red;
 303   background: #FFFF66;
 304   padding-left: 0.5em;
 305 }
 306 </style></head><body><div class="article"><div class="titlepage"><div><div><h2 class="title"><a id="Versions"></a>X.Org Version Numbering Schemes</h2></div><div><h3 class="corpauthor">
 307 The XFree86 Project, Inc
 308 </h3></div><div><h3 class="corpauthor">
 309 Updated for X.Org by Keith Packard, Kevin E. Martin, and Alan Coopersmith
 310 </h3></div><div><p class="pubdate">November 2010</p></div><div><div class="abstract"><p>
 311 X.Org has adopted the same basic numbering scheme used by the XFree86
 312 Project, Inc. for their releases.  The actual numbers are different, but the
 313 basic scheme is the same.  This document reflects the policy that X.Org uses.
 314 </p></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="sect1"><a href="#Module_Versions">Module Versions</a></span></dt><dt><span class="sect1"><a href="#Releases_Development_Streams_and_Branches">Releases, Development Streams, and Branches</a></span></dt><dt><span class="sect1"><a href="#Current_Version_Numbering_Scheme">Current Version Numbering Scheme</a></span></dt><dd><dl><dt><span class="sect2"><a href="#Development_Branch">Development Branch</a></span></dt><dt><span class="sect2"><a href="#Stable_Branch">Stable Branch</a></span></dt></dl></dd><dt><span class="sect1"><a href="#Finding_the_X.Org_X_Server_Version_From_a_Client">Finding the X.Org X Server Version From a Client</a></span></dt></dl></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Module_Versions"></a>Module Versions</h2></div></div></div><p>
 315 Starting with the X11R7.0 release, each module has its own version number.
 316 For those without a natural starting point, the version numbers started at
 317 1.0.   For instance, the X11R7.0 release included the xorg-server 1.0
 318 module.   As modules are released independently from the rest of the
 319 window system, the module version is the most accurate source of version
 320 information.   For instance, there are many X server releases in a year,
 321 but generally only one window system release, so an X server version number
 322 such as 1.7.7 is more informative than the X11R7.5 version for the window
 323 system <span class="quote">“<span class="quote">katamari</span>”</span> release.
 324 </p><p>
 325 Unfortunately, up through the X server 1.3 release, the X server
 326 used the Window System version when reporting its version number
 327 in log files, the -version option, and the connection setup string
 328 (displayed by xdpyinfo).   This was corrected with X server 1.3, which
 329 caused the visible version number string to appear to jump backwards
 330 from 7.2 to 1.3.
 331 </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Releases_Development_Streams_and_Branches"></a>Releases, Development Streams, and Branches</h2></div></div></div><p>
 332 X.Org has two release branches for the X server software, and several
 333 other modules with active ongoing development.
 334 First is the trunk of the git repository.  This is
 335 the main development stream, where all new work and work for future
 336 releases is done.
 337 </p><p>
 338 Second is the stable bugfix branch for the latest full release.  It is
 339 created around the time of the release.  The branch will be named for the
 340 release version, such as <span class="quote">“<span class="quote"><code class="literal">server-1.9-branch</code></span>”</span>
 341 for the X server 1.9.x series of releases.
 342 Fixes for bugs found in the release will be added to this branch (as
 343 well as the trunk), and updates to this release (if any) will be cut
 344 from this branch.  Similar stable branches are present for previous full
 345 releases.
 346 </p><p>
 347 The X.Org Foundation is planning to make full releases from the main
 348 development stream at regular intervals in the 6-12 month range.  The
 349 feature freezes for these releases will usually be 2-3 months before the
 350 release dates.  This general plan is a goal, not a binding commitment.
 351 The actual release intervals and dates will depend to a large degree on
 352 the resource available to X.Org.
 353 Update/bugfix releases will be made on an as-required basis,
 354 depending also on the availability of resources, and will generally be
 355 limited to serious bug and security fixes.  New features will not
 356 usually be added in update releases.
 357 </p><p>
 358 Aside from actual releases, snapshots of the active release branches
 359 are tagged in the git repository from time to time.  Each such snapshot
 360 has an identifiable version number.
 361 </p></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Current_Version_Numbering_Scheme"></a>Current Version Numbering Scheme</h2></div></div></div><p>
 362 Starting with the main development branch after X11R6.7, the X.Org
 363 versions are numbered according to the scheme outlined here.
 364 </p><p>
 365 The version numbering format is <code class="literal">M.m.P.s</code>,
 366 where <em class="replaceable"><code>M</code></em> is the major version number,
 367 <em class="replaceable"><code>m</code></em> is the minor version number,
 368 <em class="replaceable"><code>P</code></em> is the patch level, and
 369 <em class="replaceable"><code>s</code></em> is the snapshot number.
 370 Full releases have <em class="replaceable"><code>P</code></em> set to zero, and it is
 371 incremented for each subsequent bug fix release on the post-release
 372 stable branch.  The snapshot number <em class="replaceable"><code>s</code></em> is
 373 present only for between-release snapshots of the development and
 374 stable branches.
 375 </p><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Development_Branch"></a>Development Branch</h3></div></div></div><p>
 376 Immediately after forming a release stable branch, the patch level
 377 number for the main development branch is bumped to 99, and the snapshot
 378 number is reset.  The snapshot number is incremented for each tagged
 379 development snapshot.  The git tag for snapshots is
 380 <span class="quote">“<span class="quote"><code class="literal">xorg-server-M.m.P.s</code></span>”</span>.
 381 When the development branch enters feature
 382 freeze, the snapshot number is bumped to 900.  A stable branch may be
 383 created for the next full release at any time after the feature freeze.
 384 When it is, the branch is called
 385 <span class="quote">“<span class="quote"><code class="literal">server-M.m-branch</code></span>”</span>.  The
 386 snapshot number is incremented from there until the release is
 387 finalised.  Each of these snapshots is a <span class="quote">“<span class="quote">release candidate</span>”</span>.  When the
 388 release is finalised, the minor version is incremented, the patch level
 389 is set to zero, and the snapshot number removed.
 390 </p><p>
 391 Here's an example which shows the version number sequence for the
 392 development leading up to version 1.8:
 393 </p><p>
 394 </p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /></colgroup><tbody><tr><td><p><span class="term"><code class="literal">1.7.99.1</code></span></p></td><td><p>
 395 The first snapshot of the pre-1.8 development branch.
 396 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.7.99.23</code></span></p></td><td><p>
 397 The twenty-third snapshot of the pre-1.8 development branch.
 398 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.7.99.900</code></span></p></td><td><p>
 399 The start of the 1.8 feature freeze.
 400 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.7.99.903</code></span></p></td><td><p>
 401 The third 1.8 release candidate.
 402 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.8.0</code></span></p></td><td><p>
 403 The 1.8 release.
 404 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.8.99.1</code></span></p></td><td><p>
 405 The first pre-1.9 development snapshot, which  is the first main
 406 branch snapshot after creating the 1.8 stable branch.
 407 </p></td></tr></tbody></table></div><p>
 408 </p></div><div class="sect2"><div class="titlepage"><div><div><h3 class="title"><a id="Stable_Branch"></a>Stable Branch</h3></div></div></div><p>
 409 After a full release, the stable branch for the release will be
 410 maintained with bug fixes and important updates until the next full
 411 release.  Any snapshots on this branch are considered <span class="quote">“<span class="quote">release
 412 candidates,</span>”</span> which is indicated by setting <em class="replaceable"><code>s</code></em>
 413 to a number above
 414 900.  The snapshot number is incremented for each release candidate
 415 until the update release is finalised.  The patch level value
 416 (<em class="replaceable"><code>P</code></em>) is incremented for each update release.
 417 </p><p>
 418 Here's an example which shows a version number sequence for a 1.8.x
 419 stable branch:
 420 </p><p>
 421 </p><div class="variablelist"><table border="0" class="variablelist"><colgroup><col align="left" valign="top" /></colgroup><tbody><tr><td><p><span class="term"><code class="literal">1.8.0</code></span></p></td><td><p>
 422 The 1.8 release.
 423 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.8.0.901</code></span></p></td><td><p>
 424 The first pre 1.8.1 snapshot.
 425 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.8.0.903</code></span></p></td><td><p>
 426 The third pre 1.8.1 snapshot, also known as the third 1.8.1 release
 427 candidate.
 428 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.8.1</code></span></p></td><td><p>
 429 The 1.8.1 release.
 430 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.8.1.901</code></span></p></td><td><p>
 431 The first pre 1.8.2 snapshot.
 432 </p></td></tr><tr><td><p><span class="term"><code class="literal">1.8.2</code></span></p></td><td><p>
 433 The 1.8.2 release.
 434 </p></td></tr></tbody></table></div><p>
 435 </p></div></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Finding_the_X.Org_X_Server_Version_From_a_Client"></a>Finding the X.Org X Server Version From a Client</h2></div></div></div><p>
 436 The X.Org X servers report a <code class="function">VendorRelease</code> value that
 437 matches the X.Org version number.  There have been some cases of releases where
 438 this value wasn't set correctly.  The rules for interpreting this value
 439 as well as the known exceptions are outlined here.
 440 </p><p>
 441 As noted above, the version reported by <code class="function">VendorRelease</code>
 442 changed from the window system version to the X server version starting in
 443 the xorg-server 1.3 release.
 444 </p><p>
 445 For all X.Org development and release versions using this numbering
 446 scheme, the <code class="function">VendorRelease</code> value is
 447 <em class="replaceable"><code>MMmmPPsss</code></em>.  That is, version
 448 <em class="replaceable"><code>M.m.P.s</code></em> has <code class="function">VendorRelease</code> set to
 449 <code class="code">M * 10000000 + m * 100000 + P * 1000 + s</code>.
 450 </p><p>
 451 The following is a code fragment taken from <code class="filename">xdpyinfo.c</code>
 452 that shows how the <code class="function">VendorRelease</code> information can be
 453 interpreted.
 454 </p><p>
 455
 456 </p><pre class="programlisting">
 457     if (strstr(ServerVendor(dpy), "X.Org")) {
 458         int vendrel = VendorRelease(dpy);
 459
 460         printf("X.Org version: ");
 461         printf("%d.%d.%d", vendrel / 10000000,
 462                (vendrel /   100000) % 100,
 463                (vendrel /     1000) % 100);
 464         if (vendrel % 1000) {
 465             printf(".%d", vendrel % 1000);
 466         }
 467     }
 468 </pre><p>
 469
 470 </p></div></div></body></html>