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/09 17:50:25 UTC
cvs commit: jakarta-ant/src/main/org/apache/tools/ant/taskdefs ExecTask.java Java.java
bodewig 00/08/09 08:50:24
Modified: docs index.html junit.html
src/main/org/apache/tools/ant/taskdefs ExecTask.java
Java.java
Log:
Documentation for command line arguments (the nested elements for them).
Revision Changes Path
1.72 +90 -15 jakarta-ant/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/index.html,v
retrieving revision 1.71
retrieving revision 1.72
diff -u -r1.71 -r1.72
--- index.html 2000/08/09 14:59:06 1.71
+++ index.html 2000/08/09 15:50:21 1.72
@@ -441,6 +441,56 @@
<classpath path="${classpath}" />
</pre>
+<h3><a name="arg">Command line arguments</a></h3>
+
+<p>Several tasks take arguments that shall be passed to another
+process on the command line. To make it easier to specify arguments
+that contain space characters, nested elements can be used.</p>
+<table border="1" cellpadding="2" cellspacing="0">
+<tr>
+ <td width="12%" valign="top"><b>Attribute</b></td>
+ <td width="78%" valign="top"><b>Description</b></td>
+ <td width="10%" valign="top"><b>Required</b></td>
+</tr>
+ <tr>
+ <td valign="top">value</td>
+ <td valign="top">a single command line argument, can contain space
+ characters.</td>
+ <td align="center" rowspan="4">Exactly one of these.</td>
+ </tr>
+ <tr>
+ <td valign="top">line</td>
+ <td valign="top">a space delimited list of command line arguments.</td>
+ </tr>
+ <tr>
+ <td valign="top">file</td>
+ <td valign="top">The name of a file as a single command line
+ argument. Will be replaced with the absolute filename of the file
+ by Ant.</td>
+ </tr>
+ <tr>
+ <td valign="top">path</td>
+ <td valign="top">A string that shall be treated as a PATH like
+ string as a single command line argument. You can use ; or : as
+ path separators and Ant will convert it to the platform's local
+ conventions.</td>
+ </tr>
+</table>
+<h4>Examples</h4>
+<blockquote><pre>
+ <arg value="-l -a" />
+</pre></blockquote>
+<p>is a single command line argument containing a space character.</p>
+<blockquote><pre>
+ <arg line="-l -a" />
+</pre></blockquote>
+<p>stands for two separate command line arguments.</p>
+<blockquote><pre>
+ <arg path="/dir;/dir2:\dir3" />
+</pre></blockquote>
+<p>is a single command line argument with value
+<code>\dir;\dir2;\dir3</code> on DOS based systems and
+<code>/dir:/dir2:/dir3</code> on Unix like systems.</p>
<hr>
<h2><a name="directorybasedtasks">Directory based tasks</a></h2>
<p>Some tasks use directory trees for the task they perform. For instance, the <a
@@ -1128,8 +1178,15 @@
</tr>
<tr>
<td valign="top">command</td>
- <td valign="top">the command to execute.</td>
- <td align="center" valign="top">Yes</td>
+ <td valign="top">the command to execute with all command line
+ arguments. <b>deprecated, use executable and nested
+ <code><arg></code> elements instead</b>.</td>
+ <td align="center" rowspan="2">Exactly one of the two.</td>
+ </tr>
+ <tr>
+ <td valign="top">executable</td>
+ <td valign="top">the command to execute without any command line
+ arguments.</b></td>
</tr>
<tr>
<td valign="top">dir</td>
@@ -1149,6 +1206,12 @@
<td align="center" valign="top">No</td>
</tr>
<tr>
+ <td valign="top">timeout</td>
+ <td valign="top">Stop the command if it doesn't finish within the
+ specified time (given in milliseconds).</td>
+ <td align="center" valign="top">No</td>
+ </tr>
+ <tr>
<td valign="top">failonerror</td>
<td valign="top">Stop the buildprocess if the command exits with a
returncode other than 0.</td>
@@ -1157,11 +1220,15 @@
</table>
<h3>Examples</h3>
<blockquote>
- <p><code><exec dir="${src}" command="dir" os="windows"
+ <p><code><exec dir="${src}" executable="dir" os="windows"
output="dir.txt" /></code></p>
</blockquote>
<h3>Parameters specified as nested elements</h3>
+<h4>arg</h4>
+<p>Command line arguments should be specified as nested
+<code><arg></code> elements. See <a
+href="index.html#arg">Command line arguments</a>.</p>
<h4><a name="env">env</a></h4>
<p>It is possible to specify environment variables to pass to the
system command via nested <code><env></code> elements.</p>
@@ -1198,7 +1265,7 @@
</table>
<h5>Examples</h5>
<blockquote><pre>
-<exec command="emacs" >
+<exec executable="emacs" >
<env key="DISPLAY" value=":1.0" />
</exec>
</pre></blockquote>
@@ -1793,7 +1860,9 @@
</tr>
<tr>
<td valign="top">args</td>
- <td valign="top">the arguments for the class that is executed.</td>
+ <td valign="top">the arguments for the class that is
+ executed. <b>deprecated, use nested <code><arg></code>
+ elements instead.</b></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
@@ -1817,15 +1886,15 @@
</tr>
<tr>
<td valign="top">jvmargs</td>
- <td valign="top">the arguments to pass to the forked VM (ignored if fork is
- disabled)</td>
+ <td valign="top">the arguments to pass to the forked VM (ignored
+ if fork is disabled). <b>deprecated, use nested
+ <code><arg></code> elements instead.</b></td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">maxmemory</td>
<td valign="top">Max amount of memory to allocate to the forked VM
(ignored if fork is disabled)</td>
- <td align="center" valign="top">all</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
@@ -1836,12 +1905,18 @@
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
+<h4>arg and jvmarg</h4>
+<p>Use nested <code><arg></code> and <code><jvmarg></code>
+elements to specify arguments for the or the forked VM. See <a
+href="index.html#arg">Command line arguments</a>.</p>
+<h4>classpath</h4>
<p><code>Java</code>'s <em>classpath</em> attribute is a <a
href="#path">PATH like structure</a> and can also be set via a nested
<em>classpath</em> element.</p>
-<h4>Example</h4>
+<h5>Example</h5>
<pre>
- <java classname="test.Main" args="-h" >
+ <java classname="test.Main" >
+ <arg value="-h" />
<classpath>
<pathelement location="\test.jar" />
<pathelement path="${java.class.path}" />
@@ -1850,12 +1925,12 @@
</pre>
<h3>Examples</h3>
<pre> <java classname="test.Main" /></pre>
-<pre> <java classname="test.Main" args="-h" /></pre>
<pre> <java classname="test.Main"
- args="-h"
- fork="yes"
- jvmargs="-Xrunhprof:cpu=samples,file=log.txt,depth=3"
- /></pre>
+ fork="yes" >
+ <arg value="-h" />
+ <jvmarg value="-Xrunhprof:cpu=samples,file=log.txt,depth=3" />
+ </java>
+</pre>
<hr>
<h2><a name="javac">Javac</a></h2>
1.2 +8 -32 jakarta-ant/docs/junit.html
Index: junit.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/junit.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- junit.html 2000/08/09 13:12:12 1.1
+++ junit.html 2000/08/09 15:50:21 1.2
@@ -34,7 +34,7 @@
</tr>
<tr>
<td valign="top">haltonerror</td>
- <td valign="top">Stop the build process if an error occures during the test
+ <td valign="top">Stop the build process if an error occurs during the test
run.</td>
<td align="center" valign="top">No, default is "off"</td>
</tr>
@@ -85,32 +85,8 @@
</blockquote></pre>
would run the test in a VM without JIT.</p>
-<table border="1" cellpadding="2" cellspacing="0">
-<tr>
- <td width="12%" valign="top"><b>Attribute</b></td>
- <td width="78%" valign="top"><b>Description</b></td>
- <td width="10%" valign="top"><b>Required</b></td>
-</tr>
- <tr>
- <td valign="top">value</td>
- <td valign="top">a single command line argument.</td>
- <td align="center" rowspan="4">Exactly one of these.</td>
- </tr>
- <tr>
- <td valign="top">file</td>
- <td valign="top">The name of a file as a single command line argument.</td>
- </tr>
- <tr>
- <td valign="top">path</td>
- <td valign="top">A string that shall be treated as a PATH
- (i.e. the PATH separator will be set according to the plattform's
- convention) as a single command line argument.</td>
- </tr>
- <tr>
- <td valign="top">line</td>
- <td valign="top">a space delimited list of command line arguments.</td>
- </tr>
-</table>
+<p><code><jvmarg></code> allows all attributes described in <a
+href="index.html#arg">Command line arguments</a>.</p>
<h4>formatter</h4>
@@ -138,7 +114,7 @@
</tr>
<tr>
<td valign="top">classname</td>
- <td valign="top">Name of a custo formatter class.</td>
+ <td valign="top">Name of a custom formatter class.</td>
</tr>
<tr>
<td valign="top">extension</td>
@@ -170,7 +146,7 @@
</tr>
<tr>
<td valign="top">haltonerror</td>
- <td valign="top">Stop the build process if an error occures during the test
+ <td valign="top">Stop the build process if an error occurs during the test
run. Overrides value set in <code><junit></code>.</td>
<td align="center" valign="top">No</td>
</tr>
@@ -183,7 +159,7 @@
</tr>
<tr>
<td valign="top">outfile</td>
- <td valign="top">Basename of the test result. The full filename is
+ <td valign="top">Base name of the test result. The full filename is
determined by this attribute and the extension of
<code>formatter</code>.</td>
<td align="center" valign="top">No, default is
@@ -228,7 +204,7 @@
</tr>
<tr>
<td valign="top">haltonerror</td>
- <td valign="top">Stop the build process if an error occures during the test
+ <td valign="top">Stop the build process if an error occurs during the test
run. Overrides value set in <code><junit></code>.</td>
<td align="center" valign="top">No</td>
</tr>
@@ -301,7 +277,7 @@
<p>Runs <code>my.test.TestCase</code> in the same VM (ignoring the
given CLASSPATH), only a warning is printed if this test fails. In
-addition to the plain text testresults, for this test a XML result
+addition to the plain text test results, for this test a XML result
will be output to <code>result.xml</code>.</p>
<p>For each matching file in the directory <code>${src.tests}</code> a
1.6 +3 -0 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ExecTask.java
Index: ExecTask.java
===================================================================
RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/ExecTask.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- ExecTask.java 2000/08/01 09:18:39 1.5
+++ ExecTask.java 2000/08/09 15:50:23 1.6
@@ -111,6 +111,9 @@
* The full commandline to execute, executable + arguments.
*/
public void setCommand(Commandline cmdl) {
+ log("The command attribute is deprecated. " +
+ "Please use the executable attribute and nested arg elements.",
+ Project.MSG_WARN);
this.cmdl = cmdl;
}
1.17 +6 -0 jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Java.java
Index: Java.java
===================================================================
RCS file: /home/cvs/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/Java.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- Java.java 2000/08/07 13:58:34 1.16
+++ Java.java 2000/08/09 15:50:23 1.17
@@ -166,6 +166,9 @@
* Set the command line arguments for the class.
*/
public void setArgs(String s) {
+ log("The args attribute is deprecated. " +
+ "Please use nested arg elements.",
+ Project.MSG_WARN);
cmdl.createArgument().setLine(s);
}
@@ -187,6 +190,9 @@
* Set the command line arguments for the JVM.
*/
public void setJvmargs(String s) {
+ log("The args attribute is deprecated. " +
+ "Please use nested arg elements.",
+ Project.MSG_WARN);
cmdl.createVmArgument().setLine(s);
}