felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r910136 - in /websites/staging/felix/trunk/content: ./ documentation/development/provisional-osgi-api-policy.html
Date Tue, 27 May 2014 17:33:58 GMT
Author: buildbot
Date: Tue May 27 17:33:57 2014
New Revision: 910136

Log:
Staging update by buildbot for felix

Modified:
    websites/staging/felix/trunk/content/   (props changed)
    websites/staging/felix/trunk/content/documentation/development/provisional-osgi-api-policy.html

Propchange: websites/staging/felix/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue May 27 17:33:57 2014
@@ -1 +1 @@
-1597831
+1597832

Modified: websites/staging/felix/trunk/content/documentation/development/provisional-osgi-api-policy.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/development/provisional-osgi-api-policy.html
(original)
+++ websites/staging/felix/trunk/content/documentation/development/provisional-osgi-api-policy.html
Tue May 27 17:33:57 2014
@@ -75,13 +75,13 @@
 <li>Provisional API may be included and used in unreleased source code, however the
API must be part of a final released OSGi specification before this Felix source may be released.</li>
 <li>
 <p>Although it is STRONGLY NOT RECOMMENDED, modified versions of provisional api may
be released with these modifications:</p>
-</li>
-<li>
-<p>Any provisional OSGi API must be recreated in the <code>org.apache.felix.*</code>
package name space; this effectively makes it provisional Felix API.</p>
-</li>
+<ol>
+<li>Any provisional OSGi API must be recreated in the <code>org.apache.felix.*</code>
package name space; this effectively makes it provisional Felix API.</li>
 <li>All Felix provisional API must be marked as deprecated.</li>
 <li>All Felix provisional API exported from bundles should be exported with a mandatory
attribute of <code>status="provisional"</code>.</li>
 </ol>
+</li>
+</ol>
 <h2 id="discussion">Discussion</h2>
 <p>The first goal of this policy is to completely avoid using provisional OSGi API
in released Felix projects given the potential confusion and questions by doing so. The second
goal is to make the existence of any released Felix provisional API completely obvious to
downstream users and make it difficult for them to use it unknowingly. However, any such release
is likely to involve numerous problems such as incorrect semantic versioning or version mismatch
between the provisional and eventual OSGi release and bundle version inflation if the Felix
provisional api is removed after the OSGi API is released.</p>
 <p>As an example, to provisionally export the <code>org.apache.felix.service.metatype</code>
package, the
@@ -94,7 +94,7 @@
 
 <p>When working with new OSGi specifications, constructing a Felix provisional API
will likely result in parallel package structures between the provisional OSGi and Felix APIs.
When working with existing specifications, it may be necessary to create extensions to existing
OSGi interfaces in the Felix package namespace.</p>
       <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
-        Rev. 1597831 by djencks on Tue, 27 May 2014 17:24:10 +0000
+        Rev. 1597832 by djencks on Tue, 27 May 2014 17:33:45 +0000
       </div>
       <div class="trademarkFooter"> 
         Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project



Mime
View raw message