felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From djen...@apache.org
Subject svn commit: r1597831 - /felix/site/trunk/content/documentation/development/provisional-osgi-api-policy.mdtext
Date Tue, 27 May 2014 17:24:11 GMT
Author: djencks
Date: Tue May 27 17:24:10 2014
New Revision: 1597831

URL: http://svn.apache.org/r1597831
Log:
Correct OSGi capitalization and try to get sub-list to render differently

Modified:
    felix/site/trunk/content/documentation/development/provisional-osgi-api-policy.mdtext

Modified: felix/site/trunk/content/documentation/development/provisional-osgi-api-policy.mdtext
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/development/provisional-osgi-api-policy.mdtext?rev=1597831&r1=1597830&r2=1597831&view=diff
==============================================================================
--- felix/site/trunk/content/documentation/development/provisional-osgi-api-policy.mdtext
(original)
+++ felix/site/trunk/content/documentation/development/provisional-osgi-api-policy.mdtext
Tue May 27 17:24:10 2014
@@ -1,21 +1,19 @@
-Title: Provisional OSGI API Policy
+Title: Provisional OSGi API Policy
 
-##Overview
-The OSGi Alliance exposes provisional API that may or may not become part of future OSGI
specifications.  This policy explains how and when Felix subprojects may relate to such API.
Provisional OSGi API refers to anything in the `org.osgi.*` package namespace that is not
part of a final released specification.
+The OSGi Alliance exposes provisional API that may or may not become part of future OSGi
specifications.  This policy explains how and when Felix subprojects may relate to such API.
Provisional OSGi API refers to anything in the `org.osgi.*` package namespace that is not
part of a final released specification.
 
 ## Policy
-1. No Felix release may contain or refer to provisional OSGI API.
-1. 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.
-
+1. No Felix release may contain or refer to provisional OSGi API.
+1. 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.
 1. Although it is STRONGLY NOT RECOMMENDED, modified versions of provisional api may be released
with these modifications:
 
- 1. Any provisional OSGi API must be recreated in the `org.apache.felix.*` package name space;
this effectively makes it provisional Felix API.
- 1. All Felix provisional API must be marked as deprecated.
- 1. All Felix provisional API exported from bundles should be exported with a mandatory attribute
of `status="provisional"`.
+* Any provisional OSGi API must be recreated in the `org.apache.felix.*` package name space;
this effectively makes it provisional Felix API.
+* All Felix provisional API must be marked as deprecated.
+* All Felix provisional API exported from bundles should be exported with a mandatory attribute
of `status="provisional"`.
 
 ## Discussion
 
-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.
+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.
 
 As an example, to provisionally export the `org.apache.felix.service.metatype` package, the
 `Export-Package` statement would look something like this:
@@ -25,4 +23,4 @@ As an example, to provisionally export t
       org.apache.felix.service.metatype; version="0.1"; mandatory="status"; status="provisional"
     </Export-Package>
 
-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.
+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.



Mime
View raw message