dion 2003/08/05 09:13:38
Modified: xdocs/reference project-descriptor.xml
Log:
Add docs on sourceModification
Revision Changes Path
1.21 +53 -6 maven/xdocs/reference/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/project-descriptor.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- project-descriptor.xml 5 Aug 2003 15:45:15 -0000 1.20
+++ project-descriptor.xml 5 Aug 2003 16:13:38 -0000 1.21
@@ -1,9 +1,6 @@
<?xml version="1.0"?>
<document>
-<!--
- | FIXME: This file is missing details on the
build/sourceModifications/sourceModification element
- |-->
<properties>
<author email="[EMAIL PROTECTED]">Pete Kazmier</author>
<author email="[EMAIL PROTECTED]">don Gillard</author>
@@ -678,7 +675,7 @@
</td>
</tr>
<tr>
- <td>sourceDirectory</td>
+ <td><a name="sourceDirectory">sourceDirectory</a></td>
<td>
This element specifies a directory containing the source
of the project. The generated build system will compile
@@ -686,6 +683,13 @@
</td>
</tr>
<tr>
+ <td><a href="#sourceModifications">sourceModifications</a></td>
+ <td>
+ This element specifies how source code will be excluded or included
+ depending on the presence of a given class.
+ </td>
+ </tr>
+ <tr>
<td>aspectSourceDirectory</td>
<td>
This element specifies a directory containing Aspect
@@ -704,6 +708,41 @@
<td>Describe the resources associated with the project</td>
</tr>
</table>
+ <subsection name="sourceModifications">
+ <p>
+ This element describes all of the sourceModifications associated with a
+ project. Each source modification is described by a
+ <code>sourceModification</code> element, which is then described by
+ additional elements (described below). These modifications are used
+ to exclude or include various source depending on the environment
+ the build is running in.
+ </p>
+
+ <p>sourceModification elements</p>
+ <table>
+ <tr><th>Element</th><th>Description</th></tr>
+ <tr>
+ <td>className</td>
+ <td>
+ If the class with this name can <strong>not</strong> be
+ loaded, then the includes and excludes specified below
+ will be applied to the contents of the
+ <a href="#sourceDirectory">sourceDirectory</a>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#includes">includes</a></td>
+ <td>Describe the files to be included if the class was not found</td>
+ </tr>
+ <tr>
+ <td><a href="#excludes">excludes</a></td>
+ <td>Describe the files to be excluded if the class was not found</td>
+ </tr>
+ </table>
+ <p>
+ <strong>Note</strong>: not all plugins support the sourceModifications
element.
+ </p>
+ </subsection>
<subsection name="unitTest">
<table>
<tr><th>Element</th><th>Description</th></tr>
@@ -770,7 +809,11 @@
<tr><th>Element</th><th>Description</th></tr>
<tr>
<td>include</td>
- <td>This element specify an Ant pattern.</td>
+ <td>
+ This element specifies an
+ <a href="http://ant.apache.org/manual/CoreTypes/patternset.html";>Ant
pattern</a>
+ of files to include in a list.
+ </td>
</tr>
</table>
</subsection>
@@ -779,7 +822,11 @@
<tr><th>Element</th><th>Description</th></tr>
<tr>
<td>exclude</td>
- <td>This element specify an Ant pattern.</td>
+ <td>
+ This element specifies an
+ <a href="http://ant.apache.org/manual/CoreTypes/patternset.html";>Ant
pattern</a>
+ of files to exclude from a list.
+ </td>
</tr>
</table>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
