incubator-sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r905021 - in /websites/staging/sling/trunk/content: ./ documentation/development/version-policy.html
Date Sat, 05 Apr 2014 14:03:09 GMT
Author: buildbot
Date: Sat Apr  5 14:03:09 2014
New Revision: 905021

Log:
Staging update by buildbot for sling

Modified:
    websites/staging/sling/trunk/content/   (props changed)
    websites/staging/sling/trunk/content/documentation/development/version-policy.html

Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sat Apr  5 14:03:09 2014
@@ -1 +1 @@
-1584567
+1585095

Modified: websites/staging/sling/trunk/content/documentation/development/version-policy.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/development/version-policy.html (original)
+++ websites/staging/sling/trunk/content/documentation/development/version-policy.html Sat
Apr  5 14:03:09 2014
@@ -125,7 +125,7 @@ Please note that this page is currently 
 <p>The exports in bundle/api/pom.xml look like they might become problematic from a
support point of view, although we probably can't avoid this. [...] [The problem is the] manual
maintenance of the version numbers. (not a big problem but needs to be done)</p>
 </blockquote>
 <p>I agree, that this is a problem. So let me reasonate on this a bit ;-)</p>
-<p>As a reference you might want to read <a href="http://blog.meschberger.ch/2009/10/on-version-numbers.html">my
blog post on version numbers</a> and also what the [Eclipse guys have to say|http://wiki.eclipse.org/index.php/Version_Numbering]
(great read, btw). The OSGi Alliance has come up with a good definition for [Semantic Versioning|http://www.osgi.org/wiki/uploads/Links/SemanticVersioning.pdf]
to which the definitions described below perfectly match.</p>
+<p>As a reference you might want to read <a href="http://blog.meschberger.ch/2009/10/on-version-numbers.html">my
blog post on version numbers</a> and also what the <a href="http://wiki.eclipse.org/index.php/Version_Numbering">Eclipse
guys have to say</a> (great read, btw). The OSGi Alliance has come up with a good definition
for <a href="http://www.osgi.org/wiki/uploads/Links/SemanticVersioning.pdf">Semantic
Versioning</a> to which the definitions described below perfectly match.</p>
 <p>For Sling we have three kinds of version numbers:</p>
 <ol>
 <li>Big Sling Releases</li>
@@ -133,7 +133,7 @@ Please note that this page is currently 
 <li>Package Exports</li>
 </ol>
 <h3 id="big-sling-releases">Big Sling Releases</h3>
-<p>For <em>Big Sling releases</em> we already have an ample solution in
that we just use a single number increased from release to release. Just remember that a <em>Big
Sling release</em> is a convenience release of existing released Sling bundles.</p>
+<p>For <em>Big Sling Releases</em> we already have an ample solution in
that we just use a single number increased from release to release. Just remember that a <em>Big
Sling Release</em> is a convenience release of existing released Sling bundles.</p>
 <h3 id="sling-bundles">Sling Bundles</h3>
 <p>For <em>Sling Bundles</em> version numbers are just defined as the <code>&lt;version&gt;</code>
element of the bundle's POM. The only restriction here is, that we decided to use even numbers
for releases and odd numbers for SNAPSHOTs. Whether and when which version part is increased
is not explicitly defined yet.</p>
 <h3 id="package-exports">Package Exports</h3>
@@ -143,9 +143,9 @@ Please note that this page is currently 
 <li>Explicitly in the <code>&lt;Export-Package&gt;</code> element
of the Maven Bundle Plugin configuration</li>
 <li>By reference to the bundle version number using the <code>${pom.version}</code>
variable.</li>
 </ul>
-<p>Upto now, we mostly used the <code>${pom.version}</code> notation linking
the exported package version to the bundle version. Over time this mechanism leads to a number
of problems:</p>
+<p>Up to now, we mostly used the <code>${pom.version}</code> notation linking
the exported package version to the bundle version. Over time this mechanism leads to a number
of problems:</p>
 <ul>
-<li>For bundles with more than one package exported, the exported packages will evolve
independently. As a consequence their versionin should also evolve independently. An example
of such a bundle is the Sling API bundle of course.</li>
+<li>For bundles with more than one package exported, the exported packages will evolve
independently. As a consequence their versioning should also evolve independently. An example
of such a bundle is the Sling API bundle of course.</li>
 <li>Linking the package export version number to the bundle version number confuses
the actual semantics of both version numbers. The package export version number only indicates
the version of the actual package while the bundle version number indicates a development
state of the overall bundle. This will generally not be the same.</li>
 <li>The version of the exported package is increased on each bundle release, even though
nothing may have changed on the export. In such a situation the version of the export should
stay the same.</li>
 </ul>
@@ -172,13 +172,13 @@ Please note that this page is currently 
 
 <p>See <a href="http://www.aqute.biz/Bnd/Versioning">BND Versioning</a>
for details.</p>
 <h2 id="version-number-syntax">Version Number Syntax</h2>
-<p>As a small reminder, this is how a version number is constructed:  In OSGi version
numbers are composed of four (4) segments: 3 integers and a string named major.minor.micro.qualifier.</p>
+<p>As a small reminder, this is how a version number is constructed:  In OSGi version
numbers are composed of four (4) segments: three integers and one string named <em>major</em>.<em>minor</em>.<em>micro</em>.<em>qualifier</em>.</p>
 <p>Each segment captures a different intent:</p>
 <ul>
 <li>the major segment indicates breakage in the API</li>
 <li>the minor segment indicates <em>externally visible</em> changes</li>
 <li>the micro segment indicates bug fixes</li>
-<li>the qualifier segment is not generally used but may be used to convey more information
about a particular build, such as a build time or an SVN revision number.</li>
+<li>the qualifier segment is not generally used but may be used to convey more information
about a particular build, such as a build time or a SVN revision number.</li>
 </ul>
 <h2 id="evolution-of-exported-package-versions">Evolution of Exported Package Versions</h2>
 <p>Version numbers of exported packages evolve independently from each other. Depending
on the changes applied, the micro, minor, or major segement is increased. Whenever the major
segment is increased, the minor and micro segments are reset to zero. Whenever the minor segment
is increased, the micro segment is reset to zero.</p>
@@ -318,7 +318,7 @@ Please note that this page is currently 
 
 <p>This allows for the implementation to work correctly with bug fixed package exports
but as soon as there are any <em>externally visible</em> changes, the implementation
bundle has to be adapted -- even if this just means increasing the upper version bound in
the <code>Import-Package</code> statement thus guaranteeing compliance (again).</p>
 <h3 id="future_1">Future</h3>
-<p>Recent versions of the BND library support automatic differntiation between use
and implementation of API and to set the import version ranges accordingly. See <a href="http://www.aqute.biz/Bnd/Versioning">BND
Versioning</a> for details.</p>
+<p>Recent versions of the BND library support automatic differentiation between <em>use</em>
and <em>implementation</em> of API and to set the import version ranges accordingly.
See <a href="http://www.aqute.biz/Bnd/Versioning">BND Versioning</a> for details.</p>
 <h2 id="references">References</h2>
 <ul>
 <li><a href="http://markmail.org/thread/zshobgjwtqrncajt">Version Numbers</a>
-- The mail thread discussing version numbering</li>
@@ -328,7 +328,7 @@ Please note that this page is currently 
 <li><a href="http://www.aqute.biz/Bnd/Versioning">BND Versioning</a> --
Describes how the BND library used by the Maven Bundle plugin supports package versioning</li>
 </ul>
       <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
-        Rev. 1500501 by fmeschbe on Sun, 7 Jul 2013 18:49:51 +0000
+        Rev. 1585095 by olli on Sat, 5 Apr 2014 14:02:59 +0000
       </div>
       <div class="trademarkFooter"> 
         Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project



Mime
View raw message