You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by mc...@apache.org on 2013/06/13 12:42:54 UTC
svn commit: r1492618 -
/felix/site/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.mdtext
Author: mcculls
Date: Thu Jun 13 10:42:53 2013
New Revision: 1492618
URL: http://svn.apache.org/r1492618
Log:
CMS commit to felix by mcculls
Modified:
felix/site/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.mdtext
Modified: felix/site/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.mdtext
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.mdtext?rev=1492618&r1=1492617&r2=1492618&view=diff
==============================================================================
--- felix/site/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.mdtext (original)
+++ felix/site/trunk/content/documentation/subprojects/apache-felix-maven-bundle-plugin-bnd.mdtext Thu Jun 13 10:42:53 2013
@@ -108,10 +108,10 @@ To use this plugin, very little informat
* `<Bundle-SymbolicName>` is computed using the shared [Maven2OsgiConverter](http://svn.apache.org/repos/asf/maven/shared/trunk/maven-osgi/src/main/java/org/apache/maven/shared/osgi/DefaultMaven2OsgiConverter.java) component, which uses the following algorithm:
Get the symbolic name as groupId + "." + artifactId, with the following exceptions:
- * if artifact.getFile is not null and the jar contains a OSGi Manifest with Bundle-SymbolicName property then that value is returned
- * 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 -> org.apache.commons.logging
- * if artifactId is equal to last section of groupId then groupId is returned. eg. org.apache.maven:maven -> org.apache.maven
- * if artifactId starts with last section of groupId that portion is removed. eg. org.apache.maven:maven-core -> org.apache.maven.core
+ * if artifact.getFile is not null and the jar contains a OSGi Manifest with Bundle-SymbolicName property then that value is returned
+ * 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 -> org.apache.commons.logging
+ * if artifactId is equal to last section of groupId then groupId is returned. eg. org.apache.maven:maven -> org.apache.maven
+ * if artifactId starts with last section of groupId that portion is removed. eg. org.apache.maven:maven-core -> org.apache.maven.core
The computed symbolic name is also stored in the `$(maven-symbolicname)` property in case you want to add attributes or directives to it.
* `<Export-Package>` 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'.
@@ -390,36 +390,36 @@ Where GOAL is one of the following:
* *`bundle`* - build an OSGi bundle jar for the current project
configuration options:
- * *`manifestLocation`* defaults to $\{project.build.outputDirectory}/META-INF
- * *`unpackBundle`* unpack bundle contents to output directory, defaults to false
- * *`excludeDependencies`* comma-separated list of dependency artifactIds to exclude from the classpath passed to Bnd, use "true" to exclude everything.
+ * *`manifestLocation`* defaults to $\{project.build.outputDirectory}/META-INF
+ * *`unpackBundle`* unpack bundle contents to output directory, defaults to false
+ * *`excludeDependencies`* 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 `excludeDependencies` as `Embed-Dependency`.
- * *`classifier`* attach bundle to the project using the given classifier
- * *`supportedProjectTypes`* defaults to "jar","bundle"
+ * *`classifier`* attach bundle to the project using the given classifier
+ * *`supportedProjectTypes`* defaults to "jar","bundle"
* *`bundleall`* - build OSGi bundle jars for all transitive dependencies
configuration options:
- * *`wrapImportPackage`* defaults to "*"
- * *`supportedProjectTypes`* defaults to "jar","bundle"
+ * *`wrapImportPackage`* defaults to "*"
+ * *`supportedProjectTypes`* defaults to "jar","bundle"
* *`wrap`* - as above, but limited to the first level of dependencies
configuration options:
- * *`wrapImportPackage`* defaults to "*"
- * *`supportedProjectTypes`* defaults to "jar","bundle"
+ * *`wrapImportPackage`* defaults to "*"
+ * *`supportedProjectTypes`* defaults to "jar","bundle"
* *`manifest`* - create an OSGi manifest for the current project
configuration options:
- * *`manifestLocation`* defaults to $\{project.build.outputDirectory}/META-INF
- * *`supportedProjectTypes`* defaults to "jar","bundle"
+ * *`manifestLocation`* defaults to $\{project.build.outputDirectory}/META-INF
+ * *`supportedProjectTypes`* defaults to "jar","bundle"
* *`install`* - adds the current bundle project to the local OBR
configuration options:
- * *`obrRepository`* path to local OBR, defaults to *<local-maven-repository>*`/repository.xml`
- * *`supportedProjectTypes`* defaults to "jar","bundle"
+ * *`obrRepository`* path to local OBR, defaults to *<local-maven-repository>*`/repository.xml`
+ * *`supportedProjectTypes`* defaults to "jar","bundle"
More GOALs are available in the *1.4.0* release:
@@ -428,66 +428,60 @@ More GOALs are available in the *1.4.0*
* *`install-file`* - adds a local bundle file to the local OBR
configuration options:
- * *`obrRepository`* path to local OBR, defaults to *<local-maven-repository>*`/repository.xml`
- * *`groupId`* Maven groupId for the bundle, taken from *pomFile* if given
- * *`artifactId`* Maven artifactId for the bundle, taken from *pomFile* if given
- * *`version`* Maven version for the bundle, taken from *pomFile* if given
- * *`packaging`* Maven packaging type for the bundle, taken from *pomFile* if given
- * *`classifier`* Maven classifier type, defaults to none
- * *`pomFile`* optional Pom file describing the bundle
- * *`file`* bundle file, defaults to the bundle from the local Maven repository
- * *`obrXml`* optional additional properties for the bundle
+ * *`obrRepository`* path to local OBR, defaults to *<local-maven-repository>*`/repository.xml`
+ * *`groupId`* Maven groupId for the bundle, taken from *pomFile* if given
+ * *`artifactId`* Maven artifactId for the bundle, taken from *pomFile* if given
+ * *`version`* Maven version for the bundle, taken from *pomFile* if given
+ * *`packaging`* Maven packaging type for the bundle, taken from *pomFile* if given
+ * *`classifier`* Maven classifier type, defaults to none
+ * *`pomFile`* optional Pom file describing the bundle
+ * *`file`* bundle file, defaults to the bundle from the local Maven repository
+ * *`obrXml`* optional additional properties for the bundle
* *`deploy`* - adds the current bundle project to a remote OBR
configuration options:
- * *`remoteOBR`* name of remote OBR, defaults to NONE (which means no remote OBR deployment)
- * *`obrRepository`* used when the remoteOBR name is blank, defaults to `repository.xml`
- * *`prefixUrl`* optional public URL prefix for the remote repository
- * *`bundleUrl`* optional public URL where the bundle has been deployed
- * *`altDeploymentRepository`* alternative remote repository, *id::layout::url*
- * *`obrDeploymentRepository`* optional OBR specific deployment repository.
- * *`ignoreLock`* ignore remote locking when updating the OBR
- * *`supportedProjectTypes`* defaults to "jar","bundle"
+ * *`remoteOBR`* name of remote OBR, defaults to NONE (which means no remote OBR deployment)
+ * *`obrRepository`* used when the remoteOBR name is blank, defaults to `repository.xml`
+ * *`prefixUrl`* optional public URL prefix for the remote repository
+ * *`bundleUrl`* optional public URL where the bundle has been deployed
+ * *`altDeploymentRepository`* alternative remote repository, *id::layout::url*
+ * *`obrDeploymentRepository`* optional OBR specific deployment repository.
+ * *`ignoreLock`* ignore remote locking when updating the OBR
+ * *`supportedProjectTypes`* defaults to "jar","bundle"
* *`deploy-file`* - adds a local bundle file to a remote OBR
configuration options:
- * *`remoteOBR`* name of remote OBR, defaults to an empty string
- * *`obrRepository`* used when the remoteOBR name is blank, defaults to `repository.xml`
- * *`repositoryId`* optional repository id, used to lookup authentication settings
- * *`url`* remote repository transport URL, like
-
- scpexe://host/path/to/obr
-
- * *`bundleUrl`* public URL of deployed bundle, like
-
- http://www.foo.org/bundles/foo.jar
-
- * *`groupId`* Maven groupId for the bundle, taken from *pomFile* if given
- * *`artifactId`* Maven artifactId for the bundle, taken from *pomFile* if given
- * *`version`* Maven version for the bundle, taken from *pomFile* if given
- * *`packaging`* Maven packaging type for the bundle, taken from *pomFile* if given
- * *`classifier`* Maven classifier type, defaults to none
- * *`pomFile`* optional Pom file describing the bundle
- * *`file`* bundle file, defaults to the bundle from the local Maven repository
- * *`obrXml`* optional additional properties for the bundle
- * *`ignoreLock`* ignore remote locking when updating the OBR
+ * *`remoteOBR`* name of remote OBR, defaults to an empty string
+ * *`obrRepository`* used when the remoteOBR name is blank, defaults to `repository.xml`
+ * *`repositoryId`* optional repository id, used to lookup authentication settings
+ * *`url`* remote repository transport URL, like `scpexe://host/path/to/obr`
+ * *`bundleUrl`* public URL of deployed bundle, like `http://www.foo.org/bundles/foo.jar`
+ * *`groupId`* Maven groupId for the bundle, taken from *pomFile* if given
+ * *`artifactId`* Maven artifactId for the bundle, taken from *pomFile* if given
+ * *`version`* Maven version for the bundle, taken from *pomFile* if given
+ * *`packaging`* Maven packaging type for the bundle, taken from *pomFile* if given
+ * *`classifier`* Maven classifier type, defaults to none
+ * *`pomFile`* optional Pom file describing the bundle
+ * *`file`* bundle file, defaults to the bundle from the local Maven repository
+ * *`obrXml`* optional additional properties for the bundle
+ * *`ignoreLock`* ignore remote locking when updating the OBR
* *`clean`* - cleans the local OBR, removing missing bundles
configuration options:
- * *`obrRepository`* path to local OBR, defaults to *<local-maven-repository>*`/repository.xml`
+ * *`obrRepository`* path to local OBR, defaults to *<local-maven-repository>*`/repository.xml`
* *`remote-clean`* - cleans a remote OBR, removing missing bundles
configuration options:
- * *`remoteOBR`* name of remote OBR, defaults to NONE (which means no remote cleaning)
- * *`obrRepository`* used when the remoteOBR name is blank, defaults to `repository.xml`
- * *`prefixUrl`* optional public URL prefix for the remote repository
- * *`altDeploymentRepository`* alternative remote repository, *id::layout::url*
- * *`obrDeploymentRepository`* optional OBR specific deployment repository.
- * *`ignoreLock`* ignore remote locking when updating the OBR
+ * *`remoteOBR`* name of remote OBR, defaults to NONE (which means no remote cleaning)
+ * *`obrRepository`* used when the remoteOBR name is blank, defaults to `repository.xml`
+ * *`prefixUrl`* optional public URL prefix for the remote repository
+ * *`altDeploymentRepository`* alternative remote repository, *id::layout::url*
+ * *`obrDeploymentRepository`* optional OBR specific deployment repository.
+ * *`ignoreLock`* ignore remote locking when updating the OBR
There are also new instructions available from the underlying BND tool, which continues to be improved independently; for the latest see [BND documentation](http://aqute.biz/Code/Bnd).
@@ -877,10 +871,10 @@ Possible values for the `urlTemplate` ar
* *maven* this will create a maven based url such as `mvn:groupid/artifactid/version`
* pattern with the following placeholders:
- * `%v` bundle version
- * `%s` bundle symbolic name
- * `%f` file name
- * `%p` file path
+ * `%v` bundle version
+ * `%s` bundle symbolic name
+ * `%f` file name
+ * `%p` file path
## Concurrent updates