You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by bo...@locus.apache.org on 2000/08/10 13:23:04 UTC
cvs commit: jakarta-ant/docs index.html junit.html
bodewig 00/08/10 04:23:03
Modified: docs index.html junit.html
Log:
Added references to fileset where appropriate.
Revision Changes Path
1.75 +109 -37 jakarta-ant/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/index.html,v
retrieving revision 1.74
retrieving revision 1.75
diff -u -r1.74 -r1.75
--- index.html 2000/08/10 10:33:22 1.74
+++ index.html 2000/08/10 11:23:01 1.75
@@ -440,7 +440,23 @@
<pre>
<classpath path="${classpath}" />
</pre>
-
+<p>In addition, <a href="#fileset">FileSet</a>s can be specified via
+nested <code><fileset></code> and
+<code><filesetref></code> elements. The order in which the files
+building up FileSet are added to the PATH like structure is not
+defined.</p>
+<pre>
+ <classpath>
+ <pathelement path="${classpath}" />
+ <fileset dir="lib">
+ <include name="**/*.jar" />
+ </fileset;>
+ <pathelement location="classes" />
+ </classpath>
+</pre>
+<p>Builds a PATH which holds the value of <code>${classpath}</code>
+followed by all JAR files in the <code>lib</code> directory, followed
+by the <code>classes</code> directory.</p>
<h3><a name="arg">Command line arguments</a></h3>
<p>Several tasks take arguments that shall be passed to another
@@ -957,8 +973,13 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>src</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>src</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -1160,8 +1181,12 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>dir</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code> as well as the
+nested <code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -1426,8 +1451,13 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>src</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>srcdir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -1798,8 +1828,13 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>basedir</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>basedir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -1990,8 +2025,7 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>srcdir</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
<p>It is possible to use different compilers. This can be selected with the
"build.compiler" property. There are three choices:</p>
<ul>
@@ -2090,12 +2124,12 @@
</table>
<h3>Parameters specified as nested elements</h3>
-Being a directory based task, Javac supports the <code><include></code> and
-<code><exclude></code> nested elements common to a number of Ant tasks. Javac also supports a
-nested <code><src></code> element. This is used to specify multiple source paths.
-Multiple <code>src</code> elements may be present and each specifies a source path which will be
-searched by Javac for classes to compile.
-
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>srcdir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h4>src, classpath, bootclasspath and extdirs</h4>
<p><code>Javac</code>'s <em>srcdir</em>, <em>classpath</em>,
<em>bootclasspath</em> and <em>extdirs</em> attributes are <a
@@ -2742,15 +2776,13 @@
</tr>
<tr>
<td valign="top">file</td>
- <td valign="top">file for which the token should be replaced. If not present the dir attribute
- must be specified</td>
- <td valign="top" align="center">No</td>
+ <td valign="top">file for which the token should be replaced.</td>
+ <td align="center" rowspan=2">Exactly one of the two.</td>
</tr>
<tr>
<td valign="top">dir</td>
- <td valign="top">The base directory to use when replacing a token in multiple files. If not present the file attribute
- must be specified</td>
- <td valign="top" align="center">No</td>
+ <td valign="top">The base directory to use when replacing a token in
+ multiple files.</td>
</tr>
<tr>
<td valign="top">token</td>
@@ -2800,6 +2832,11 @@
<p>replaces occurrences of the string "@@@" with the string
"wombat", in the file <code>${src}/index.html</code>.</p>
<h3>Parameters specified as nested elements</h3>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code> as well as the
+nested <code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<p>If either the text you want to replace or the replacement text
cross line boundaries, you can use nested elements to specify
them.</p>
@@ -2838,8 +2875,13 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>base</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>base</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -3020,8 +3062,13 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>basedir</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>basedir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<p>Note that this task does not perform compression. You might want to use the <a href="#gzip">GZip</a>
task to come up with a .tar.gz package.</p>
<h3>Parameters</h3>
@@ -3192,8 +3239,13 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>basedir</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>basedir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -3344,8 +3396,13 @@
finally with the <i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The patterns are
-relative to the <i>basedir</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>basedir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -3443,8 +3500,13 @@
your executable path.</p>
<p>See the section on <a href="#directorybasedtasks">directory based
tasks</a>, on how the inclusion/exclusion of files works, and how to
-write patterns. The patterns are relative to the <i>basedir</i>
-directory.</p>
+write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>basedir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -3707,8 +3769,13 @@
<i>defaultexcludes</i> attribute, you can specify whether you
want to use default exclusions or not. See the section on <a
href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The
-patterns are relative to the <i>srcDir</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.</p>
+<p>This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>srcdir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
@@ -3952,8 +4019,13 @@
</p>
<p>See the section on
<a href="#directorybasedtasks">directory based tasks</a>, on how the
-inclusion/exclusion of files works, and how to write patterns. The
-patterns are relative to the <i>srcDir</i> directory.</p>
+inclusion/exclusion of files works, and how to write patterns.
+This task forms an implicit <a href="#fileset">FileSet</a> and
+supports all attributes of <code><fileset></code>
+(<code>dir</code> becomes <code>srcDir</code>) as well as the nested
+<code><include></code>, <code><exclude></code>,
+<code><patternset></code> and <code><patternsetref></code>
+elements.</p>
<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
1.3 +6 -4 jakarta-ant/docs/junit.html
Index: junit.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/junit.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- junit.html 2000/08/09 15:50:21 1.2
+++ junit.html 2000/08/10 11:23:02 1.3
@@ -185,10 +185,12 @@
<p>Define a number of tests based on pattern matching.</p>
<p><code>batchtest</code> collects the included files from any number
-of nested <code><fileset></code> and
-<code><filesetref></code> elements. It then generates a test
-class name for each file that ends in <code>.java</code> or
-<code>.class</code>.</p>
+of nested <a
+href="index.html#fileset"><code><fileset></code></a> and
+<code><filesetref></code> (referring to a
+<code><fileset></code> defined elsewhere via its <code>ID</code>
+attribute) elements. It then generates a test class name for each file
+that ends in <code>.java</code> or <code>.class</code>.</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>