svn commit: r1885407 - /maven/website/components/shared/maven-reporting-exec/index.html

[hb...@apache.org]

Author: hboutemy
Date: Tue Jan 12 21:41:18 2021
New Revision: 1885407

Log:
improve doc

Modified:
    maven/website/components/shared/maven-reporting-exec/index.html

Modified: maven/website/components/shared/maven-reporting-exec/index.html
==============================================================================
--- maven/website/components/shared/maven-reporting-exec/index.html (original)
+++ maven/website/components/shared/maven-reporting-exec/index.html Tue Jan 12 21:41:18 2021
@@ -124,17 +124,19 @@
 <div class="section">
 <h2><a name="Apache_Maven_Reporting_Executor"></a>Apache Maven Reporting Executor</h2>
 <p>Classes to prepare report plugins execution with Maven 3, through <a href="./apidocs/org/apache/maven/reporting/exec/MavenReportExecutor.html">MavenReportExecutor</a> (<a href="./apidocs/org/apache/maven/reporting/exec/DefaultMavenReportExecutor.html">implementation</a>).</p>
-<p>Since 1.4, the request can (and should) be populated from <a href="/ref/current/maven-model/maven.html#class_reporting">pom's <tt>&lt;reporting&gt;</tt> section</a>, injected in Mojo parameter as <tt>${project.reporting.plugins}</tt> default value:</p>
-<div class="source"><pre class="prettyprint linenums">    @Parameter( defaultValue = &quot;${project.reporting.plugins}&quot;, readonly = true )
-    private org.apache.maven.model.ReportPlugin[] reportingPlugins;</pre></div>
-<p>Contrary to Maven 2.x, report <tt>&lt;version&gt;</tt> explicit definition is optional: if no version is specified for a report plugin, version is determined by</p>
+<p>Contrary to Maven 2.x:</p>
+<ol style="list-style-type: decimal">
+<li>report <tt>&lt;version&gt;</tt> explicit definition is optional:<br />if no version is specified for a report plugin, version is determined by
 <ol style="list-style-type: decimal">
 <li>searching for the plugin in the <tt>build/plugins</tt> section of the pom,</li>
 <li>searching for the plugin in the <tt>build/pluginManagement</tt> section of the pom,</li>
-<li>asking <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/version/PluginVersionResolver.html">PluginVersionResolver</a> to get a fallback version and display a warning as it's not a recommended use.</li></ol>
-<p>Since <tt>maven-reporting-exec</tt> 1.2 (which is used by <tt>maven-site-plugin</tt> 3.4), plugin configuration in <tt>build/pluginManagement</tt> is also injected into reports.</p>
+<li>asking <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/version/PluginVersionResolver.html">PluginVersionResolver</a> to get a fallback version and display a warning as it's not a recommended use,</li></ol></li>
+<li>plugin configuration from <tt>build/pluginManagement</tt> is injected into <tt>reporting</tt> section of the pom (since Maven Reporting Executor 1.2, which is <a href="/plugins/maven-site-plugin/history.html">used by Maven Site Plugin 3.4</a>).</li></ol>
 <div class="section">
 <h3><a name="Notice_on_now_obsolete_reportPlugin_format"></a>Notice on now obsolete reportPlugin format</h3>
+<p>Since 1.4 (used by Maven Site Plugin 3.7), the request can (and should) be populated from <a href="/ref/current/maven-model/maven.html#class_reporting">pom's <tt>&lt;reporting&gt;</tt> section</a>, injected in Mojo parameter as <tt>${project.reporting.plugins}</tt> default value:</p>
+<div class="source"><pre class="prettyprint linenums">    @Parameter( defaultValue = &quot;${project.reporting.plugins}&quot;, readonly = true )
+    private org.apache.maven.model.ReportPlugin[] reportingPlugins;</pre></div>
 <p>This section is kept to explain what happened in previous releases of the component, but this approach has been abandonned so far after discovering major limitations: see <a href="/plugins/maven-site-plugin/maven-3.html#New_Configuration_Maven_3_only_no_reports_configuration_inheritance">Maven Site Plugin documentation</a> for more details.</p>
 <p>Report plugins can be configured in <tt>&lt;configuration&gt;</tt> element of <tt>maven-site-plugin</tt> or any other report building plugin with following XML model corresponding to plugin's <tt>List&lt;<a href="./apidocs/org/apache/maven/reporting/exec/ReportPlugin.html">ReportPlugin</a></tt>&gt; parameter:</p>
 <div class="source"><pre class="prettyprint linenums">&lt;reportPlugins&gt;