kaz 02/04/27 06:56:43
Modified: xdocs build-file.xml
. build.xml
src/templates/build build.xml
Log:
Added a 'maven:docs-quick' target that can be used for testing out
changes to the color scheme without having to wait for the generation of
all site documentation (such as checkstyle, changelog, unit test, metric
reports). Also updated the documentation to reflect the new target.
Revision Changes Path
1.29 +22 -0 jakarta-turbine-maven/xdocs/build-file.xml
Index: build-file.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/build-file.xml,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- build-file.xml 23 Apr 2002 15:53:54 -0000 1.28
+++ build-file.xml 27 Apr 2002 13:56:42 -0000 1.29
@@ -456,6 +456,10 @@
<td><a href="#maven:deploy-site">maven:deploy-site</a></td>
<td>Deploys the entire site to the project's web server.</td>
</tr>
+ <tr>
+ <td><a href="#maven:docs-quick">maven:docs-quick</a></td>
+ <td>Generates the "fast" HTML project documentation.</td>
+ </tr>
</table>
<p/>
<subsection name="maven:docs">
@@ -472,6 +476,15 @@
transformed to HTML.
</p>
<p>
+ The color scheme used when generating the project's
+ documentation matches the color scheme used by Maven.
+ However, some or all of the colors may be changed by setting
+ the appropriate properties in the
+ <code>project.properties</code> file. The various settings
+ are documented in the
+ <a href="properties.html#UI Color Settings">Properties</a> documentation.
+ </p>
+ <p>
The generated HTML documentation is placed in the
<code>docs</code> directory relative to the base directory of
the project. If this directory does not exist, it is created.
@@ -548,6 +561,15 @@
should be used as the username when connecting to the remote
site. If the <code>${maven.username}</code> property is not
set, an error is generated.
+ </p>
+ </subsection>
+ <subsection name="maven:docs-quick">
+ <p>
+ The <code>maven:docs-quick</code> target builds only the
+ project's user supplied xdocs and the basic Maven generated
+ xdocs. The testing report, metric report, changelog, and
+ checkstyle report is not generated. This target is useful
+ when testing color scheme modifications.
</p>
</subsection>
</section>
1.30 +4 -0 jakarta-turbine-maven/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/build.xml,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- build.xml 23 Apr 2002 11:43:37 -0000 1.29
+++ build.xml 27 Apr 2002 13:56:43 -0000 1.30
@@ -88,6 +88,10 @@
<ant antfile="${maven.home}/build-docs.xml" target="docs"/>
</target>
+ <target name="maven:docs-quick">
+ <ant antfile="${maven.home}/build-docs.xml" target="docs-quick"/>
+ </target>
+
<target name="maven:test">
<ant antfile="${maven.home}/build-test.xml" target="test"/>
</target>
1.31 +4 -0 jakarta-turbine-maven/src/templates/build/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/templates/build/build.xml,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- build.xml 22 Apr 2002 20:25:06 -0000 1.30
+++ build.xml 27 Apr 2002 13:56:43 -0000 1.31
@@ -45,6 +45,10 @@
<target name="maven:docs">
<ant antfile="$mavenDirectory/build-docs.xml" target="docs"/>
</target>
+
+ <target name="maven:docs-quick">
+ <ant antfile="$mavenDirectory/build-docs.xml" target="docs-quick"/>
+ </target>
<target name="maven:test">
<ant antfile="$mavenDirectory/build-test.xml" target="test"/>
