Author: mcculls
Date: Sat May 3 01:13:09 2008
New Revision: 653014
URL: http://svn.apache.org/viewvc?rev=653014&view=rev
Log:
Update documentation
Added:
felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd.html
- copied, changed from r653012,
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html
felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd_files/
- copied from r653012,
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/
felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd_files/button.html
(with props)
Removed:
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html
felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd_files/
Modified:
felix/trunk/bundleplugin/doc/changelog.txt
Copied: felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd.html
(from r653012, felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html)
URL:
http://svn.apache.org/viewvc/felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd.html?p2=felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd.html&p1=felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html&r1=653012&r2=653014&rev=653014&view=diff
==============================================================================
--- felix/trunk/bundleplugin/doc/maven-bundle-plugin-bnd.html (original)
+++ felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd.html Sat
May 3 01:13:09 2008
@@ -1,37 +1,32 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
-<html><head><title>Apache Felix - Maven Bundle Plugin (BND)</title>
+<html><head><title>Apache Felix - Apache Felix Maven Bundle Plugin
(BND)</title>
- <link rel="stylesheet" href="maven-bundle-plugin-bnd_files/site.css"
type="text/css" media="all">
+ <link rel="stylesheet"
href="apache-felix-maven-bundle-plugin-bnd_files/site.css" type="text/css"
media="all">
<meta http-equiv="Content-Type"
content="text/html;charset=UTF-8"></head><body>
- <div class="title"><div class="logo"><a
href="http://felix.apache.org/site/index.html";><img alt="Apache Felix"
src="maven-bundle-plugin-bnd_files/logo.png" border="0"></a></div><div
class="header"><a href="http://www.apache.org/";><img alt="Apache"
src="maven-bundle-plugin-bnd_files/apache.png" border="0"></a></div></div>
+ <div class="title"><div class="logo"><a
href="http://felix.apache.org/site/index.html";><img alt="Apache Felix"
src="apache-felix-maven-bundle-plugin-bnd_files/logo.png"
border="0"></a></div><div class="header"><a href="http://www.apache.org/";><img
alt="Apache" src="apache-felix-maven-bundle-plugin-bnd_files/apache.png"
border="0"></a></div></div>
<div class="menu">
<ul>
- <li><a href="http://felix.apache.org/site/index.html";
title="Index">home</a></li>
<li><a href="http://felix.apache.org/site/news.html";
title="news">news</a></li>
- <li><a href="http://felix.apache.org/site/status.html";
title="status">status</a></li>
<li><a href="http://felix.apache.org/site/license.html";
title="license">license</a></li>
- <li><span class="nobr"><a
href="http://felix.apache.org/site/downloads.cgi"; title="Visit page outside
Confluence" rel="nofollow">downloads<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle"
border="0" height="7" width="7"></sup></a></span></li>
+ <li><span class="nobr"><a
href="http://felix.apache.org/site/downloads.cgi"; title="Visit page outside
Confluence" rel="nofollow">downloads<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span></li>
<li><a href="http://felix.apache.org/site/documentation.html";
title="documentation">documentation</a></li>
<li><a href="http://felix.apache.org/site/mailinglists.html";
title="mailinglists">mailing lists</a></li>
- <li><span class="nobr"><a
href="http://cwiki.apache.org/confluence/x/O-"; title="Visit page outside
Confluence" rel="nofollow">wiki<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle"
border="0" height="7" width="7"></sup></a></span></li>
- <li><a href="http://felix.apache.org/site/committers.html";
title="committers">committers</a></li>
- <li><a href="http://felix.apache.org/site/faq.html";
title="faq">faq</a></li>
- <li><a href="http://felix.apache.org/site/roadmap.html";
title="roadmap">roadmap</a></li>
- <li><a href="http://felix.apache.org/site/sourcecode.html";
title="sourcecode">source code</a></li>
- <li><a href="http://felix.apache.org/site/codingstandards.html";
title="codingstandards">coding standards</a></li>
- <li><a href="http://felix.apache.org/site/issuetracking.html";
title="issuetracking">issue tracking</a></li>
- <li><a href="http://felix.apache.org/site/dependencies.html";
title="dependencies">dependencies</a></li>
- <li><span class="nobr"><a href="http://www.apache.org/"; title="Visit
page outside Confluence" rel="nofollow">apache software foundation<sup><img
class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span></li>
- <li><span class="nobr"><a
href="http://www.apache.org/foundation/sponsorship.html"; title="Visit page
outside Confluence" rel="nofollow">sponsorship<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle"
border="0" height="7" width="7"></sup></a></span></li>
- <li><span class="nobr"><a
href="http://www.apache.org/foundation/thanks.html"; title="Visit page outside
Confluence" rel="nofollow">sponsors<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle"
border="0" height="7" width="7"></sup></a></span></li>
-</ul> </div>
+ <li><a href="http://felix.apache.org/site/contributing.html";
title="Contributing">contributing</a></li>
+ <li><span class="nobr"><a href="http://www.apache.org/"; title="Visit
page outside Confluence" rel="nofollow">asf<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span></li>
+ <li><span class="nobr"><a
href="http://www.apache.org/foundation/sponsorship.html"; title="Visit page
outside Confluence" rel="nofollow">sponsorship<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span></li>
+ <li><span class="nobr"><a
href="http://www.apache.org/foundation/thanks.html"; title="Visit page outside
Confluence" rel="nofollow">sponsors<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span>
+<!-- ApacheCon Ad -->
+<iframe src="apache-felix-maven-bundle-plugin-bnd_files/button.html"
style="border-width: 0pt; float: left; display: none;" frameborder="0"
height="135" scrolling="no" width="135"></iframe>
+<p style="height: 100px;">
+<!-- ApacheCon Ad -->
+</p></li></ul> </div>
<div class="main">
-<h1><a name="MavenBundlePlugin(BND)-BundlePluginforMaven"></a>Bundle Plugin
for Maven</h1>
+<h1><a
name="ApacheFelixMavenBundlePlugin(BND)-BundlePluginforMaven"></a>Bundle Plugin
for Maven</h1>
-<p>This plugin for Maven 2 is based on the <span class="nobr"><a
href="http://www.aqute.biz/Code/Bnd"; title="Visit page outside Confluence"
rel="nofollow">BND<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle"
border="0" height="7" width="7"></sup></a></span>
+<p>This plugin for Maven 2 is based on the <span class="nobr"><a
href="http://www.aqute.biz/Code/Bnd"; title="Visit page outside Confluence"
rel="nofollow">BND<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span>
tool from Peter Kriens. The way BND works is by treating your project
as a big collection of classes (e.g., project code, dependencies, and
the class path). The way you create a bundle with BND is to tell it the
@@ -46,13 +41,13 @@
distribution. The plug-in automatically computes bundle capabilities
and requirements, using a combination of Bindex and Maven metadata.</p>
-<p><a name="MavenBundlePlugin(BND)-simpleexample"></a></p>
+<p><a name="ApacheFelixMavenBundlePlugin(BND)-simpleexample"></a></p>
-<h1><a name="MavenBundlePlugin(BND)-SimpleExample"></a>Simple Example</h1>
+<h1><a name="ApacheFelixMavenBundlePlugin(BND)-SimpleExample"></a>Simple
Example</h1>
<p>Rather than going straight to a detailed list of plugin features, we
will first look at a simple example of how to use the plugin to give an
-immediate flavor. A detailed "<a href="#MavenBundlePlugin%2528BND%2529-howto"
title="how-to on Maven Bundle Plugin (BND)">how to</a>" will follow.</p>
+immediate flavor. A detailed "<a
href="#ApacheFelixMavenBundlePlugin%2528BND%2529-howto" title="how-to on Apache
Felix Maven Bundle Plugin (BND)">how to</a>" will follow.</p>
<p>Assume that we have a simple bundle project that has a pubic API package an
several implementation packages, such as:</p>
@@ -90,16 +85,16 @@
export. If the two sets overlap, as they do in the case, then the
export takes precedence. Since we did not specify any values for any
other bundle manifest headers, they will assume default values which
-are described <a href="#MavenBundlePlugin%2528BND%2529-defaultbehavior"
title="default-behavior on Maven Bundle Plugin (BND)">below</a>. One specific
behavior to highlight is that the plugin generates the <tt>Import-Package</tt>
+are described <a
href="#ApacheFelixMavenBundlePlugin%2528BND%2529-defaultbehavior"
title="default-behavior on Apache Felix Maven Bundle Plugin (BND)">below</a>.
One specific behavior to highlight is that the plugin generates the
<tt>Import-Package</tt>
bundle manifest header based on the contents of the bundle, which means
that you generally do not ever need to explicitly specify it yourself.
That's it.</p>
-<h1><a name="MavenBundlePlugin(BND)-Features"></a>Features</h1>
+<h1><a name="ApacheFelixMavenBundlePlugin(BND)-Features"></a>Features</h1>
<p>The BND library underlying the plugin defines instructions to direct
its behavior. For this Maven plugin, these instructions are issued in
-the plugin configuration section of the POM file, as was illustrated <a
href="#MavenBundlePlugin%2528BND%2529-simpleexample" title="simple-example on
Maven Bundle Plugin (BND)">above</a>. BND recognizes three types of
instructions:</p>
+the plugin configuration section of the POM file, as was illustrated <a
href="#ApacheFelixMavenBundlePlugin%2528BND%2529-simpleexample"
title="simple-example on Apache Felix Maven Bundle Plugin (BND)">above</a>. BND
recognizes three types of instructions:</p>
<ol>
<li><em>Manifest headers</em> - Any instruction that starts with
@@ -114,13 +109,13 @@
</ol>
-<p>The remainder of this section covers the most important aspects of BND's
instructions; for complete details refer to the <span class="nobr"><a
href="http://www.aqute.biz/Code/Bnd"; title="Visit page outside Confluence"
rel="nofollow">BND documentation<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle"
border="0" height="7" width="7"></sup></a></span>.</p>
+<p>The remainder of this section covers the most important aspects of BND's
instructions; for complete details refer to the <span class="nobr"><a
href="http://www.aqute.biz/Code/Bnd"; title="Visit page outside Confluence"
rel="nofollow">BND documentation<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span>.</p>
-<p><a name="MavenBundlePlugin(BND)-instructions"></a></p>
+<p><a name="ApacheFelixMavenBundlePlugin(BND)-instructions"></a></p>
-<h2><a name="MavenBundlePlugin(BND)-Instructions"></a>Instructions</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-Instructions"></a>Instructions</h2>
-<h3><a
name="MavenBundlePlugin(BND)-{{<ExportPackage>}}"></a><tt><Export-Package></tt></h3>
+<h3><a
name="ApacheFelixMavenBundlePlugin(BND)-{{<ExportPackage>}}"></a><tt><Export-Package></tt></h3>
<p>The <tt><Export-Package></tt> instruction is a list of
packages for the bundle to export. These packages are copied into the
@@ -142,13 +137,13 @@
package version attributes, BND will also determine package versions by
examining the source JAR file or from <tt>packageinfo</tt> files in the
package directory.</p>
-<h3><a
name="MavenBundlePlugin(BND)-{{<PrivatePackage>}}"></a><tt><Private-Package></tt></h3>
+<h3><a
name="ApacheFelixMavenBundlePlugin(BND)-{{<PrivatePackage>}}"></a><tt><Private-Package></tt></h3>
<p>The <tt><Private-Package></tt> instruction is similar in every way to
the <tt><Export-Package></tt> instruction, except for the fact that these
packages will <b>not</b>
be exported by the bundle. If a package is selected by both the export
and private package headers, then the export takes precedence.</p>
-<h3><a
name="MavenBundlePlugin(BND)-{{<IncludeResource>}}"></a><tt><Include-Resource></tt></h3>
+<h3><a
name="ApacheFelixMavenBundlePlugin(BND)-{{<IncludeResource>}}"></a><tt><Include-Resource></tt></h3>
<p>The <tt><Include-Resource></tt> instruction is a list of
arbitrary resources that should be copied into the bundle JAR file. The
@@ -179,7 +174,7 @@
<p>By default the bundle plugin converts the project's Maven resource
directories into a single <tt><Include-Resource></tt> instruction. If you
specify your own <tt><Include-Resource></tt> instruction, this will
replace the generated one. To include the generated list of Maven resources in
your own <tt><Include-Resource></tt> instruction just add
{<tt>maven-resources</tt>} to the list and it will be expanded
automatically.</p>
-<h3><a
name="MavenBundlePlugin(BND)-{{<ImportPackage>}}"></a><tt><Import-Package></tt></h3>
+<h3><a
name="ApacheFelixMavenBundlePlugin(BND)-{{<ImportPackage>}}"></a><tt><Import-Package></tt></h3>
<p>The <tt><Import-Package></tt> instruction is a list of
packages that are required by the bundle's contained packages. The
@@ -189,9 +184,9 @@
be removed by using a negation package pattern. The package patterns
work in the same way as for <tt><Export-Package></tt>, which means they
are ordered. For example, if you wanted to import all packages except
<tt>org.foo.impl</tt> you would specify "<tt>!org.foo.impl,*</tt>"</p>
-<p><a name="MavenBundlePlugin(BND)-defaultbehavior"></a></p>
+<p><a name="ApacheFelixMavenBundlePlugin(BND)-defaultbehavior"></a></p>
-<h2><a name="MavenBundlePlugin(BND)-DefaultBehavior"></a>Default Behavior</h2>
+<h2><a name="ApacheFelixMavenBundlePlugin(BND)-DefaultBehavior"></a>Default
Behavior</h2>
<p>To use this plugin, very little information is required by BND. As
part of the Maven integration, the plugin tries to set reasonable
@@ -220,18 +215,18 @@
with collaborating services. It is possible to override any of these
values (except <tt>Bundle-ManifestVersion</tt>) just by specifying the desired
value in the plugin configuration section of the POM file.</p>
-<p><a name="MavenBundlePlugin(BND)-howto"></a></p>
+<p><a name="ApacheFelixMavenBundlePlugin(BND)-howto"></a></p>
-<h1><a name="MavenBundlePlugin(BND)-Detailed"HowTo""></a>Detailed
"How To"</h1>
+<h1><a
name="ApacheFelixMavenBundlePlugin(BND)-Detailed"HowTo""></a>Detailed
"How To"</h1>
-<h2><a name="MavenBundlePlugin(BND)-GetMaven2"></a>Get Maven2</h2>
+<h2><a name="ApacheFelixMavenBundlePlugin(BND)-GetMaven2"></a>Get Maven2</h2>
<p>The first step in the process of using the plugin is downloading and
installing the latest version of the Maven2 runtime. The latest Maven2
release and instuctions for getting started with Maven2 can be found at
-the <span class="nobr"><a href="http://maven.apache.org/index.html";
title="Visit page outside Confluence" rel="nofollow">Maven website<sup><img
class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span>.</p>
+the <span class="nobr"><a href="http://maven.apache.org/index.html";
title="Visit page outside Confluence" rel="nofollow">Maven website<sup><img
class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span>.</p>
-<h2><a name="MavenBundlePlugin(BND)-UsingthePlugin"></a>Using the Plugin</h2>
+<h2><a name="ApacheFelixMavenBundlePlugin(BND)-UsingthePlugin"></a>Using the
Plugin</h2>
<p>To use the maven-bundle-plugin, you first need to add the plugin and
some appropriate plugin configuration to your bundle project's POM.
@@ -277,7 +272,7 @@
specified (the configuration section is where you will issue
instructions to the plugin).</p>
-<h2><a name="MavenBundlePlugin(BND)-RealWorldExample"></a>Real-World
Example</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-RealWorldExample"></a>Real-World
Example</h2>
<p>Consider this more real-world example using Felix' Log Service
implementation. The Log Service project is comprised of a single
@@ -404,7 +399,7 @@
</pre>
</div></div>
-<h2><a
name="MavenBundlePlugin(BND)-AddingOSGimetadatatoexistingprojectswithoutchangingthepackagingtype"></a>Adding
OSGi metadata to existing projects without changing the packaging type</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-AddingOSGimetadatatoexistingprojectswithoutchangingthepackagingtype"></a>Adding
OSGi metadata to existing projects without changing the packaging type</h2>
<p>If you want to keep your project packaging type (for example "jar") but
would like to add OSGi metadata<br>
you can use the manifest goal to generate a bundle manifest. The
maven-jar-plugin can then be used to<br>
@@ -434,7 +429,7 @@
<span class="code-tag"></plugin></span></pre>
</div></div>
-<h2><a name="MavenBundlePlugin(BND)-BuildingthePlugin"></a>Building the
Plugin</h2>
+<h2><a name="ApacheFelixMavenBundlePlugin(BND)-BuildingthePlugin"></a>Building
the Plugin</h2>
<p>The plugin is hosted at the Apache Felix project. The following
steps describe how to build and install the plugin into your local
@@ -456,7 +451,7 @@
</pre>
</div></div>
-<h1><a name="MavenBundlePlugin(BND)-Goals"></a>Goals</h1>
+<h1><a name="ApacheFelixMavenBundlePlugin(BND)-Goals"></a>Goals</h1>
<p>The maven-bundle-plugin also provides additional functionality via
some Maven goals. Command-line execution of a goal is performed as
@@ -604,13 +599,13 @@
<p>There are also new instructions available from the underlying BND
-tool, which continues to be improved independently; for the latest see <span
class="nobr"><a href="http://aqute.biz/Code/Bnd"; title="Visit page outside
Confluence" rel="nofollow">BND documentation<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle"
border="0" height="7" width="7"></sup></a></span>.</p>
+tool, which continues to be improved independently; for the latest see <span
class="nobr"><a href="http://aqute.biz/Code/Bnd"; title="Visit page outside
Confluence" rel="nofollow">BND documentation<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span>.</p>
<p>The default goal <b><tt>bundle</tt></b> will be initialized by setting the
<packaging> entry to "bundle".</p>
-<h1><a
name="MavenBundlePlugin(BND)-Thefollowingfeaturesareonlyavailablefromversion1.2.0onwards"></a>The
following features are only available from version 1.2.0 onwards</h1>
+<h1><a
name="ApacheFelixMavenBundlePlugin(BND)-Thefollowingfeaturesareonlyavailablefromversion1.2.0onwards"></a>The
following features are only available from version 1.2.0 onwards</h1>
-<h2><a name="MavenBundlePlugin(BND)-Embeddingdependencies"></a>Embedding
dependencies</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-Embeddingdependencies"></a>Embedding
dependencies</h2>
<p>The Maven Bundle Plugin supports embedding of selected project dependencies
inside the bundle by using the <tt><Embed-Dependency></tt>
instruction:</p>
@@ -633,14 +628,22 @@
passed onto BND. If you want the embedded dependencies to be at the
start or middle of <tt><Include-Resource></tt> or
<tt><Bundle-ClassPath></tt> then you can use
{<tt>maven-dependencies</tt>}, which will automatically expand to the relevant
clauses.</p>
+<p>The MATCH section accepts alternatives, separated by <b>|</b>, and can be
negated by using <b>!</b> at the <em>beginning</em> of the MATCH. Use <b>*</b>
to represent zero or more unknown characters and <b>?</b> to represent a single
unknown character. There is no need to escape the <b>.</b> character inside
MATCH. The first MATCH in a clause will filter against the artifactId.</p>
+
<p>some examples:</p>
<div class="code"><div class="codeContent">
-<pre class="code-xml"><span
class="code-tag"><Embed-Dependency></span>*;scope=compile|runtime<span
class="code-tag"></Embed-Dependency></span>
+<pre class="code-xml"><span class="code-tag"><span
class="code-comment"><!-- embed all compile and runtime scope dependencies
--></span></span>
+<span
class="code-tag"><Embed-Dependency></span>*;scope=compile|runtime<span
class="code-tag"></Embed-Dependency></span>
+<span class="code-tag"><span class="code-comment"><!-- embed any
dependencies with artifactId junit and scope test --></span></span>
<span class="code-tag"><Embed-Dependency></span>junit;scope=test<span
class="code-tag"></Embed-Dependency></span>
-<span
class="code-tag"><Embed-Dependency></span>aopalliance;scope=!test;inline=true<span
class="code-tag"></Embed-Dependency></span></pre>
+<span class="code-tag"><span class="code-comment"><!-- inline all
dependencies, except those with scope test --></span></span>
+<span
class="code-tag"><Embed-Dependency></span>*;scope=!test;inline=true<span
class="code-tag"></Embed-Dependency></span>
+
+<span class="code-tag"><span class="code-comment"><!-- embed all compile
and runtime scope dependencies, except those with artifactIds in the given list
--></span></span>
+<span
class="code-tag"><Embed-Dependency></span>*;scope=compile|runtime;inline=false;artifactId=!cli|lang|runtime|tidy|jsch<span
class="code-tag"></Embed-Dependency></span></pre>
</div></div>
<p>examples of using {<tt>maven-dependencies</tt>}:</p>
@@ -677,7 +680,7 @@
<pre class="code-xml"><span
class="code-tag"><Embed-Dependency></span>*;scope=compile|runtime;inline=true<span
class="code-tag"></Embed-Dependency></span></pre>
</div></div>
-<h3><a
name="MavenBundlePlugin(BND)-EmbedDependencyandExportPackage"></a>Embed-Dependency
and Export-Package</h3>
+<h3><a
name="ApacheFelixMavenBundlePlugin(BND)-EmbedDependencyandExportPackage"></a>Embed-Dependency
and Export-Package</h3>
<p>If you embed a dependency with <tt><Embed-Dependency></tt>, and your
<tt><Export-Package></tt> or <tt><Private-Package></tt>
instructions match packages inside the embedded jar, you will see some
duplication inside the bundle. This is because the
<tt><Export-Package></tt> and <tt><Private-Package></tt>
instructions will result in classes being inlined in the bundle, even
@@ -687,7 +690,7 @@
<p><tt><_exportcontents></tt> behaves just like Export-Package, except
it doesn't change the content of the bundle, just what content should be
exported.</p>
-<h2><a name="MavenBundlePlugin(BND)-OBRintegration"></a>OBR integration</h2>
+<h2><a name="ApacheFelixMavenBundlePlugin(BND)-OBRintegration"></a>OBR
integration</h2>
<p>The latest Maven Bundle Plugin automatically updates the local OBR
repository.xml file during the install phase, using a default location
@@ -731,7 +734,7 @@
<span class="code-tag"></configuration></span></pre>
</div></div>
-<h2><a name="MavenBundlePlugin(BND)-Eclipse/PDEintegration"></a>Eclipse/PDE
integration</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-Eclipse/PDEintegration"></a>Eclipse/PDE
integration</h2>
<p>It is possible to configure the Maven Bundle Plugin to put the
bundle manifest where Eclipse/PDE expects it, and use the Maven
@@ -848,7 +851,7 @@
<p>and you should now be able to import this as an existing Eclipse
project.</p>
-<p>FYI: the above POM was generated using the <tt>pax-create-bundle</tt>
command from <span class="nobr"><a
href="http://www.ops4j.org/projects/pax/construct/index.html"; title="Visit page
outside Confluence" rel="nofollow">Pax-Construct<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/linkext7.gif" alt="" align="absmiddle"
border="0" height="7" width="7"></sup></a></span> and then tweaked to
demonstrate using the Maven Dependency Plugin to handle embedded jars in
Eclipse.</p>
+<p>FYI: the above POM was generated using the <tt>pax-create-bundle</tt>
command from <span class="nobr"><a
href="http://www.ops4j.org/projects/pax/construct/index.html"; title="Visit page
outside Confluence" rel="nofollow">Pax-Construct<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span> and then
tweaked to demonstrate using the Maven Dependency Plugin to handle embedded
jars in Eclipse.</p>
<p>With the original Pax-Construct generated POM you would simply use:</p>
@@ -860,7 +863,7 @@
handle any embedded entries. The pax:eclipse goal extends
eclipse:eclipse, and supports the same parameters.</p>
-<h2><a
name="MavenBundlePlugin(BND)-Unpackingbundlecontentsto'target/classes'"></a>Unpacking
bundle contents to 'target/classes'</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-Unpackingbundlecontentsto'target/classes'"></a>Unpacking
bundle contents to 'target/classes'</h2>
<p>Once in a while you may create a bundle which contains additional classes
to the ones compiled from <tt>src/main/java</tt>,
for example when you embed the classes from another jar. This can
@@ -884,7 +887,7 @@
<span class="code-tag"></configuration></span></pre>
</div></div>
-<h2><a name="MavenBundlePlugin(BND)-UsinganexistingMANIFEST.MFfile"></a>Using
an existing MANIFEST.MF file</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-UsinganexistingMANIFEST.MFfile"></a>Using
an existing MANIFEST.MF file</h2>
<p>If you have an existing manifest, you can add this to the Bnd instructions,
like so:</p>
@@ -898,9 +901,9 @@
As shown in the above example, you could use this to include a non-OSGi
manifest which you then customize with extra OSGi attributes.</p>
-<h1><a
name="MavenBundlePlugin(BND)-Thefollowingfeaturesareonlyavailablefromversion1.4.0onwards"></a>The
following features are only available from version 1.4.0 onwards</h1>
+<h1><a
name="ApacheFelixMavenBundlePlugin(BND)-Thefollowingfeaturesareonlyavailablefromversion1.4.0onwards"></a>The
following features are only available from version 1.4.0 onwards</h1>
-<h2><a name="MavenBundlePlugin(BND)-bundle:ant"></a>bundle:ant</h2>
+<h2><a name="ApacheFelixMavenBundlePlugin(BND)-bundle:ant"></a>bundle:ant</h2>
<p>The <b>ant</b> goal creates a customized <tt>build.xml</tt> Ant script
along with a collection of BND instructions and properties, taken from the
current project and stored in <tt>maven-build.bnd</tt>. You also need to run
<b><tt>ant:ant</tt></b> to create the standard Ant support tasks to download
Maven dependencies and perform compilation, etc.</p>
@@ -915,7 +918,7 @@
</pre>
</div></div>
-<h2><a
name="MavenBundlePlugin(BND)-bundle:installfile"></a>bundle:install-file</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-bundle:installfile"></a>bundle:install-file</h2>
<p>The <b>install-file</b> goal updates the local OBR with the details of a
bundle from the local filesystem.</p>
@@ -940,11 +943,11 @@
</pre>
</div></div>
-<h2><a name="MavenBundlePlugin(BND)-bundle:deploy"></a>bundle:deploy</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-bundle:deploy"></a>bundle:deploy</h2>
<p>The <b>deploy goal</b> updates the remote OBR with the details of
the deployed bundle from the local Maven repository. The remote OBR is
-found by querying the <tt><distributionManagement></tt> section of the
project, unless <tt>-DaltDeploymentRepository</tt> is set. See <span
class="nobr"><a
href="http://maven.apache.org/plugins/maven-deploy-plugin/deploy-mojo.html";
title="Visit page outside Confluence"
rel="nofollow">http://maven.apache.org/plugins/maven-deploy-plugin/deploy-mojo.html<sup><img
class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span> for more
details about these particular settings.</p>
+found by querying the <tt><distributionManagement></tt> section of the
project, unless <tt>-DaltDeploymentRepository</tt> is set. See <span
class="nobr"><a
href="http://maven.apache.org/plugins/maven-deploy-plugin/deploy-mojo.html";
title="Visit page outside Confluence"
rel="nofollow">http://maven.apache.org/plugins/maven-deploy-plugin/deploy-mojo.html<sup><img
class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span> for more
details about these particular settings.</p>
<p>(If the project has an <tt>obr.xml</tt> file somewhere in its resources,
then it will be automatically detected and applied.)</p>
@@ -959,9 +962,9 @@
<p>This goal is part of the "bundle" packaging lifecycle, but is disabled by
default - to enable just set the <tt>remoteOBR</tt> parameter.</p>
-<h2><a
name="MavenBundlePlugin(BND)-bundle:deployfile"></a>bundle:deploy-file</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-bundle:deployfile"></a>bundle:deploy-file</h2>
-<p>The <b>deploy-file</b> goal updates the remote OBR with the details of a
deployed bundle from the local filesystem. The remote OBR is found using the
<tt>-DrepositoryId</tt> and <tt>-Durl</tt> parameters. See <span
class="nobr"><a
href="http://maven.apache.org/plugins/maven-deploy-plugin/deploy-file-mojo.html";
title="Visit page outside Confluence"
rel="nofollow">http://maven.apache.org/plugins/maven-deploy-plugin/deploy-file-mojo.html<sup><img
class="rendericon" src="maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span> for more
details about these particular settings.</p>
+<p>The <b>deploy-file</b> goal updates the remote OBR with the details of a
deployed bundle from the local filesystem. The remote OBR is found using the
<tt>-DrepositoryId</tt> and <tt>-Durl</tt> parameters. See <span
class="nobr"><a
href="http://maven.apache.org/plugins/maven-deploy-plugin/deploy-file-mojo.html";
title="Visit page outside Confluence"
rel="nofollow">http://maven.apache.org/plugins/maven-deploy-plugin/deploy-file-mojo.html<sup><img
class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/linkext7.gif" alt=""
align="absmiddle" border="0" height="7" width="7"></sup></a></span> for more
details about these particular settings.</p>
<p>You can use the <tt>-DbundleUrl</tt> parameter to give the public location
of the deployed bundle, which may differ from the remote OBR location.</p>
@@ -1000,7 +1003,7 @@
</pre>
</div></div>
-<h2><a name="MavenBundlePlugin(BND)-bundle:clean"></a>bundle:clean</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-bundle:clean"></a>bundle:clean</h2>
<p>Sometimes you would like to clean your local OBR because it contains
bundles that are no longer in your local Maven repository. This case
@@ -1020,7 +1023,7 @@
</pre>
</div></div>
-<h2><a name="MavenBundlePlugin(BND)-Concurrentupdates"></a>Concurrent
updates</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-Concurrentupdates"></a>Concurrent
updates</h2>
<p>With a remote OBR, several uploads may occur at the same time.
However, the remote OBR is centralized in one file, so concurrent
@@ -1029,7 +1032,7 @@
a file based lock. If it can't take the lock, it will wait and retry.
After 3 attempts the upload process fails. To bypass this lock add
<tt>-DignoreLock</tt> to the command-line (or add
<tt><ignoreLock>true<ignoreLock></tt> to the configuration section
of your Pom).</p>
-<h2><a name="MavenBundlePlugin(BND)-FTPprotocol"></a>FTP protocol</h2>
+<h2><a name="ApacheFelixMavenBundlePlugin(BND)-FTPprotocol"></a>FTP
protocol</h2>
<p>Not all protocols are supported by Maven out of the box. For example the
ftp protocol requires the <b>wagon-ftp</b> component. To enable the ftp
protocol add this to your Pom:</p>
<div class="code"><div class="codeContent">
@@ -1044,7 +1047,7 @@
<span class="code-tag"></build></span></pre>
</div></div>
-<h2><a
name="MavenBundlePlugin(BND)-Howtheplugincomputesthedescriptionofthebundle"></a>How
the plug-in computes the description of the bundle</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-Howtheplugincomputesthedescriptionofthebundle"></a>How
the plug-in computes the description of the bundle</h2>
<p>The description of the bundle comes from three different sources:</p>
<ul>
@@ -1065,7 +1068,7 @@
</div></div>
<p>A warning message is displayed when existing information is overridden.</p>
-<h2><a name="MavenBundlePlugin(BND)-Knownissues&limitations"></a>Known
issues & limitations</h2>
+<h2><a
name="ApacheFelixMavenBundlePlugin(BND)-Knownissues&limitations"></a>Known
issues & limitations</h2>
<ol>
<li>obr.xml (file given by the user to add properties not found
@@ -1074,8 +1077,9 @@
</ol>
-<h1><a name="MavenBundlePlugin(BND)-Feedback"></a>Feedback</h1>
+<h1><a name="ApacheFelixMavenBundlePlugin(BND)-Feedback"></a>Feedback</h1>
-<p>Subscribe to the Felix users mailing list by sending a message to <span
class="nobr"><a href="mailto:[EMAIL PROTECTED]" title="Send mail to [EMAIL
PROTECTED]" rel="nofollow">[EMAIL PROTECTED]<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/mail_small.gif" alt="" align="absmiddle"
border="0" height="12" width="13"></sup></a></span>; after subscribing, email
questions or feedback to <span class="nobr"><a href="mailto:[EMAIL PROTECTED]"
title="Send mail to [EMAIL PROTECTED]" rel="nofollow">[EMAIL
PROTECTED]<sup><img class="rendericon"
src="maven-bundle-plugin-bnd_files/mail_small.gif" alt="" align="absmiddle"
border="0" height="12" width="13"></sup></a></span>.</p>
+<p>Subscribe to the Felix users mailing list by sending a message to <span
class="nobr"><a href="mailto:[EMAIL PROTECTED]" title="Send mail to [EMAIL
PROTECTED]" rel="nofollow">[EMAIL PROTECTED]<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/mail_small.gif" alt=""
align="absmiddle" border="0" height="12" width="13"></sup></a></span>; after
subscribing, email questions or feedback to <span class="nobr"><a
href="mailto:[EMAIL PROTECTED]" title="Send mail to [EMAIL PROTECTED]"
rel="nofollow">[EMAIL PROTECTED]<sup><img class="rendericon"
src="apache-felix-maven-bundle-plugin-bnd_files/mail_small.gif" alt=""
align="absmiddle" border="0" height="12" width="13"></sup></a></span>.</p>
</div>
- </body></html>
\ No newline at end of file
+
+</body></html>
\ No newline at end of file
Added:
felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd_files/button.html
URL:
http://svn.apache.org/viewvc/felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd_files/button.html?rev=653014&view=auto
==============================================================================
---
felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd_files/button.html
(added)
+++
felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd_files/button.html
Sat May 3 01:13:09 2008
@@ -0,0 +1 @@
+<html><head></head><body></body></html>
\ No newline at end of file
Propchange:
felix/trunk/bundleplugin/doc/apache-felix-maven-bundle-plugin-bnd_files/button.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: felix/trunk/bundleplugin/doc/changelog.txt
URL:
http://svn.apache.org/viewvc/felix/trunk/bundleplugin/doc/changelog.txt?rev=653014&r1=653013&r2=653014&view=diff
==============================================================================
--- felix/trunk/bundleplugin/doc/changelog.txt (original)
+++ felix/trunk/bundleplugin/doc/changelog.txt Sat May 3 01:13:09 2008
@@ -1,3 +1,15 @@
+Changes from 1.4.0 to 1.4.1
+---------------------------
+
+ * [2008-04-30] FELIX-543: add switch to prevent classifier being appended to
Bundle-Version
+ * [2008-04-23] FELIX-541: allow repository.xml to reference to xsl file
+ * [2008-04-23] FELIX-531: Allow the import package scope to be set for the
bundleall goal in the maven-bundle-plugin
+ * [2008-04-23] FELIX-523: Update bundleplugin to use BND 0.0.255
+ * [2008-04-01] FELIX-526: Allow a mechanism to give preference to local
resources over the ones from embedded jars
+ * [2008-03-24] FELIX-519: maven-bundle-plugin should issue a WARNING for
unsupported packaging types
+ * [2008-03-16] FELIX-517: Replacement of {maven-dependencies} in
Include-Resource and Bundle-ClassPath can strip Windows path separators
+ * [2008-03-03] FELIX-505: maven-bundle-plugin:bundleall modifies dependencies
that are already bundles
+
Changes from 1.2.1 to 1.4.0
---------------------------
