felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cziege...@apache.org
Subject svn commit: r1524011 - in /felix/site/trunk/content/documentation/subprojects: apache-felix-maven-scr-plugin.mdtext apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.mdtext apache-felix-maven-scr-plugin/scr-annotations.mdtext
Date Tue, 17 Sep 2013 12:41:11 GMT
Author: cziegeler
Date: Tue Sep 17 12:41:10 2013
New Revision: 1524011

URL: http://svn.apache.org/r1524011
Log:
Update scr plugin docs

Modified:
    felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.mdtext
    felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.mdtext
    felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.mdtext

Modified: felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.mdtext
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.mdtext?rev=1524011&r1=1524010&r2=1524011&view=diff
==============================================================================
--- felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.mdtext
(original)
+++ felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin.mdtext
Tue Sep 17 12:41:10 2013
@@ -1,6 +1,6 @@
 Title: Apache Felix Maven SCR Plugin
 
-The Apache Felix Maven SCR Plugin is a great tool to ease the development of OSGi components
and services. Components and services are defined through annotations and the plugin creates
the necessary descriptors for the OSGi Declarative Services, Config Admin and Metatype services.
Starting with version 1.4.0 of the plugin, OSGi Declarative Services versions 1.0 and 1.1
are supported.
+The Apache Felix Maven SCR Plugin is a great tool to ease the development of OSGi components
and services. Components and services are defined through annotations and the plugin creates
the necessary descriptors for the OSGi Declarative Services, Config Admin and Metatype services.
Recent versions of the plugin support OSGi Declarative Services versions 1.0, 1.1, and 1.2.
 
 Make sure to see the [FAQ]({{ refs.apache-felix-scr-plugin-faq.path }}) for known problems.
 
@@ -40,7 +40,7 @@ To summarize:
 
 In general both mechanisms provide the same functionality. There are some subtle difference
which are listed in this section:
 
-* JavaDoc tags are not supported in recent versions of the plugin. New features
+* JavaDoc tags are not supported in recent versions of the plugin, support has been removed
with version 1.8.0. New features
 will only be implemented as annotations.
 * While the `metatype` flag is turned on by default for the JavaDoc tags, the default for
the annotations is to generate no metadata. The reason for this is, that it turned out that
services with metadata are less often used.
 * The JavaDoc support adds properties and references from super classes if the source is
in the same module to a component even if the super class does not have the `@scr.component`
tag. With the annotations the super class is required to have the `Component` annotation.

Modified: felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.mdtext
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.mdtext?rev=1524011&r1=1524010&r2=1524011&view=diff
==============================================================================
--- felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.mdtext
(original)
+++ felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/apache-felix-maven-scr-plugin-use.mdtext
Tue Sep 17 12:41:10 2013
@@ -14,7 +14,7 @@ Support for automatic generation of the 
           <plugin>
             <groupId>org.apache.felix</groupId>
             <artifactId>maven-scr-plugin</artifactId>
-            <version>1.9.0</version>
+            <version>1.14.0</version>
             <executions>
               <execution>
                 <id>generate-scr-scrdescriptor</id>
@@ -32,7 +32,7 @@ Support for automatic generation of the 
     </project>
 
 
-The `scr` goal is bound to the `generate-resources` phase and will generate a single descriptor
file as well as meta type file for all components found in the project. 
+The `scr` goal is bound to the `generate-resources` phase and will generate a separate descriptor
file for each component as well as a separate meta type file for each component which has
metatype support enabled in the project. 
 
 The plugin may be configured with the following properties (Check the version column to make
sure you use at least this version for the mentioned feature):
  
@@ -47,10 +47,11 @@ The plugin will generate a descriptor fo
 *Since*:     
 If this switch is turned on, the bind and unbind methods for unary references are automatically
generated by the plugin.
 ----
-**`processAnnotations`**    
-*Default*: `true`    
-*Since*: 1.2.0    
-If this switch is turned on, the java code is scanned for the scr annotations (see below).
+**`scanClasses`**    
+*Default*: `false`    
+*Since*: 1.9.0    
+By default the plugin scans the java source tree, if this is set to `true`,
+the generated classes directory is scanned instead.
 ----
 **`sourceIncludes`**        
 *Default*: `true`    
