Author: vsiveton
Date: Fri Sep 11 12:48:00 2009
New Revision: 813812
URL: http://svn.apache.org/viewvc?rev=813812&view=rev
Log:
o clarify doc for reporting plugins (ie using <reporting/> conf vs <build/>
conf)
Modified:
maven/site/trunk/src/site/apt/guides/mini/guide-configuring-plugins.apt
Modified:
maven/site/trunk/src/site/apt/guides/mini/guide-configuring-plugins.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/mini/guide-configuring-plugins.apt?rev=813812&r1=813811&r2=813812&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/mini/guide-configuring-plugins.apt
(original)
+++ maven/site/trunk/src/site/apt/guides/mini/guide-configuring-plugins.apt Fri
Sep 11 12:48:00 2009
@@ -65,9 +65,11 @@
[[3]] {{{Configuring_Reporting_Plugins}Configuring Reporting Plugins}}
- [[1]] {{{Using_the_reportSets_Tag}Using the <<<\<reportSets\>>>> Tag}}
+ [[1]] {{{Using_the_reporting_Tag_VS_build_Tag}Using the
<<<\<reporting\>>>> Tag VS <<<\<build\>>>> Tag}}
- [[2]] {{{Using_the_inherited_Tag_In_Reporting_Plugins}Using the
<<<\<inherited\>>>> Tag In Reporting Plugins}}
+ [[2]] {{{Using_the_reportSets_Tag}Using the <<<\<reportSets\>>>> Tag}}
+
+ [[3]] {{{Using_the_inherited_Tag_In_Reporting_Plugins}Using the
<<<\<inherited\>>>> Tag In Reporting Plugins}}
[]
@@ -89,10 +91,11 @@
{{{http://maven.apache.org/ref/current/maven-model/maven.html#class_plugin}informations}}:
<<<groupId>>>, <<<artifactId>>> and <<<version>>>.
- <<Important Note>>: it is recommended to always defined the plugin version
to guarantee the build reproducibility. A good
- practice is to define the default plugin version in the
- <<<\<build\>\<pluginManagement/\>\</build\>>>> tag for each build plugin and
in the
- <<<\<reporting\>\<plugins/\>\</reporting\>>>> tag for each reporting plugin.
+ <<Important Note>>: It is recommended to always defined each version of the
plugins used by the build to guarantee
+ the build reproducibility. A good practice is to specify them in the
<<<\<build\>\<pluginManagement/\>\</build\>>>>
+ elements for <<each>> build plugins (generally, you will define a
\<pluginManagement/\> element in a parent POM).
+ For reporting plugins, you should specify each version in the
<<<\<reporting\>\<plugins/\>\</reporting\>>>> elements
+ (and surely in the <<<\<build\>\<pluginManagement/\>\</build\>>>> elements
too).
* {Generic Configuration}
@@ -639,6 +642,20 @@
The following is only to configure Reporting plugins in the
<<<\<reporting/\>>>> element.
+** {Using the <<<\<reporting/\>>>> Tag VS <<<\<build/\>>>> Tag}
+
+ Configuring a reporting plugin in the \<reporting/\> or \<build/\> elements
in the pom have <<NOT>> the same behavior!
+
+ [<<<mvn site>>>] It uses <<only>> the parameters defined in the
\<configuration/\> element of each reporting Plugin
+ specified in the \<reporting/\> element, i.e. <<<site>>> always <<ignores>>
the parameters defined in the
+ \<configuration/\> element of each plugin specified in \<build/\>.
+
+ [<<<mvn aplugin:areportgoal>>>] It uses <<firstly>> the parameters defined
in the \<configuration/\> element of each
+ reporting Plugin specified in the \<reporting/\> element; if a parameter is
not found, it will look up to a parameter
+ defined in the \<configuration/\> element of each plugin specified in
\<build/\>.
+
+ []
+
** {Using the <<<\<reportSets/\>>>> Tag}
You can configure a reporting plugin using the <<<\<reportSets\>>>> tag.
This is most commonly used to generate
