Author: hboutemy
Date: Tue Jul 5 22:14:32 2011
New Revision: 1143215
URL: http://svn.apache.org/viewvc?rev=1143215&view=rev
Log:
added simple documentation on the ReportPlugin XML representation and the way
Maven 3 handles old reporting section
Added:
maven/shared/trunk/maven-reporting-exec/src/site/apt/
maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt (with
props)
Added: maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt?rev=1143215&view=auto
==============================================================================
--- maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt (added)
+++ maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt Tue Jul 5
22:14:32 2011
@@ -0,0 +1,41 @@
+ -----
+ Maven Reporting Executor
+ -----
+ Hervé Boutemy
+ -----
+ 2011-07-06
+ -----
+
+Maven Reporting Executor
+
+ Classes to manage report plugin executions with Maven 3.
+
+ Report plugins can be configured in <<<\<configuration\>>>> element of
<<<maven-site-plugin>>> or any other
+ report building plugin with following XML model:
+
++----
+<reportPlugins>
+ <plugin>
+ <groupId/>
+ <artifactId/>
+ <version/>
+ <configuration/>
+ <reports/>
+ <reportSets>
+ <reportSet>
+ <id/>
+ <configuration/>
+ <reports/>
+ </reportSet>
+ </reportSets>
+ </plugin>
+</reportPlugins>
++----
+
+ Notice: this is the model from plugins in <<<\<reporting\>>>> section of POM
without <<<\<inherited\>>>> element
+ and with <<<\<reports\>>>> list that simplifies reports configuration in
usual cases.
+
+ Maven 3 core makes an automatic transformation of <<<\<reporting\>>>> POM
section to <<<maven-site-plugin>>>
+ configuration through the
+
{{{http://maven.apache.org/ref/current/maven-model-builder/apidocs/org/apache/maven/model/plugin/ReportingConverter.html}ReportingConverter}}
+ component.
\ No newline at end of file
Propchange: maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/shared/trunk/maven-reporting-exec/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
