You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by ad...@apache.org on 2002/05/08 12:18:44 UTC
cvs commit: jakarta-ant-myrmidon/site/src/xdocs project-descriptor.xml
adammurdoch 02/05/08 03:18:44
Modified: site/src/xdocs/stylesheets project.xml
Added: site/src/xdocs project-descriptor.xml
Log:
Added some info about the project descriptor to the docs.
Revision Changes Path
1.3 +1 -0 jakarta-ant-myrmidon/site/src/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/stylesheets/project.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- project.xml 22 Apr 2002 06:24:28 -0000 1.2
+++ project.xml 8 May 2002 10:18:44 -0000 1.3
@@ -28,6 +28,7 @@
<menu name="Developers Guide">
<item name="Sub Projects" href="/subprojects.html"/>
+ <item name="The Build System" href="/project-descriptor.html"/>
</menu>
</body>
1.1 jakarta-ant-myrmidon/site/src/xdocs/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
<document>
<properties>
<author email="adammurdoch@apache.org">Adam Murdoch</author>
<title>Project Descriptor</title>
</properties>
<body>
<section name="Project Descriptor">
<p>Each Myrmidon sub-project has a project descriptor associated with it.
This is an xml file that provides meta-information about the project,
such as the name of the project, its current version, where the
source can be found, and so on. The descriptor is used to generate
the project's build file.
</p>
<p>The root element of the project descriptor must be a
<code><project></code> element. The <code><project></code>
element may contain the following elements:
</p>
<table>
<tr><th>Element</th><th>Description</th><th>Multivalued</th></tr>
<tr>
<td><a href="#build">build</a></td>
<td>The details of how to compile the project and assemble it
into jar files.</td>
<td>no</td>
</tr>
<tr>
<td>classpath</td>
<td>The project classpath, used for compiling the project
source, and unit tests. This is an Ant <code><path></code>
data-type.</td>
<td>no</td>
</tr>
<tr>
<td>copyrightYear</td>
<td>The year(s) that the project was copyrighted in.</td>
<td>no</td>
</tr>
<tr>
<td>currentVersion</td>
<td>The version number for the project.</td>
<td>no</td>
</tr>
<tr>
<td>dist</td>
<td>The additional Ant tasks for preparing the distribution.
By default, the project's jar files and Javadocs are copied
into the distribution directory. Use this element to perform
extra tasks to assemble the distribution.</td>
<td>no</td>
</tr>
<tr>
<td>id</td>
<td>The identifier for the project. Used in generated file
and directory names.</td>
<td>no</td>
</tr>
<tr>
<td>name</td>
<td>The descriptive name of the project. Used as the title
for the project's Javadocs.</td>
<td>no</td>
</tr>
<tr>
<td>package</td>
<td>The root Java package for the project. Used to generate the
project's Javadocs.</td>
<td>yes</td>
</tr>
<tr>
<td>property</td>
<td>A global build property. This is an Ant
<code><property></code> task.</td>
<td>yes</td>
</tr>
<tr>
<td>target</td>
<td>An additional target to add to the build file. This is
an Ant target, and is copied directly into the generated build
file.</td>
<td>yes</td>
</tr>
<tr>
<td><a href="#unittest">unitTest</a></td>
<td>The details of how to compile and execute the unit tests.</td>
<td>no</td>
</tr>
</table>
<subsection name="Build Definition" anchor="build">
<p>The <code><build></code> element describes how to compile the
project and assemble it into Jar files. The <code><build></code>
element may contain the following nested elements:</p>
<table>
<tr><th>Element</th><th>Description</th><th>Multivalued</th></tr>
<tr>
<td><a href="#jar">antlib</a></td>
<td>Defines an antlib output file.</td>
<td>yes</td>
</tr>
<tr>
<td>classpath</td>
<td>The classpath to use for compiling the project source.
This is appended to the project classpath. This is
an Ant <code><path></code> data-type.</td>
<td>no</td>
</tr>
<tr>
<td>compilePatterns</td>
<td>The patternset to use when compiling the project source.
This is an Ant <code><patternset></code>.</td>
<td>yes</td>
</tr>
<tr>
<td><a href="#jar">jar</a></td>
<td>Defines a Jar output file.</td>
<td>yes</td>
</tr>
<tr>
<td>prepare</td>
<td>Additional Ant tasks to perform before compiling
the source. This can be used, for example, to check for
the availability of various libraries.</td>
<td>no</td>
</tr>
<tr>
<td>sourceDirectory</td>
<td>The directory containing the project's Java source files.</td>
<td>yes</td>
</tr>
</table>
</subsection>
<subsection name="Unit Test Definition" anchor="unittest">
<p>The <code><unitTest></code> element defines how to compile
and execute the project's unit tests. The <code><unitTest></code>
element may contain the following nested elements:</p>
<table>
<tr><th>Element</th><th>Description</th><th>Multivalued</th></tr>
<tr>
<td>classpath</td>
<td>The classpath to use for compiling and executing the
project unit tests. This is appended to the project
classpath. This is an Ant <code><path></code> data-type.</td>
<td>no</td>
</tr>
<tr>
<td>compilePatterns</td>
<td>The patternset to use when compiling the unit tests.
This is an Ant <code><patternset></code>. This
is combined with the compile patternset.</td>
<td>yes</td>
</tr>
<tr>
<td>includeDescriptors</td>
<td>Controls whether antlib descriptors are generated for
the unit tests. Descriptors are generated by default.</td>
<td>no</td>
</tr>
<tr>
<td>prepare</td>
<td>Additional Ant tasks to perform before executing the
unit tests.</td>
<td>no</td>
</tr>
<tr>
<td>sourceDirectory</td>
<td>The directory containing the project's unit test source files.</td>
<td>no</td>
</tr>
<tr>
<td>unitTestPatterns</td>
<td>The patternset to use to select the unit tests to execute.
This is an Ant <code><patternset></code> datatype.</td>
<td>no</td>
</tr>
</table>
</subsection>
<subsection name="Jar Definition" anchor="jar">
<p>The <code><antlib></code> and <code><jar></code> elements
define antlib and jar output files, respectively. There is no
difference between these elements, except the output file name.
A manifest and antlib descriptors are generated for the output file.
The <code><antlib></code> and <code><jar></code> elements
may take the following nested elements:</p>
<table>
<tr><th>Element</th><th>Description</th><th>Multivalued</th></tr>
<tr>
<td>attribute</td>
<td>Defines an attribute to add to the main section of
the manifest.</td>
<td>yes</td>
</tr>
<tr>
<td>depends</td>
<td>Defines the extensions which the output file depends on.
Used to generate the manifest.</td>
<td>no</td>
</tr>
<tr>
<td>extension</td>
<td>Defines an extension. Used to generate the manifest.</td>
<td>no</td>
</tr>
<tr>
<td>fileset</td>
<td>Additional files to include in the output file. This
is an Ant <code><fileset></code> datatype.</td>
<td>yes</td>
</tr>
<tr>
<td>id</td>
<td>A unique short name for the output file. This is used
in the output file name, and the names of generated files.</td>
<td>no</td>
</tr>
<tr>
<td>includeDescriptors</td>
<td>Controls whether antlib descriptors are generated for
the output file. Descriptors are generated by default.</td>
<td>no</td>
</tr>
<tr>
<td>metainf</td>
<td>See the <code><jar></code> Ant task.</td>
<td>yes</td>
</tr>
<tr>
<td>name</td>
<td>Specifies the name of the output file. By default, the
name is generated from the id and current version.</td>
<td>no</td>
</tr>
<tr>
<td>patternset</td>
<td>Specifies which classes to include in the output file.
This is an Ant <code><patternset></code>.</td>
<td>no</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>