evenisse 2003/07/03 02:45:53
Modified: xdocs/reference project-descriptor.xml
Log:
Update docs relative to pom.
Revision Changes Path
1.17 +50 -76 maven/xdocs/reference/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/project-descriptor.xml,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- project-descriptor.xml 18 May 2003 14:53:45 -0000 1.16
+++ project-descriptor.xml 3 Jul 2003 09:45:53 -0000 1.17
@@ -678,109 +678,83 @@
</td>
</tr>
<tr>
- <td><a href="#jarResources">jarResources</a></td>
- <td>
- This element specifies any additional resources that should
- be packaged up inside the JAR file. Each resource is
- specified by a <code>jarResource</code> element.
- </td>
+ <td><a href="#unitTest">unitTest</a></td>
+ <td>This element specifies unit tests associated with the project.</td>
</tr>
<tr>
- <td><a href="#jars">jars</a></td>
- <td>
- This element specifies the additional JARs that should be
- packaged as part of the final JAR. [TODO: not quite sure how
- this is different than jarResources, need further
- clarification.] Each additional JAR is specified by a
- <code>jar</code> element.
- </td>
- </tr>
- <tr>
- <td><a href="#unitTestPatterns">unitTestPatterns</a></td>
- <td>
- This element specifies the Java source file patterns to
- indicate which files are unit tests in the
- <code>unitTestSourceDirectory</code>. Each pattern is
- specified by a <code>unitTestPattern</code> element.
- </td>
- </tr>
- <tr>
- <td><a
href="#integrationUnitTestPatterns">integrationUnitTestPatterns</a></td>
- <td>
- This element specifies the Java source file patterns to
- indicate which files are integration unit tests in the
- <code>integrationUnitTestSourceDirectory</code>. Each
- pattern is specified by a
- <code>integrationUnitTestPattern</code> element.
- </td>
+ <td><a href="#resources">resources</a></td>
+ <td>Describe the resources associated with the project</td>
</tr>
</table>
- <subsection name="jarResources">
+ <subsection name="unitTest">
<table>
<tr><th>Element</th><th>Description</th></tr>
<tr>
- <td>jarResource</td>
- <td>
- The pattern specifying the resource to be packaged in the
- JAR file created by the <a
- href="build-file.html#maven:jar">maven:jar</a> target. This
- value can be either: <code>include = AntPattern</code>,
- <code>exclude = AntPattern</code>, or a JAR descriptor
- file. The path name is relative to
- <code>${basedir}</code> unless it has been overridden via
- the
- <a href="properties.html#Directory Layout Settings">
- <code>${maven.jarResources.basedir}</code></a> property.
- </td>
+ <td><a href="#resources">resources</a></td>
+ <td>Describe the resources associated with unit tests</td>
+ </tr>
+ <tr>
+ <td><a href="#includes">includes</a></td>
+ <td>Describe the includes unit tests</td>
+ </tr>
+ <tr>
+ <td><a href="#excludes">excludes</a></td>
+ <td>Describe the excludes unit tests</td>
</tr>
</table>
</subsection>
- <subsection name="unitTestPatterns">
+ <subsection name="resources">
+ <p>
+ This element describes all of the resources associated with a project or
unit tests.
+ Each resource is described by a resource element, which is then described
by additional
+ elements (described <a href="#resource">below</a>). These resources are
used to
+ complete the jar file or to run unit test.
+ </p>
+ </subsection>
+ <subsection name="resource">
<table>
<tr><th>Element</th><th>Description</th></tr>
<tr>
- <td>unitTestPattern</td>
+ <td>directory</td>
+ <td>Describe the directory where the resource is stored.</td>
+ </tr>
+ <tr>
+ <td><a href="#includes">includes</a></td>
+ <td>Describe the includes files to the project</td>
+ </tr>
+ <tr>
+ <td><a href="#excludes">excludes</a></td>
+ <td>Describe the excludes files to the project</td>
+ </tr>
+ <tr>
+ <td>targetPath</td>
<td>
- The pattern specifying a set of Java source files. This
- value can be either: <code>include = AntPattern</code>,
- <code>exclude = AntPattern</code>, or a JAR descriptor
- file. Note: these patterns specify <code>.java</code>
- sources and not <code>.class</code> files. These unit
- tests must use the <a
- href="http://www.junit.org";>JUnit</a> testing framework.
+ Describe the resource target path. For example, if you want that
resource
+ appear into a specific package
(<code>org.apache.maven.messages</code>), you must specify this
+ element with this value : <code>org/apache/maven/messages</code>
</td>
</tr>
+ <tr>
+ <td>filtering</td>
+ <td>Boolean. Describe if resources are filtering or not.</td>
+ </tr>
</table>
</subsection>
- <subsection name="integrationUnitTestPatterns">
+ <subsection name="includes">
<table>
<tr><th>Element</th><th>Description</th></tr>
<tr>
- <td>integrationUnitTestPattern</td>
- <td>
- The pattern specifying a set of Java source files. This
- value can be either: <code>include = AntPattern</code>,
- <code>exclude = AntPattern</code>, or a JAR descriptor
- file. Note: these patterns specify <code>.java</code>
- sources and not <code>.class</code> files. These unit
- tests must use the <a
- href="http://jakarta.apache.org/cactus/";>Cactus</a>
- testing framework.
- </td>
+ <td>include</td>
+ <td>This element specify an Ant pattern.</td>
</tr>
</table>
</subsection>
- <subsection name="jars">
+ <subsection name="excludes">
<table>
<tr><th>Element</th><th>Description</th></tr>
<tr>
- <td>jar</td>
- <td>
- A JAR that should be packaged in the project's JAR. This
- can be used to package additional JAR files with your
- project. The JAR is relative to <code>${basedir}</code>
- if an absolute path is not used.
- </td>
+ <td>exclude</td>
+ <td>This element specify an Ant pattern.</td>
</tr>
</table>
</subsection>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