@@ -72,48 +73,24 @@ The plugin distinguishes between errors 
 *Since*: 1.2.0    
 A map of predefined properties. These properties are set to each component (if the component
does not define the property already). This is a map where the property name is made up by
the included element name and the value is the value of the element. 
 ----
-**`finalName`**        
-*Default*: `serviceComponents.xml` or `scr.descriptor.name` system property    
-*Since*: 1.0.0    
-The name of the descriptor file to create. This property only applies if
-the `generateSeparateDescriptors` is set to `false`.
-----
-**`metaTypeName`**        
-*Default*: `metatype.xml`    
-*Since*: 1.0.0    
-The name of the descriptor file to create.
-----
 **`outputDirectory`**        
 *Default*: `${project.build.directory}/scr-plugin-generated`    
 *Since*: 1.0.0    
 The directory where all files are generated in.
 ----
-**`generateSeparateDescriptors`**    
-*Default*: `true`    
-*Since*: 1.9.0    
-If set to false, a single descriptor will be created.
-----
 **`supportedProjectTypes`**    
 *Default*: `jar, bundle`    
 *Since*: 1.8.0    
 Project types which this plugin supports.
 ----
-**`scanClasses`**    
-*Default*: `false`    
-*Since*: 1.9.0    
-By default the plugin scans the java source tree, if this is set to `true`,
-the generated classes directory is scanned instead.
-----
-
-The Metatype file is generated in the `OSGI-INF/metatype/` directory and the Declarative
Services descriptor file in the `OSGI-INF` directory. 
 
-**Note**: The location of the Metatype descriptor may not be changed as the OSGi Metatype
Service Specification prescribes the location of the descriptors. 
+The metatype files are generated in the `OSGI-INF/metatype/` directory and the Declarative
Services descriptor files in the `OSGI-INF` directory. 
 
-The plugin will look for component definition tags in all Java files found in the source
directories of the project unless the `scanClasses` property indicates the class files are
to be scanned instead. This is usefull if the annotations are actually defined in JVM-based
languages such as Groovy or Scala.
+The plugin will look for component annotations in all Java files found in the source directories
of the project unless the `scanClasses` property indicates the class files are to be scanned
instead. This is usefull if the annotations are actually defined in JVM-based languages such
as Groovy or Scala.
 
 ### Using the descriptor 
 
-Currently the `maven-scr-plugin` only creates the component descriptor file. Adding the descriptor
to the bundle and setting the `Service-Component` manifest header accordingly is a different
task. However, if you're using the `org.apache.felix:maven-bundle-plugin` to construct the
bundle and its manifest, then the `maven-scr-plugin` will add the following settings automatically
for the `org.apache.felix:maven-bundle-plugin` (given default `maven-scr-plugin` configuration),
so you don't have to configure this yourself: 
+Currently the `maven-scr-plugin` only creates the component descriptor files. Adding the
descriptor to the bundle and setting the `Service-Component` manifest header accordingly is
a different task. However, if you're using the `org.apache.felix:maven-bundle-plugin` to construct
the bundle and its manifest, then the `maven-scr-plugin` will add the following settings automatically
for the `org.apache.felix:maven-bundle-plugin` (given default `maven-scr-plugin` configuration),
so you don't have to configure this yourself: 
 
     :::xml
     ...

Modified: felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.mdtext
URL: http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.mdtext?rev=1524011&r1=1524010&r2=1524011&view=diff
==============================================================================
--- felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.mdtext
(original)
+++ felix/site/trunk/content/documentation/subprojects/apache-felix-maven-scr-plugin/scr-annotations.mdtext
Tue Sep 17 12:41:10 2013
@@ -8,7 +8,7 @@ The `maven-scr-plugin` uses the `SCR` an
     <dependency>
         <groupId>org.apache.felix</groupId>
         <artifactId>org.apache.felix.scr.annotations</artifactId>
-        <version>1.2.0</version>
+        <version>1.9.6</version>
     </dependency>
 
 



Mime
View raw message