Author: hibou
Date: Mon Dec 20 11:03:10 2010
New Revision: 1051064
URL: http://svn.apache.org/viewvc?rev=1051064&view=rev
Log:
Add a notice about the experimental state of the OSGi capabilities of Ivy
Modified:
ant/ivy/core/trunk/doc/osgi.html
ant/ivy/core/trunk/doc/osgi/eclipse-plugin.html
ant/ivy/core/trunk/doc/osgi/standard-osgi.html
ant/ivy/core/trunk/doc/osgi/target-platform.html
ant/ivy/core/trunk/doc/style/style.css
Modified: ant/ivy/core/trunk/doc/osgi.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/osgi.html?rev=1051064&r1=1051063&r2=1051064&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/osgi.html (original)
+++ ant/ivy/core/trunk/doc/osgi.html Mon Dec 20 11:03:10 2010
@@ -28,13 +28,17 @@
Since Apache Ivy™ 2.3, some support for OSGi™ dependency management
has been introduced.
+<div class="notice">
+ Note that this feature is considered as <b>experimental</b>. It should
work with simple configuration but may not in complex ones. If you have any
issue with that feature, you are welcomed to come discussed your use case on
the <a href="http://ant.apache.org/ivy/mailing-lists.html";>ivy-user</a> mailing
list, or discuss about implementation issues or improvement you may have found
on <a href="http://ant.apache.org/ivy/mailing-lists.html";>ant-dev</a>.
+</div>
+
So with a standard ivy.xml, you can express some dependency on some OSGi
bundle and every of their trasitive dependencies will be resolved. You can also
declare in your ivy.xml some OSGi dependency, like a <tt>Require-Bundle</tt>,
an <tt>Import-Package</tt> or an <tt>Import-Service</tt>, miming an OSGi
MANIFEST.MF.
<h2>Note on the implementation</h2>
With OSGi we can declare different kind of capabilites of a bundle which can
match different kind of requirements of some other bundles
(<tt>Require-Bundle</tt>/<tt>Bundle-SymbolicName</tt>,
<tt>Import-Package</tt>/<tt>Export-Package</tt>,
<tt>Import-Service</tt>/<tt>Export-Service</tt>). In Ivy we only have one kind
of requirement and one kind of capability: the symbolic name of the bundle. Due
to that restriction Ivy may not resolve exactly how we would expect with OSGi.
The runtime of Ivy won't be as smart as a pure OSGi dependency manager. But we
think that the mapping is working for most of the use cases involing OSGi
dependencies management.
-Details on the mapping of the OSGi dependency model into Ivy's one can be
found in that <a href="osgi/osgi-mapping.html">page<a>.
+Details on the mapping of the OSGi dependency model into Ivy's one can be
found in that <a href="osgi/osgi-mapping.html">page</a>.
<h2>Repository descriptor based resolvers</h2>
Modified: ant/ivy/core/trunk/doc/osgi/eclipse-plugin.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/osgi/eclipse-plugin.html?rev=1051064&r1=1051063&r2=1051064&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/osgi/eclipse-plugin.html (original)
+++ ant/ivy/core/trunk/doc/osgi/eclipse-plugin.html Mon Dec 20 11:03:10 2010
@@ -26,6 +26,10 @@
<body>
<textarea id="xooki-source">
+<div class="notice">
+This documentation is describing the <b>experimental</b> OSGi capability of
Ivy. It should work with simple configuration but may not in complex ones. If
you have any issue with that feature, you are welcomed to come discussed your
use case on the <a
href="http://ant.apache.org/ivy/mailing-lists.html";>ivy-user</a> mailing list,
or discuss about implementation issues or improvement you may have found on <a
href="http://ant.apache.org/ivy/mailing-lists.html";>ant-dev</a>.
+</div>
+
This page describes how to build an Eclipse™ plugin with Apache Ivy™
and its OSGi™ capabilities.
<h1>Quick setup</h1>
Modified: ant/ivy/core/trunk/doc/osgi/standard-osgi.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/osgi/standard-osgi.html?rev=1051064&r1=1051063&r2=1051064&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/osgi/standard-osgi.html (original)
+++ ant/ivy/core/trunk/doc/osgi/standard-osgi.html Mon Dec 20 11:03:10 2010
@@ -26,6 +26,10 @@
<body>
<textarea id="xooki-source">
+<div class="notice">
+This documentation is describing the <b>experimental</b> OSGi capability of
Ivy. It should work with simple configuration but may not in complex ones. If
you have any issue with that feature, you are welcomed to come discussed your
use case on the <a
href="http://ant.apache.org/ivy/mailing-lists.html";>ivy-user</a> mailing list,
or discuss about implementation issues or improvement you may have found on <a
href="http://ant.apache.org/ivy/mailing-lists.html";>ant-dev</a>.
+</div>
+
This page describes how to build an OSGi™ bundle with Apache Ivy™.
In this use case, we just basically want to compute a classpath to compile,
optionaly one for testing too, and then publish our bundle in a OSGi aware
repository.
In oder to produce OSGi metadata of suffient quality and to avoid maintaining
them manually, the <a href="http://www.aqute.biz/Code/Bnd";>bnd</a> tool will be
used. The approach taken is then an "Ivy file first" approach. The dependencies
will be specified in the ivy.xml file, the MANIFEST.MF being generated from the
computed classpath.
Modified: ant/ivy/core/trunk/doc/osgi/target-platform.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/osgi/target-platform.html?rev=1051064&r1=1051063&r2=1051064&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/osgi/target-platform.html (original)
+++ ant/ivy/core/trunk/doc/osgi/target-platform.html Mon Dec 20 11:03:10 2010
@@ -26,6 +26,10 @@
<body>
<textarea id="xooki-source">
+<div class="notice">
+This documentation is describing the <b>experimental</b> OSGi capability of
Ivy. It should work with simple configuration but may not in complex ones. If
you have any issue with that feature, you are welcomed to come discussed your
use case on the <a
href="http://ant.apache.org/ivy/mailing-lists.html";>ivy-user</a> mailing list,
or discuss about implementation issues or improvement you may have found on <a
href="http://ant.apache.org/ivy/mailing-lists.html";>ant-dev</a>.
+</div>
+
Building an OSGi™ bundle with standard tools like <tt>javac</tt> and a
classpath computed by Apache Ivy™ can be erroneous as these tools doesn't
take into account the package visibility enforced by the OSGi metadata. Then
switching to OSGi dedicated tools like the Eclipse™ JTD can be prefered.
This kind of tools still need a "target platform", a set of jars against to
compile and then later run. A target platform can be easily managed with Ivy
and its OSGi capabilities.
TODO
Modified: ant/ivy/core/trunk/doc/style/style.css
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/style/style.css?rev=1051064&r1=1051063&r2=1051064&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/style/style.css (original)
+++ ant/ivy/core/trunk/doc/style/style.css Mon Dec 20 11:03:10 2010
@@ -304,3 +304,9 @@ tr.homeitems a:hover {
}
.home img { border-width:0; }
+.notice {
+ padding: 5px;
+ border: 1px;
+ background-color: #FFFFCE;
+ margin: 10px;
+}
