jvanzyl 2003/02/14 07:43:10
Modified: xdocs/reference user-guide.xml
Log:
o Adding little blurb on reporting and how to configure it.
Revision Changes Path
1.40 +48 -11 jakarta-turbine-maven/xdocs/reference/user-guide.xml
Index: user-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/reference/user-guide.xml,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -r1.39 -r1.40
--- user-guide.xml 14 Feb 2003 14:52:47 -0000 1.39
+++ user-guide.xml 14 Feb 2003 15:43:09 -0000 1.40
@@ -146,8 +146,8 @@
<logo>/images/jakarta-logo-blue.gif</logo>
</organization>
<inceptionYear>2001</inceptionYear>
- <package>org.apache.${pom.id}</package>
- <logo>/images/${pom.id}.jpg</logo>
+ <package>org.apache.${pom.artifactId}</package>
+ <logo>/images/${pom.artifactId}.jpg</logo>
<description>Maven is a project that was created in
${pom.inceptionYear}.</description>
<shortDescription>${pom.name} is a Java Project Management Tool</shortDescription>
@@ -212,19 +212,19 @@
<gumpRepositoryId>jakarta</gumpRepositoryId>
- <url>http://jakarta.apache.org/commons/${pom.id}.html</url>
+ <url>http://jakarta.apache.org/commons/${pom.artifactId}.html</url>
<issueTrackingUrl>http://nagoya.apache.org/</issueTrackingUrl>
<siteAddress>jakarta.apache.org</siteAddress>
- <siteDirectory>/www/jakarta.apache.org/commons/${pom.id}/</siteDirectory>
+ <siteDirectory>/www/jakarta.apache.org/commons/${pom.artifactId}/</siteDirectory>
<distributionDirectory>
- /www/jakarta.apache.org/builds/jakarta-commons/${pom.id}/
+ /www/jakarta.apache.org/builds/jakarta-commons/${pom.artifactId}/
</distributionDirectory>
<repository>
<connection>
-
scm:cvs:pserver:[EMAIL PROTECTED]:/home/cvspublic:jakarta-commons/${pom.id}
+
scm:cvs:pserver:[EMAIL PROTECTED]:/home/cvspublic:jakarta-commons/${pom.artifactId}
</connection>
- <url>http://cvs.apache.org/viewcvs/jakarta-commons/${pom.id}/</url>
+ <url>http://cvs.apache.org/viewcvs/jakarta-commons/${pom.artifactId}/</url>
</repository>
...
</project>
@@ -243,7 +243,7 @@
]]></source>
<p>
- And what you will get is the child's ${pom.id} value substituted into
+ And what you will get is the child's ${pom.artifactId} value substituted
into
the parent template. So for projects like the commons where you have
many builds that are basically set up the same way you can use a master
template and leave very little in the child's project.xml file.
@@ -255,9 +255,9 @@
builds.
</p>
<p>
- If you're wondering what the DVSL reports will look like using this
- mechanism then you're on the ball! I have changed the DVSL reporting to
- work on the POM itself i.e. the DVSL transformation is performed on a
+ If you're wondering what the JSL reports will look like using this
+ mechanism then you're on the ball! The JSL reporting
+ works on the POM itself i.e. the Jelly JSL transformation is performed on
a
Java object. This was necessary in order for reports to come out
correctly when interpolation and inheritance are involved. You can't use
the child template listed above and expect it to work. We need to use
@@ -1279,6 +1279,43 @@
reports will be generated. This tag enables you to
selectively choose which reports to include and exclude as
well as the order of the reports.
+ </p>
+
+ <p>
+ If you would like to use the report customization feature you
+ might have a POM that looks like the following:
+ </p>
+
+<source><![CDATA[
+<project>
+ <id>bar</id>
+ <name>Baradelic Groove Machine</name>
+ <groupId>org.bar.foo</groupId>
+
+ ...
+
+ <reports>
+ <report>maven-jdepend-plugin</report>
+ <report>maven-checkstyle-plugin</report>
+ <report>maven-changelog-plugin</report>
+ <report>maven-file-activity-plugin</report>
+ <report>maven-developer-activity-plugin</report>
+ <report>maven-javadoc-plugin</report>
+ <report>maven-jxr-plugin</report>
+ <report>maven-junit-report-plugin</report>
+ <report>maven-tasklist-plugin</report>
+ <report>maven-jellydoc-plugin</report>
+ </reports>
+</project>
+]]></source>
+
+ <p>
+ So you can choose from any of the default reports that Maven
+ provides or you can create your own report plugins and hook
+ them in using this mechanism. To find out how to make your
+ report plugins conform please refer to the
+ <a href="developer-guide.html#Reporting Protocol">Reporting
+ Protocol</a> section in the Developer's Guide.
</p>
</subsection>
<subsection name="Exclusion of All Maven-Generated Content">
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
