This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch MNG-5987
in repository https://gitbox.apache.org/repos/asf/maven.git
commit b077e75ef1af73511bdc0d250cefcb4d06c0e181
Author: Hervé Boutemy <hbout...@apache.org>
AuthorDate: Sun Jun 4 10:06:03 2023 +0200
[MNG-5987] document goals execution order
---
maven-artifact/src/site/site.xml | 2 +-
maven-builder-support/src/site/site.xml | 2 +-
maven-compat/src/site/site.xml | 2 +-
maven-core/src/site/apt/index.apt | 19 ++++++++++++++++++-
maven-core/src/site/site.xml | 2 +-
.../apache/maven/maven-parent/5/maven-parent-5.pom | 2 +-
maven-embedder/src/site/site.xml | 2 +-
.../resources/org/apache/maven/model/pom-4.0.0.xml | 2 +-
maven-model-builder/src/site/site.xml | 2 +-
maven-model/src/site/site.xml | 2 +-
maven-plugin-api/src/main/mdo/plugin.mdo | 6 +++---
maven-plugin-api/src/site/apt/index.apt | 14 ++++++++++----
maven-plugin-api/src/site/site.xml | 6 +++---
maven-repository-metadata/src/site/site.xml | 2 +-
maven-resolver-provider/src/site/site.xml | 2 +-
maven-settings-builder/src/site/site.xml | 2 +-
maven-settings/src/site/site.xml | 2 +-
maven-slf4j-provider/src/site/site.xml | 2 +-
src/site/site.xml | 2 +-
19 files changed, 49 insertions(+), 26 deletions(-)
diff --git a/maven-artifact/src/site/site.xml b/maven-artifact/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-artifact/src/site/site.xml
+++ b/maven-artifact/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-builder-support/src/site/site.xml
b/maven-builder-support/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-builder-support/src/site/site.xml
+++ b/maven-builder-support/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-compat/src/site/site.xml b/maven-compat/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-compat/src/site/site.xml
+++ b/maven-compat/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-core/src/site/apt/index.apt
b/maven-core/src/site/apt/index.apt
index ca2e2516c..ec9d65055 100644
--- a/maven-core/src/site/apt/index.apt
+++ b/maven-core/src/site/apt/index.apt
@@ -49,7 +49,24 @@ Maven Core
* <<<ProjectBuilder>>> component
({{{./apidocs/org/apache/maven/project/ProjectBuilder.html}javadoc}}),
with its <<<DefaultProjectBuilder>>> implementation
- ({{{./xref/org/apache/maven/project/DefaultProjectBuilder.html}source}}),
+ ({{{./xref/org/apache/maven/project/DefaultProjectBuilder.html}source}}), to
prepare
{{{./apidocs/org/apache/maven/project/MavenProject.html}<<<MavenProject>>>
descriptor}} from POM files,
+
+ * <<<LifecycleExecutor>>> component
({{{./apidocs/org/apache/maven/lifecycle/LifecycleExecutor.html}javadoc}}),
+ with its <<<DefaultLifecycleExecutor>>>
implementation({{{/xref/org/apache/maven/lifecycle/DefaultLifecycleExecutor.html}source}}),
to plan or execute tasks.\
+ on plugin goals execution order:
+
+ * <<in a given phase, goals order is not expected to be guaranteed nor
finely tuned>>:
+ it is just a consequence of the order obtained during
{{{../maven-model-builder/}effective model building}},
+ which combines profile activation+injection and inheritance assembly from
parents,
+
+ * known limitations are notably that:
+
+ 1. plugin goal execution in a child is usually simply appended (at end):
you can't try to insert in the middle of pre-existing inherited executions,
+
+ 2. append happens at plugin level first, then goal level, independently
from phases.
+ This means for example that adding pluginA:goal2 to pre-existing
(pluginA:goal1, pluginB:goal) will lead to (pluginA:goal1, pluginA:goal2,
pluginB:goal)
+
+ * see effective POM as shown by
{{{/plugins/maven-help-plugin/effective-pom-mojo.html}<<<help:effective-pom>>>}}
to see the effective plugins then goals order.
* <<<MavenPluginManager>>> component
({{{./apidocs/org/apache/maven/plugin/MavenPluginManager.html}javadoc}}),
with its <<<DefaultMavenPluginManager>>> implementation
diff --git a/maven-core/src/site/site.xml b/maven-core/src/site/site.xml
index 4ddb7aaca..e5ce8e6f3 100644
--- a/maven-core/src/site/site.xml
+++ b/maven-core/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git
a/maven-core/src/test/resources/org/apache/maven/extension/test-extension-repo/org/apache/maven/maven-parent/5/maven-parent-5.pom
b/maven-core/src/test/resources/org/apache/maven/extension/test-extension-repo/org/apache/maven/maven-parent/5/maven-parent-5.pom
index 9718a6465..429fc10dc 100644
---
a/maven-core/src/test/resources/org/apache/maven/extension/test-extension-repo/org/apache/maven/maven-parent/5/maven-parent-5.pom
+++
b/maven-core/src/test/resources/org/apache/maven/extension/test-extension-repo/org/apache/maven/maven-parent/5/maven-parent-5.pom
@@ -445,7 +445,7 @@ under the License.
<version>2.2</version>
<executions>
<execution>
- <id>attach-javadocs</id>
+ <id>attach-Javadocs</id>
<goals>
<goal>jar</goal>
</goals>
diff --git a/maven-embedder/src/site/site.xml b/maven-embedder/src/site/site.xml
index 908e741f8..c1bd4a7df 100644
--- a/maven-embedder/src/site/site.xml
+++ b/maven-embedder/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git
a/maven-model-builder/src/main/resources/org/apache/maven/model/pom-4.0.0.xml
b/maven-model-builder/src/main/resources/org/apache/maven/model/pom-4.0.0.xml
index b19a7d7b7..10e4544a0 100644
---
a/maven-model-builder/src/main/resources/org/apache/maven/model/pom-4.0.0.xml
+++
b/maven-model-builder/src/main/resources/org/apache/maven/model/pom-4.0.0.xml
@@ -127,7 +127,7 @@ under the License.
<artifactId>maven-javadoc-plugin</artifactId>
<executions>
<execution>
- <id>attach-javadocs</id>
+ <id>attach-Javadocs</id>
<goals>
<goal>jar</goal>
</goals>
diff --git a/maven-model-builder/src/site/site.xml
b/maven-model-builder/src/site/site.xml
index 7aaee5a6b..61e47a68f 100644
--- a/maven-model-builder/src/site/site.xml
+++ b/maven-model-builder/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-model/src/site/site.xml b/maven-model/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-model/src/site/site.xml
+++ b/maven-model/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-plugin-api/src/main/mdo/plugin.mdo
b/maven-plugin-api/src/main/mdo/plugin.mdo
index ee70ee52e..22e248362 100644
--- a/maven-plugin-api/src/main/mdo/plugin.mdo
+++ b/maven-plugin-api/src/main/mdo/plugin.mdo
@@ -24,9 +24,9 @@ under the License.
<description><![CDATA[
Plugin descriptor, stored in <code>META-INF/maven/plugin.xml</code> in a
plugin's jar artifact.
This descriptor is generally generated from plugin sources, using
- <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>.
- <p><i>Notice:</i> this documentation is generated from a Modello model but
the code executed is not generated
- from this descriptor. Please report if you find anything wrong.</p>
+ <a href="/plugins/maven-plugin-plugin/">maven-plugin-plugin</a>, but other
tools may geenrated it or it could even be hand-written.
+ <p><i>Notice:</i> this documentation is generated from a Modello model but
the code executed is not based
+ on this descriptor. Please report if you find anything wrong in this
documentation.</p>
]]></description>
<defaults>
<default>
diff --git a/maven-plugin-api/src/site/apt/index.apt
b/maven-plugin-api/src/site/apt/index.apt
index 6eb59556c..7b232d591 100644
--- a/maven-plugin-api/src/site/apt/index.apt
+++ b/maven-plugin-api/src/site/apt/index.apt
@@ -25,15 +25,21 @@
Maven Plugin API
- The API for plugins - composed of goals implemented by Mojos - development.
+ The API for plugins - composed of goals implemented by Mojos - development:
+
+ * goal code extends
{{{./apidocs/org/apache/maven/plugin/AbstractMojo.html}<<<AbstractMojo>>> base
class}} that implements
{{{./apidocs/org/apache/maven/plugin/Mojo.html}<<<Mojo>>> interface}},
+
+ * {{{./apidocs/org/apache/maven/plugin/logging/Log.html}<<<Log>>> interface}}
provides easy logging for the goal.
+
+ []
A plugin is described in a {{{./plugin.html}<<<META-INF/maven/plugin.xml>>>
plugin descriptor}},
- generally generated from plugin sources using
{{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}}.
+ generally generated from plugin sources using
{{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}} (other tools may
generate it, or it could eventually be hand-written).
* See Also
* {{{/developers/mojo-api-specification.html}Mojo API Specification}}
- * {{{/plugin-tools/}plugin-tools}}
+ * {{{/plugin-tools/}Plugin Tools}} that provide
{{{/plugin-tools/maven-plugin-plugin/}maven-plugin-plugin}} to generate the
{{{./plugin.html}<<<META-INF/maven/plugin.xml>>> plugin descriptor}}
- * {{{/plugin-testing/}plugin-testing}}
+ * {{{/plugin-testing/}Plugin Testing}} frameworks
diff --git a/maven-plugin-api/src/site/site.xml
b/maven-plugin-api/src/site/site.xml
index 224f30ecf..1cbf42b09 100644
--- a/maven-plugin-api/src/site/site.xml
+++ b/maven-plugin-api/src/site/site.xml
@@ -27,13 +27,13 @@
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
<menu name="Reference">
- <item name="lifecycle.xml" href="lifecycle-mappings.html"/>
- <item name="plugin.xml" href="plugin.html"/>
+ <item name="META-INF/maven/lifecycle.xml"
href="lifecycle-mappings.html"/>
+ <item name="META-INF/maven/plugin.xml" href="plugin.html"/>
</menu>
<menu ref="parent"/>
diff --git a/maven-repository-metadata/src/site/site.xml
b/maven-repository-metadata/src/site/site.xml
index c24e1433e..be08a3317 100644
--- a/maven-repository-metadata/src/site/site.xml
+++ b/maven-repository-metadata/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<!--item name="Source Xref" href="xref/index.html"/-->
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-resolver-provider/src/site/site.xml
b/maven-resolver-provider/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-resolver-provider/src/site/site.xml
+++ b/maven-resolver-provider/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-settings-builder/src/site/site.xml
b/maven-settings-builder/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-settings-builder/src/site/site.xml
+++ b/maven-settings-builder/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-settings/src/site/site.xml b/maven-settings/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-settings/src/site/site.xml
+++ b/maven-settings/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/maven-slf4j-provider/src/site/site.xml
b/maven-slf4j-provider/src/site/site.xml
index e475330c4..8ffe43d07 100644
--- a/maven-slf4j-provider/src/site/site.xml
+++ b/maven-slf4j-provider/src/site/site.xml
@@ -27,7 +27,7 @@ under the License.
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
</menu>
diff --git a/src/site/site.xml b/src/site/site.xml
index 83da6d7d0..3ba52bda5 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -39,7 +39,7 @@ under the License.
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="JavaDocs" href="apidocs/index.html"/>
+ <item name="Javadocs" href="apidocs/index.html"/>
<item name="Source Xref" href="xref/index.html"/>
<!--item name="FAQ" href="faq.html"/-->
<item name="License" href="http://www.apache.org/licenses/"/>
