Improved documentation

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115027 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
vmassol 2004-04-20 20:09:54 +00:00
parent ef248b2978
commit 7158d70aa0

View File

@ -30,10 +30,16 @@
<!-- Default goal: builds sites for all subprojects -->
<!--==================================================================-->
<goal name="multiproject"
description="Run the site goal of all subprojects"
description="Run the site goal of all subprojects and generate overview page"
prereqs="multiproject:site">
</goal>
<!--======================================================================-->
<!-- Runs reactor and puts variable "multiprojects" into jelly context. -->
<!-- Runs reactor and puts variable "multiprojects" into jelly context. -->
<!-- This allows to share the work done by reactor in goals -->
<!-- which just need the list of project but don't need to run any goal -->
<!--======================================================================-->
<goal name="multiproject:projects-init">
<j:if test="${mpprojectsInit == null}">
<j:set var="mpprojectsInit" value="true" />
@ -52,9 +58,7 @@
</goal>
<!--======================================================================-->
<!-- Runs reactor and puts variable "multiprojects" into jelly contex -->
<!-- This allows to share the work done by reactor in goals -->
<!-- which just need the list of project but don't need to run any goal -->
<!-- Initializations for the multiproject:site goal -->
<!--======================================================================-->
<goal name="multiproject:site-init" prereqs="multiproject:projects-init">
@ -72,17 +76,15 @@
</j:if>
</goal>
<!--==================================================================-->
<!-- Builds sites for all subprojects -->
<!--==================================================================-->
<goal name="multiproject:site"
prereqs="multiproject:site-init"
description="Run the site goal of all subprojects">
description="Run the site goal of all subprojects and generate overview page">
<attainGoal name="multiproject:create-nav"/>
<attainGoal name="multiproject:create-overview-page"/>
<attainGoal name="site" />
<!-- copy or not? -->
@ -96,7 +98,7 @@
goals="site"
ignoreFailures="${maven.multiproject.ignoreFailures}"
/>
<echo>now building reactor projects: ${multiprojects}</echo>
<echo>Now building reactor projects: ${multiprojects}</echo>
<!-- copy each project over into ${maven.docs.dest} -->
<j:forEach var="reactorProject" items="${multiprojects}">
@ -124,7 +126,6 @@
<goal name="multiproject:create-nav"
prereqs="multiproject:site-init">
<j:forEach var="reactorProject" items="${multiprojects}">
<j:if test="${reactorProject.id == pom.id}">
<fail message="You must exclude ${pom.id} (the top level project) from the subproject set"/>
@ -226,7 +227,6 @@ maven -Dgoal=clean multiproject:goal</maven:param-check>
</goal>
<!--==================================================================-->
<!-- Run 'artifact':install for all subprojects -->
<!--==================================================================-->
@ -309,7 +309,6 @@ maven -Dgoal=clean multiproject:goal</maven:param-check>
</goal>
<!--==================================================================-->
<!-- Maven Report API - Deregister -->
<!--==================================================================-->
@ -351,7 +350,6 @@ maven -Dgoal=clean multiproject:goal</maven:param-check>
/>
</goal>
<!--==================================================================-->
<!-- Cleans all subprojects -->
<!--==================================================================-->
@ -363,5 +361,4 @@ maven -Dgoal=clean multiproject:goal</maven:param-check>
</goal>
</project>