felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r865541 - in /websites/staging/felix/trunk/content: ./ documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html
Date Thu, 13 Jun 2013 10:36:46 GMT
Author: buildbot
Date: Thu Jun 13 10:36:46 2013
New Revision: 865541

Log:
Staging update by buildbot for felix

Modified:
    websites/staging/felix/trunk/content/   (props changed)
    websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html

Propchange: websites/staging/felix/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Jun 13 10:36:46 2013
@@ -1 +1 @@
-1492614
+1492616

Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html
(original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.html
Thu Jun 13 10:36:46 2013
@@ -146,15 +146,23 @@
 <h2 id="default-behavior">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 defaults for various instructions. For example:</p>
 <ul>
-<li><code>&lt;Bundle-SymbolicName&gt;</code> is computed using
the shared <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-osgi/src/main/java/org/apache/maven/shared/osgi/DefaultMaven2OsgiConverter.java">Maven2OsgiConverter</a>
component, which uses the following algorithm:
-Get the symbolic name as groupId + "." + artifactId, with the following exceptions:</li>
-<li>if artifact.getFile is not null and the jar contains a OSGi Manifest with Bundle-SymbolicName
property then that value is returned</li>
+<li>
+<p><code>&lt;Bundle-SymbolicName&gt;</code> is computed using the
shared <a href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-osgi/src/main/java/org/apache/maven/shared/osgi/DefaultMaven2OsgiConverter.java">Maven2OsgiConverter</a>
component, which uses the following algorithm:
+Get the symbolic name as groupId + "." + artifactId, with the following exceptions:</p>
+</li>
+<li>
+<p>if artifact.getFile is not null and the jar contains a OSGi Manifest with Bundle-SymbolicName
property then that value is returned</p>
+</li>
 <li>if groupId has only one section (no dots) and artifact.getFile is not null then
the first package name with classes is returned. eg. commons-logging:commons-logging -&gt;
org.apache.commons.logging</li>
 <li>if artifactId is equal to last section of groupId then groupId is returned. eg.
org.apache.maven:maven -&gt; org.apache.maven</li>
-<li>if artifactId starts with last section of groupId that portion is removed. eg.
org.apache.maven:maven-core -&gt; org.apache.maven.core
-The computed symbolic name is also stored in the <code>$(maven-symbolicname)</code>
property in case you want to add attributes or directives to it.</li>
-<li><code>&lt;Export-Package&gt;</code> is now assumed to be the
set of packages in your local Java sources, excluding the default package '.' and any packages
containing 'impl' or 'internal'.
-<em>(before version 2 of the bundleplugin it was based on the symbolic name)</em></li>
+<li>
+<p>if artifactId starts with last section of groupId that portion is removed. eg. org.apache.maven:maven-core
-&gt; org.apache.maven.core
+The computed symbolic name is also stored in the <code>$(maven-symbolicname)</code>
property in case you want to add attributes or directives to it.</p>
+</li>
+<li>
+<p><code>&lt;Export-Package&gt;</code> is now assumed to be the
set of packages in your local Java sources, excluding the default package '.' and any packages
containing 'impl' or 'internal'.
+<em>(before version 2 of the bundleplugin it was based on the symbolic name)</em></p>
+</li>
 <li>Since 2.2.0 you can also use <code>{local-packages}</code> inside <code>&lt;Export-Package&gt;</code>
and it will be expanded to the set of local packages.</li>
 <li><code>&lt;Private-Package&gt;</code> is now assumed to be the
set of packages in your local Java sources (note that any packages in both <code>&lt;Export-Package&gt;</code>
and <code>&lt;Private-Package&gt;</code> will be exported).
 <em>(before version 2 of the bundleplugin it was assumed to be empty by default)</em></li>
@@ -403,9 +411,13 @@ for them in the bundleplugin configurati
 
 <p>Where GOAL is one of the following:</p>
 <ul>
-<li><em><code>bundle</code></em> - build an OSGi bundle jar
for the current project
-configuration options:</li>
-<li><em><code>manifestLocation</code></em> defaults to ${project.build.outputDirectory}/META-INF</li>
+<li>
+<p><em><code>bundle</code></em> - build an OSGi bundle jar
for the current project
+configuration options:</p>
+</li>
+<li>
+<p><em><code>manifestLocation</code></em> defaults to ${project.build.outputDirectory}/META-INF</p>
+</li>
 <li><em><code>unpackBundle</code></em> unpack bundle contents
to output directory, defaults to false</li>
 <li><em><code>excludeDependencies</code></em> comma-separated
list of dependency artifactIds to exclude from the classpath passed to Bnd, use "true" to
exclude everything.
 Version 2 of the bundleplugin now supports the same style of filter clauses in <code>excludeDependencies</code>
as <code>Embed-Dependency</code>.</li>
@@ -417,7 +429,9 @@ Version 2 of the bundleplugin now suppor
 <p><em><code>bundleall</code></em> - build OSGi bundle jars
for all transitive dependencies
 configuration options:</p>
 </li>
-<li><em><code>wrapImportPackage</code></em> defaults to "*"</li>
+<li>
+<p><em><code>wrapImportPackage</code></em> defaults to "*"</p>
+</li>
 <li>
 <p><em><code>supportedProjectTypes</code></em> defaults to
"jar","bundle"</p>
 </li>
@@ -425,7 +439,9 @@ configuration options:</p>
 <p><em><code>wrap</code></em> - as above, but limited to the
first level of dependencies
 configuration options:</p>
 </li>
-<li><em><code>wrapImportPackage</code></em> defaults to "*"</li>
+<li>
+<p><em><code>wrapImportPackage</code></em> defaults to "*"</p>
+</li>
 <li>
 <p><em><code>supportedProjectTypes</code></em> defaults to
"jar","bundle"</p>
 </li>
@@ -433,7 +449,9 @@ configuration options:</p>
 <p><em><code>manifest</code></em> - create an OSGi manifest
for the current project
 configuration options:</p>
 </li>
-<li><em><code>manifestLocation</code></em> defaults to ${project.build.outputDirectory}/META-INF</li>
+<li>
+<p><em><code>manifestLocation</code></em> defaults to ${project.build.outputDirectory}/META-INF</p>
+</li>
 <li>
 <p><em><code>supportedProjectTypes</code></em> defaults to
"jar","bundle"</p>
 </li>
@@ -441,7 +459,9 @@ configuration options:</p>
 <p><em><code>install</code></em> - adds the current bundle
project to the local OBR
 configuration options:</p>
 </li>
-<li><em><code>obrRepository</code></em> path to local OBR,
defaults to <em><local-maven-repository></em><code>/repository.xml</code></li>
+<li>
+<p><em><code>obrRepository</code></em> path to local OBR, defaults
to <em><local-maven-repository></em><code>/repository.xml</code></p>
+</li>
 <li><em><code>supportedProjectTypes</code></em> defaults to
"jar","bundle"</li>
 </ul>
 <p>More GOALs are available in the <em>1.4.0</em> release:</p>
@@ -453,7 +473,9 @@ configuration options:</p>
 <p><em><code>install-file</code></em> - adds a local bundle
file to the local OBR
 configuration options:</p>
 </li>
-<li><em><code>obrRepository</code></em> path to local OBR,
defaults to <em><local-maven-repository></em><code>/repository.xml</code></li>
+<li>
+<p><em><code>obrRepository</code></em> path to local OBR, defaults
to <em><local-maven-repository></em><code>/repository.xml</code></p>
+</li>
 <li><em><code>groupId</code></em> Maven groupId for the bundle,
taken from <em>pomFile</em> if given</li>
 <li><em><code>artifactId</code></em> Maven artifactId for the
bundle, taken from <em>pomFile</em> if given</li>
 <li><em><code>version</code></em> Maven version for the bundle,
taken from <em>pomFile</em> if given</li>
@@ -468,7 +490,9 @@ configuration options:</p>
 <p><em><code>deploy</code></em> - adds the current bundle project
to a remote OBR
 configuration options:</p>
 </li>
-<li><em><code>remoteOBR</code></em> name of remote OBR, defaults
to NONE (which means no remote OBR deployment)</li>
+<li>
+<p><em><code>remoteOBR</code></em> name of remote OBR, defaults
to NONE (which means no remote OBR deployment)</p>
+</li>
 <li><em><code>obrRepository</code></em> used when the remoteOBR
name is blank, defaults to <code>repository.xml</code></li>
 <li><em><code>prefixUrl</code></em> optional public URL prefix
for the remote repository</li>
 <li><em><code>bundleUrl</code></em> optional public URL where
the bundle has been deployed</li>
@@ -482,7 +506,9 @@ configuration options:</p>
 <p><em><code>deploy-file</code></em> - adds a local bundle
file to a remote OBR
 configuration options:</p>
 </li>
-<li><em><code>remoteOBR</code></em> name of remote OBR, defaults
to an empty string</li>
+<li>
+<p><em><code>remoteOBR</code></em> name of remote OBR, defaults
to an empty string</p>
+</li>
 <li><em><code>obrRepository</code></em> used when the remoteOBR
name is blank, defaults to <code>repository.xml</code></li>
 <li><em><code>repositoryId</code></em> optional repository
id, used to lookup authentication settings</li>
 <li>
@@ -517,7 +543,9 @@ configuration options:</p>
 <p><em><code>remote-clean</code></em> - cleans a remote OBR,
removing missing bundles
 configuration options:</p>
 </li>
-<li><em><code>remoteOBR</code></em> name of remote OBR, defaults
to NONE (which means no remote cleaning)</li>
+<li>
+<p><em><code>remoteOBR</code></em> name of remote OBR, defaults
to NONE (which means no remote cleaning)</p>
+</li>
 <li><em><code>obrRepository</code></em> used when the remoteOBR
name is blank, defaults to <code>repository.xml</code></li>
 <li><em><code>prefixUrl</code></em> optional public URL prefix
for the remote repository</li>
 <li><em><code>altDeploymentRepository</code></em> alternative
remote repository, <em>id::layout::url</em></li>
@@ -818,17 +846,9 @@ As shown in the above example, you could
 <li><em>remoteOBR</em> name of remote OBR, defaults to an empty string</li>
 <li><em>obrRepository</em> used when the remoteOBR name is blank, defaults
to <code>repository.xml</code></li>
 <li><em>repositoryId</em> optional repository id, used to lookup authentication
settings</li>
-<li>
-<p><em>url</em> remote repository transport URL, like</p>
-<p>scpexe://host/path/to/obr</p>
-</li>
-<li>
-<p><em>bundleUrl</em> public URL of deployed bundle, like</p>
-<p>http://www.foo.org/bundles/foo.jar</p>
-</li>
-<li>
-<p><em>groupId</em> Maven groupId for the bundle, taken from <em>pomFile</em>
if given</p>
-</li>
+<li><em>url</em> remote repository transport URL, like <code>scpexe://host/path/to/obr</code></li>
+<li><em>bundleUrl</em> public URL of deployed bundle, like <code>http://www.foo.org/bundles/foo.jar</code></li>
+<li><em>groupId</em> Maven groupId for the bundle, taken from <em>pomFile</em>
if given</li>
 <li><em>artifactId</em> Maven artifactId for the bundle, taken from <em>pomFile</em>
if given</li>
 <li><em>version</em> Maven version for the bundle, taken from <em>pomFile</em>
if given</li>
 <li><em>packaging</em> Maven packaging type for the bundle, taken from
<em>pomFile</em> if given</li>
@@ -867,8 +887,12 @@ As shown in the above example, you could
 <p>Possible values for the <code>urlTemplate</code> are:</p>
 <ul>
 <li><em>maven</em> this will create a maven based url such as <code>mvn:groupid/artifactid/version</code></li>
-<li>pattern with the following placeholders:</li>
-<li><code>%v</code> bundle version</li>
+<li>
+<p>pattern with the following placeholders:</p>
+</li>
+<li>
+<p><code>%v</code> bundle version</p>
+</li>
 <li><code>%s</code> bundle symbolic name</li>
 <li><code>%f</code> file name</li>
 <li><code>%p</code> file path</li>
@@ -913,7 +937,7 @@ As shown in the above example, you could
 <h1 id="feedback">Feedback</h1>
 <p>Subscribe to the Felix users mailing list by sending a message to <a href="mailto:users-subscribe@felix.apache.org">users-subscribe@felix.apache.org</a>;
after subscribing, email questions or feedback to <a href="mailto:users@felix.apache.org">users@felix.apache.org</a>.</p>
       <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
-        Rev. 1492614 by mcculls on Thu, 13 Jun 2013 10:32:42 +0000
+        Rev. 1492616 by mcculls on Thu, 13 Jun 2013 10:36:38 +0000
       </div>
       <div class="trademarkFooter"> 
         Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project



Mime
View raw message