You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2016/03/31 20:24:41 UTC
[2/2] karaf git commit: KARAF-4415 - Update the documentation about
the verify goal
KARAF-4415 - Update the documentation about the verify goal
Project: http://git-wip-us.apache.org/repos/asf/karaf/repo
Commit: http://git-wip-us.apache.org/repos/asf/karaf/commit/f2a5c4b5
Tree: http://git-wip-us.apache.org/repos/asf/karaf/tree/f2a5c4b5
Diff: http://git-wip-us.apache.org/repos/asf/karaf/diff/f2a5c4b5
Branch: refs/heads/karaf-4.0.x
Commit: f2a5c4b5de271331d5d4fcc4363b73299a7949a0
Parents: 0475a01
Author: Jean-Baptiste Onofré <jb...@apache.org>
Authored: Thu Mar 31 20:23:34 2016 +0200
Committer: Jean-Baptiste Onofré <jb...@apache.org>
Committed: Thu Mar 31 20:24:34 2016 +0200
----------------------------------------------------------------------
.../developer-guide/karaf-maven-plugin.adoc | 84 ++++++++++----------
1 file changed, 41 insertions(+), 43 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/karaf/blob/f2a5c4b5/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc b/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
index f3f9b2b..d832232 100644
--- a/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
+++ b/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
@@ -16,7 +16,7 @@
The Karaf Maven plugin allows you:
-* to work with Karaf features: validate a features descriptor, add features bundle into a repository, create a KAR archive from a features descriptor, etc.
+* to work with Karaf features: verify and validate a features descriptor, add features bundle into a repository, create a KAR archive from a features descriptor, etc.
* to create Karaf commands help: it generates help from Karaf commands
* to modify Karaf instances and create distributions
@@ -131,7 +131,7 @@ The example below generates help for the commands in the current project:
You should use the features or kar packaging instead of these individual goals.
====
-The `karaf-maven-plugin` provides several goals to help you create and validate features XML descriptors as well as leverage your features to create a custom Karaf distribution.
+The `karaf-maven-plugin` provides several goals to help you create and verify features XML descriptors as well as leverage your features to create a custom Karaf distribution.
===== `karaf:features-generate-descriptor`
@@ -219,9 +219,9 @@ This can be overridden by specifying the bundle in the source feature.xml with t
</project>
----
-===== `karaf:features-validate-descriptor`
+===== `karaf:verify`
-The `karaf:features-validate-descriptor` goal validates a features XML descriptor by checking if all the required imports
+The `karaf:verify` goal verifies and validates a features XML descriptor by checking if all the required imports
for the bundles defined in the features can be matched to a provided export.
By default, the plugin tries to add the Karaf core features (standard and enterprise) in the repositories set.
@@ -237,31 +237,32 @@ It reads the definition for the packages that are exported by the system bundle
<project>
<build>
<plugins>
- <plugin>
- <groupId>org.apache.karaf.tooling</groupId>
- <artifactId>karaf-maven-plugin</artifactId>
- <version>${project.version}</version>
- <executions>
- <execution>
- <id>validate</id>
- <phase>process-resources</phase>
- <goals>
- <goal>features-validate-descriptor</goal>
- </goals>
- <configuration>
- <file>target/features.xml</file>
- <karafConfig>src/main/resources/config.properties</karafConfig>
- </configuration>
- </execution>
- </executions>
- <dependencies>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-simple</artifactId>
- <version>1.4.3</version>
- </dependency>
- </dependencies>
- </plugin>
+ <plugin>
+ <groupId>org.apache.karaf.tooling</groupId>
+ <artifactId>karaf-maven-plugin</artifactId>
+ <configuration>
+ </configuration>
+ <executions>
+ <execution>
+ <id>verify</id>
+ <phase>process-resources</phase>
+ <goals>
+ <goal>verify</goal>
+ </goals>
+ <configuration>
+ <descriptors>
+ <descriptor>mvn:org.apache.karaf.features/framework/4.0.4/xml/features</descriptor>
+ <descriptor>file:${project.build.directory}/feature/feature.xml</descriptor>
+ </descriptors>
+ <distribution>org.apache.karaf.features:framework</distribution>
+ <javase>1.8</javase>
+ <framework>
+ <feature>framework</feature>
+ </framework>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
</project>
@@ -272,25 +273,22 @@ It reads the definition for the packages that are exported by the system bundle
|===
|Name |Type |Description
-|`file`
-|`File`
-|The features XML descriptor file to validate. Default value: `${project.build.directory}/classes/features.xml`
+|`descriptors`
+|`String[]`
+|The list of features XML repositories to use for the verify
-|`karafConfig`
-|`String`
-|The Karaf `config.properties` file to use during the validation process. Default value: `config.properties`
+|`features`
+|`String[]`
+|The list of features to verify. If not specified, all features in the descriptors will be verified.
-|`jreVersion`
-|`String`
-|The JRE version that is used during the validation process. Default value: `jre-1.5`
+|`framework`
+|`String[]`
+|The features providing the Karaf framework (optional)
-|`karafVersion`
+|`javase`
|`String`
-|The target Karaf version used to get the Karaf core features (standard and enterprise). Default is the version of the plugin
+|The Java version to use for the verify
-|`repositories`
-|`String[]`
-|Additional features XML descriptors that will be used during the validation process
|===
===== `karaf:features-add-to-repository`