Author: vmassol
Date: Tue Mar 28 04:47:31 2006
New Revision: 389492

URL: http://svn.apache.org/viewcvs?rev=389492&view=rev
Log:
Added documentation for the master report generation (MCLOVER-25)

Modified:
    maven/plugins/trunk/maven-clover-plugin/src/site/apt/howto.apt
    maven/plugins/trunk/maven-clover-plugin/src/site/apt/introduction.apt

Modified: maven/plugins/trunk/maven-clover-plugin/src/site/apt/howto.apt
URL: 
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-clover-plugin/src/site/apt/howto.apt?rev=389492&r1=389491&r2=389492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-clover-plugin/src/site/apt/howto.apt (original)
+++ maven/plugins/trunk/maven-clover-plugin/src/site/apt/howto.apt Tue Mar 28 
04:47:31 2006
@@ -134,3 +134,26 @@
   Instead of specifying a file, you can also specify either a <<URL>> or a 
<<relative path inside a JAR>> (to learn
   how to use this last feature, refer to the
   
{{{http://maven.apache.org/plugins/maven-checkstyle-plugin/tips.html}Checkstlye 
plugin documentation}}.
+
+Controlling the master report generation
+
+  By default if you execute <<<mvn clover:clover>>> or <<<mvn site>>> on a 
multimodule build, the Clover plguin will
+  automatically generate a master report aggreating all individual module 
reports. To disable this feature, use for
+  example:
+
++--------
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-clover-plugin</artifactId>
+        <configuration>
+          <aggregate>false</aggregate>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
++---------
+
+  Note that you can control the location of the aggregated Clover database by 
using the <<<cloverMergeDatabase>>>
+  configuration property.

Modified: maven/plugins/trunk/maven-clover-plugin/src/site/apt/introduction.apt
URL: 
http://svn.apache.org/viewcvs/maven/plugins/trunk/maven-clover-plugin/src/site/apt/introduction.apt?rev=389492&r1=389491&r2=389492&view=diff
==============================================================================
--- maven/plugins/trunk/maven-clover-plugin/src/site/apt/introduction.apt 
(original)
+++ maven/plugins/trunk/maven-clover-plugin/src/site/apt/introduction.apt Tue 
Mar 28 04:47:31 2006
@@ -24,7 +24,9 @@
    * Instrumenting Java sources with Clover so that they generate coverage logs
      to a {{{http://cenqua.com/clover/doc/adv/database.html}Clover database}} 
when they are exercised.
 
-   * Generating a report from a 
{{{http://cenqua.com/clover/doc/adv/database.html}Clover database}}.
+   * Generating a report from a 
{{{http://cenqua.com/clover/doc/adv/database.html}Clover database}}. Note that
+     if you execute the Clover plugin in a multimodule build it will 
automatically generate individual reports
+     for each module but also a master report aggregating all module reports.
 
    * Verifying that your source code has a defined test coverage percentage 
and fail the build if it's
      below that level. This is the equivalent of the


Reply via email to