-- excluding api -- git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@1342889 13f79535-47bb-0310-9956-ffa450edef68master
@@ -15,7 +15,7 @@ Fixed bugs: | |||||
Bugzilla Reports 52738, 52740, 52742, 52743. | Bugzilla Reports 52738, 52740, 52742, 52743. | ||||
* Updated documentation to fix spelling errors / broken links. | * Updated documentation to fix spelling errors / broken links. | ||||
Bugzilla Reports 53215, | |||||
Bugzilla Reports 53215, 53291 (excluding api) | |||||
Other changes: | Other changes: | ||||
-------------- | -------------- | ||||
@@ -35,7 +35,7 @@ | |||||
<p>These Apache Ant tasks are wrappers around Continuus Source Manager. They have been tested | <p>These Apache Ant tasks are wrappers around Continuus Source Manager. They have been tested | ||||
against versions 5.1/6.2 on Windows 2000, but should work on other platforms with ccm installed.</p> | against versions 5.1/6.2 on Windows 2000, but should work on other platforms with ccm installed.</p> | ||||
<p>author: <a href="mailto:benoit.moussaud@criltelecom.com">Benoit Mousaud (benoit.moussaud@criltelecom.com) </a></p> | |||||
<p>author: <a href="mailto:benoit.moussaud@criltelecom.com">Benoit Moussaud (benoit.moussaud@criltelecom.com) </a></p> | |||||
<hr> | <hr> | ||||
<h2><a name="ccmcheckin">CCMCheckin</a></h2> | <h2><a name="ccmcheckin">CCMCheckin</a></h2> | ||||
<h3>Description</h3> | <h3>Description</h3> | ||||
@@ -31,7 +31,7 @@ | |||||
<p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get | <p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get | ||||
an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> | an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> | ||||
from the command line in the target directory in which you are working. | from the command line in the target directory in which you are working. | ||||
Also note that this task assumes that the cvs exceutable is compatible | |||||
Also note that this task assumes that the cvs executable is compatible | |||||
with the Unix version from cvshome.org, this is not completely true | with the Unix version from cvshome.org, this is not completely true | ||||
for certain other cvs clients - like CVSNT for example - and some | for certain other cvs clients - like CVSNT for example - and some | ||||
operation may fail when using such an incompatible client. | operation may fail when using such an incompatible client. | ||||
@@ -872,7 +872,7 @@ Since ant 1.6.1 | |||||
<blockquote> | <blockquote> | ||||
<pre> | <pre> | ||||
<ccmkdir viewpath="c:/views/viewdir/adir" | <ccmkdir viewpath="c:/views/viewdir/adir" | ||||
nochcekout="true" | |||||
nocheckout="true" | |||||
comment="Some comment text"/> | comment="Some comment text"/> | ||||
</pre> | </pre> | ||||
</blockquote> | </blockquote> | ||||
@@ -28,7 +28,7 @@ | |||||
<h3>Description</h3> | <h3>Description</h3> | ||||
<p> | <p> | ||||
Adds a component definition to the current project. | Adds a component definition to the current project. | ||||
A compenent definition is the same as a | |||||
A component definition is the same as a | |||||
<a href="typedef.html">typedef</a> except: | <a href="typedef.html">typedef</a> except: | ||||
</p> | </p> | ||||
<ol> | <ol> | ||||
@@ -157,7 +157,7 @@ the tests succeed. | |||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td valign="top">casesensitive</td> | <td valign="top">casesensitive</td> | ||||
<td valign="top">Perform a case sensitive comparision. Default is | |||||
<td valign="top">Perform a case sensitive comparison. Default is | |||||
true.</td> | true.</td> | ||||
<td valign="top" align="center">No</td> | <td valign="top" align="center">No</td> | ||||
</tr> | </tr> | ||||
@@ -335,7 +335,7 @@ the file in the destination directory before you copy it. | |||||
<strong><a name="encoding">Important Encoding Note:</a></strong> | <strong><a name="encoding">Important Encoding Note:</a></strong> | ||||
The reason that binary files when filtered get corrupted is that | The reason that binary files when filtered get corrupted is that | ||||
filtering involves reading in the file using a Reader class. This | filtering involves reading in the file using a Reader class. This | ||||
has an encoding specifing how files are encoded. There are a number | |||||
has an encoding specifying how files are encoded. There are a number | |||||
of different types of encoding - UTF-8, UTF-16, Cp1252, ISO-8859-1, | of different types of encoding - UTF-8, UTF-16, Cp1252, ISO-8859-1, | ||||
US-ASCII and (lots) others. On Windows the default character encoding | US-ASCII and (lots) others. On Windows the default character encoding | ||||
is Cp1252, on Unix it is usually UTF-8. For both of these encoding | is Cp1252, on Unix it is usually UTF-8. For both of these encoding | ||||
@@ -344,9 +344,9 @@ the file in the destination directory before you copy it. | |||||
<p> | <p> | ||||
How the Reader class deals with these illegal sequences is up to the | How the Reader class deals with these illegal sequences is up to the | ||||
implementation | implementation | ||||
of the character decoder. The current Sun Java implemenation is to | |||||
of the character decoder. The current Sun Java implementation is to | |||||
map them to legal characters. Previous Sun Java (1.3 and lower) threw | map them to legal characters. Previous Sun Java (1.3 and lower) threw | ||||
a MalformedInputException. IBM Java 1.4 also thows this exception. | |||||
a MalformedInputException. IBM Java 1.4 also throws this exception. | |||||
It is the mapping of the characters that cause the corruption. | It is the mapping of the characters that cause the corruption. | ||||
</p> | </p> | ||||
<p> | <p> | ||||
@@ -31,7 +31,7 @@ | |||||
<p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get | <p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get | ||||
an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> | an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> | ||||
from the command line in the target directory in which you are working. | from the command line in the target directory in which you are working. | ||||
Also note that this task assumes that the cvs exceutable is compatible | |||||
Also note that this task assumes that the cvs executable is compatible | |||||
with the Unix version from cvshome.org, this is not completely true | with the Unix version from cvshome.org, this is not completely true | ||||
for certain other cvs clients - like CVSNT for example - and some | for certain other cvs clients - like CVSNT for example - and some | ||||
operation may fail when using such an incompatible client. | operation may fail when using such an incompatible client. | ||||
@@ -28,7 +28,7 @@ | |||||
<p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get | <p><b>Important:</b> This task needs "<code>cvs</code>" on the path. If it isn't, you will get | ||||
an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> | an error (such as error <code>2</code> on windows). If <code><cvs></code> doesn't work, try to execute <code>cvs.exe</code> | ||||
from the command line in the target directory in which you are working. | from the command line in the target directory in which you are working. | ||||
Also note that this task assumes that the cvs exceutable is compatible | |||||
Also note that this task assumes that the cvs executable is compatible | |||||
with the Unix version from cvshome.org, this is not completely true | with the Unix version from cvshome.org, this is not completely true | ||||
for certain other cvs clients - like CVSNT for example - and some | for certain other cvs clients - like CVSNT for example - and some | ||||
operation may fail when using such an incompatible client. | operation may fail when using such an incompatible client. | ||||
@@ -36,7 +36,7 @@ respect to their source and then removing the class files of any other | |||||
classes which depend on the out-of-date classes. | classes which depend on the out-of-date classes. | ||||
</p> | </p> | ||||
<p> To determine the class dependencies, the depend task analyses the class | |||||
<p> To determine the class dependencies, the depend task analyzes the class | |||||
files of all class files passed to it. Depend does not parse your source code in | files of all class files passed to it. Depend does not parse your source code in | ||||
any way but relies upon the class references encoded into the class files by the | any way but relies upon the class references encoded into the class files by the | ||||
compiler. This is generally faster than parsing the Java source.</p> | compiler. This is generally faster than parsing the Java source.</p> | ||||
@@ -92,7 +92,7 @@ files.</p> | |||||
href="../Types/propertyset.html">propertyset</a>s. Using | href="../Types/propertyset.html">propertyset</a>s. Using | ||||
<tt>propertyset</tt>s gives more control on which properties will be | <tt>propertyset</tt>s gives more control on which properties will be | ||||
picked up. The attributes <tt>prefix</tt> and <tt>regex</tt> are just | picked up. The attributes <tt>prefix</tt> and <tt>regex</tt> are just | ||||
shorcuts that use <tt>propertyset</tt>s internally. | |||||
shortcuts that use <tt>propertyset</tt>s internally. | |||||
</p> | </p> | ||||
<p><em>since Ant 1.6</em>.</p> | <p><em>since Ant 1.6</em>.</p> | ||||
@@ -69,7 +69,7 @@ In general these tasks are specific to the particular vendor's EJB Server.</p> | |||||
</ul> | </ul> | ||||
Vendors such as BEA and IBM now provide custom Ant tasks to work with their | Vendors such as BEA and IBM now provide custom Ant tasks to work with their | ||||
particular products. More importantly, EJB3.0 renders this whole process obsolete. | particular products. More importantly, EJB3.0 renders this whole process obsolete. | ||||
Accordingly, developement of these tasks is effectively frozen. Bug reports | |||||
Accordingly, development of these tasks is effectively frozen. Bug reports | |||||
and especially patches are welcome, but there is no pressing need to add | and especially patches are welcome, but there is no pressing need to add | ||||
support for new application servers. Nobody should be writing new EJB2.x applications | support for new application servers. Nobody should be writing new EJB2.x applications | ||||
and definitely not new EJB2.x servers. | and definitely not new EJB2.x servers. | ||||
@@ -1386,7 +1386,7 @@ the classpath of the ejbdeploy tool and set the <i>websphere.home</i> property ( | |||||
in the descriptor dir:</p> | in the descriptor dir:</p> | ||||
<pre> | <pre> | ||||
<property name="webpshere.home" value="${was4.home}"/> | |||||
<property name="websphere.home" value="${was4.home}"/> | |||||
<ejbjar srcdir="${build.class}" descriptordir="etc/ejb"> | <ejbjar srcdir="${build.class}" descriptordir="etc/ejb"> | ||||
<include name="*-ejb-jar.xml"/> | <include name="*-ejb-jar.xml"/> | ||||
<websphere dbvendor="DB2UDBOS390_V6" | <websphere dbvendor="DB2UDBOS390_V6" | ||||
@@ -75,7 +75,7 @@ types listed in the environment variable PATHEXT. That is only used by the shell | |||||
<p>A common problem is not having the executable on the PATH. In case you get an error | <p>A common problem is not having the executable on the PATH. In case you get an error | ||||
message <tt>Cannot run program "...":CreateProcess error=2. The system cannot find | message <tt>Cannot run program "...":CreateProcess error=2. The system cannot find | ||||
the path specified.</tt> have a look at your PATH variable. Just type the command directly on | the path specified.</tt> have a look at your PATH variable. Just type the command directly on | ||||
the command line and if Windows finds it, Ant should do it too. (Otherwise ask on the user mailinglist for help.) If Windows can not execute the program add the directory of the programm | |||||
the command line and if Windows finds it, Ant should do it too. (Otherwise ask on the user mailinglist for help.) If Windows can not execute the program add the directory of the program | |||||
to the PATH (<tt>set PATH=%PATH%;dirOfProgram</tt>) or specify the absolute path in the | to the PATH (<tt>set PATH=%PATH%;dirOfProgram</tt>) or specify the absolute path in the | ||||
<tt>executable</tt> attribute in your buildfile. | <tt>executable</tt> attribute in your buildfile. | ||||
</p> | </p> | ||||
@@ -248,7 +248,7 @@ try to set up a new connection.</p> | |||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td valign="top">enableRemoteVerification</td> | <td valign="top">enableRemoteVerification</td> | ||||
<td valign="top">Whether data connection sshould be verified to | |||||
<td valign="top">Whether data connection should be verified to | |||||
connect to the same host as the control connection. This is a | connect to the same host as the control connection. This is a | ||||
security measure that is enabled by default, but it may be useful | security measure that is enabled by default, but it may be useful | ||||
to disable it in certain firewall scenarios. | to disable it in certain firewall scenarios. | ||||
@@ -291,7 +291,7 @@ try to set up a new connection.</p> | |||||
<td valign="top">Specifies the type of system in use on the server. | <td valign="top">Specifies the type of system in use on the server. | ||||
Supported values are <code>"UNIX", "VMS", "WINDOWS", "OS/2", "OS/400", | Supported values are <code>"UNIX", "VMS", "WINDOWS", "OS/2", "OS/400", | ||||
"MVS".</code> If not specified, (or specified as <code>""</code>) and if | "MVS".</code> If not specified, (or specified as <code>""</code>) and if | ||||
no other xxxConfig attributes are specified, the autodectection mechanism | |||||
no other xxxConfig attributes are specified, the autodetection mechanism | |||||
based on the FTP SYST command will be used.<br> | based on the FTP SYST command will be used.<br> | ||||
Since ant 1.7 | Since ant 1.7 | ||||
</td> | </td> | ||||
@@ -79,7 +79,7 @@ This enables the new implementation to call the old target, thus | |||||
<i>enhancing</i> it with tasks called before or after it.</p> | <i>enhancing</i> it with tasks called before or after it.</p> | ||||
<p>If you use the <i>as</i> attribute of the task, its value will be | <p>If you use the <i>as</i> attribute of the task, its value will be | ||||
used to prefix the overriden target's name instead of the name | |||||
used to prefix the overridden target's name instead of the name | |||||
attribute of the project tag.</p> | attribute of the project tag.</p> | ||||
<h4>Special Properties</h4> | <h4>Special Properties</h4> | ||||
@@ -199,7 +199,7 @@ project).</p> | |||||
</td> | </td> | ||||
<td valign="top"> | <td valign="top"> | ||||
Specifies the prefix prepended to the target names. If | Specifies the prefix prepended to the target names. If | ||||
ommitted, the name attribute of the project tag of the | |||||
omitted, the name attribute of the project tag of the | |||||
imported file will be used. | imported file will be used. | ||||
</td> | </td> | ||||
<td valign="top" align="center">No</td> | <td valign="top" align="center">No</td> | ||||
@@ -194,7 +194,7 @@ project).</p> | |||||
</td> | </td> | ||||
<td valign="top"> | <td valign="top"> | ||||
Specifies the prefix prepended to the target names. If | Specifies the prefix prepended to the target names. If | ||||
ommitted, the name attribute of the project tag of the | |||||
omitted, the name attribute of the project tag of the | |||||
included file will be used. | included file will be used. | ||||
</td> | </td> | ||||
<td valign="top" align="center">Yes, if the included file's | <td valign="top" align="center">Yes, if the included file's | ||||
@@ -41,7 +41,7 @@ one of the predefined.</p> | |||||
<p>Optionally a property can be created from the value entered by the | <p>Optionally a property can be created from the value entered by the | ||||
user. This property can then be used during the following build | user. This property can then be used during the following build | ||||
run. Input behaves according to <a href="property.html">property | run. Input behaves according to <a href="property.html">property | ||||
task</a> which means that existing properties cannot be overriden. | |||||
task</a> which means that existing properties cannot be overridden. | |||||
Since Apache Ant 1.6, <code><input></code> will not prompt for input if | Since Apache Ant 1.6, <code><input></code> will not prompt for input if | ||||
a property should be set by the task that has already been set in the | a property should be set by the task that has already been set in the | ||||
project (and the task wouldn't have any effect).</p> | project (and the task wouldn't have any effect).</p> | ||||
@@ -314,7 +314,7 @@ to a value other than its default, <code>"add"</code>.</b></p> | |||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td valign="top">flattenAttributes</td> | <td valign="top">flattenAttributes</td> | ||||
<td valign="top">Whether to merge attributes occuring more than | |||||
<td valign="top">Whether to merge attributes occurring more than | |||||
once in a section (this can only happen for the Class-Path | once in a section (this can only happen for the Class-Path | ||||
attribute) into a single attribute. | attribute) into a single attribute. | ||||
<em>Since Ant 1.8.0</em>.</td> | <em>Since Ant 1.8.0</em>.</td> | ||||
@@ -538,7 +538,7 @@ Sealed: false</code></pre></blockquote> | |||||
<h4>Service Provider</h4> | <h4>Service Provider</h4> | ||||
<p> | <p> | ||||
The following shows how to create a jar file specifing a service | |||||
The following shows how to create a jar file specifying a service | |||||
with an implementation of the JDK6 scripting interface: | with an implementation of the JDK6 scripting interface: | ||||
</p> | </p> | ||||
<blockquote><pre><jar jarfile="pinky.jar"> | <blockquote><pre><jar jarfile="pinky.jar"> | ||||
@@ -182,7 +182,7 @@ invoking the compiler.</p> | |||||
<td valign="top">bootclasspath</td> | <td valign="top">bootclasspath</td> | ||||
<td valign="top"> | <td valign="top"> | ||||
Location of bootstrap class files. (See <a href="#bootstrap">below</a> | Location of bootstrap class files. (See <a href="#bootstrap">below</a> | ||||
for using the -X and -J-X parameters for specifing | |||||
for using the -X and -J-X parameters for specifying | |||||
the bootstrap classpath). | the bootstrap classpath). | ||||
</td> | </td> | ||||
<td align="center" valign="top">No</td> | <td align="center" valign="top">No</td> | ||||
@@ -627,7 +627,7 @@ supported.</p> | |||||
different classloader (and thus may be unable to load the tast | different classloader (and thus may be unable to load the tast | ||||
class).</li> | class).</li> | ||||
<li>It cannot determine which test was run when the timeout/crash | <li>It cannot determine which test was run when the timeout/crash | ||||
occured if the forked VM was running multiple test. I.e. the | |||||
occurred if the forked VM was running multiple test. I.e. the | |||||
formatter cannot work with any <code>forkMode</code> other | formatter cannot work with any <code>forkMode</code> other | ||||
than <code>perTest</code> and it won't do anything if the test | than <code>perTest</code> and it won't do anything if the test | ||||
class contains a <code>suite()</code> method.</li> | class contains a <code>suite()</code> method.</li> | ||||
@@ -95,7 +95,7 @@ line.</p> | |||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td valign="top">flattenAttributes</td> | <td valign="top">flattenAttributes</td> | ||||
<td valign="top">Whether to merge attributes occuring more than | |||||
<td valign="top">Whether to merge attributes occurring more than | |||||
once in a section (this can only happen for the Class-Path | once in a section (this can only happen for the Class-Path | ||||
attribute) into a single attribute. | attribute) into a single attribute. | ||||
<em>Since Ant 1.8.0</em>.</td> | <em>Since Ant 1.8.0</em>.</td> | ||||
@@ -81,7 +81,7 @@ defined property is re-referenced.</p> | |||||
The maximum number of parent directories one is allowed to traverse | The maximum number of parent directories one is allowed to traverse | ||||
to navigate from the jar file to the path entry. Put differently, the | to navigate from the jar file to the path entry. Put differently, the | ||||
maximum number of .. which is allowed in the relative path from the | maximum number of .. which is allowed in the relative path from the | ||||
jar file to a given class path enty. Specify 0 to enforce a path | |||||
jar file to a given class path entry. Specify 0 to enforce a path | |||||
entry to be in the same directory (or one of its sub-directories) | entry to be in the same directory (or one of its sub-directories) | ||||
as the jar file itself. Defaults to 2 levels.</td> | as the jar file itself. Defaults to 2 levels.</td> | ||||
<td valign="top" align="center">No</td> | <td valign="top" align="center">No</td> | ||||
@@ -189,7 +189,7 @@ or from the command line as<br> | |||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td valign="top">removeKeepExtension</td> | <td valign="top">removeKeepExtension</td> | ||||
<td valign="top">Tells wether the trailing .keep in nocompile-mode should | |||||
<td valign="top">Tells whether the trailing .keep in nocompile-mode should | |||||
be removed so that the resulting java source really ends on .java. This | be removed so that the resulting java source really ends on .java. This | ||||
facilitates the use of the javadoc tool lateron.</td> | facilitates the use of the javadoc tool lateron.</td> | ||||
<td valign="top" align="center">No</td> | <td valign="top" align="center">No</td> | ||||
@@ -309,7 +309,7 @@ or from the command line as<br> | |||||
<tr> | <tr> | ||||
<td valign="top">suppressExceptionNotSignalled</td> | <td valign="top">suppressExceptionNotSignalled</td> | ||||
<td valign="top">Tells whether we should filter out the | <td valign="top">Tells whether we should filter out the | ||||
&Exception is declared, but not signaled within the method& | |||||
&Exception is declared, but not signalled within the method& | |||||
messages in strictsignal mode.</td> | messages in strictsignal mode.</td> | ||||
<td valign="top" align="center">No</td> | <td valign="top" align="center">No</td> | ||||
</tr> | </tr> | ||||
@@ -226,7 +226,7 @@ threadsPerProcessor attributes. Spinning up all 40 of those tasks could cripple | |||||
the system for memory and CPU time. By limiting the number of | the system for memory and CPU time. By limiting the number of | ||||
concurrent executions you can reduce contention for CPU, memory and disk IO, | concurrent executions you can reduce contention for CPU, memory and disk IO, | ||||
and so actually finish faster. This is also a good | and so actually finish faster. This is also a good | ||||
candidiate for use of threadCount (and possibly threadsPerProcessor) because | |||||
candidate for use of threadCount (and possibly threadsPerProcessor) because | |||||
each task is independent (every new JVM is forked) and has no dependencies on | each task is independent (every new JVM is forked) and has no dependencies on | ||||
the other tasks.</p> | the other tasks.</p> | ||||
@@ -143,7 +143,7 @@ future. They include things like the following:</p> | |||||
<td valign="top" rowspan=2>A comma-separated list of task to automatically | <td valign="top" rowspan=2>A comma-separated list of task to automatically | ||||
record or not. This could be difficult as it could conflict with the | record or not. This could be difficult as it could conflict with the | ||||
<code>includetarget/excludetarget</code>. (e.g.: | <code>includetarget/excludetarget</code>. (e.g.: | ||||
<code>includetarget="compile" exlcudetask="javac"</code>, what should | |||||
<code>includetarget="compile" excludetask="javac"</code>, what should | |||||
happen?)</td> | happen?)</td> | ||||
<td align="center" valign="middle">no</td> | <td align="center" valign="middle">no</td> | ||||
</tr> | </tr> | ||||
@@ -70,7 +70,7 @@ supports most attributes of <code><fileset></code> | |||||
<td valign="top" align="center">No</td> | <td valign="top" align="center">No</td> | ||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td valign="top">fromExtention</td> | |||||
<td valign="top">fromExtension</td> | |||||
<td valign="top">The string that files must end in to be renamed</td> | <td valign="top">The string that files must end in to be renamed</td> | ||||
<td valign="top" align="center">Yes</td> | <td valign="top" align="center">Yes</td> | ||||
</tr> | </tr> | ||||
@@ -105,7 +105,7 @@ | |||||
<tr> | <tr> | ||||
<td valign="top">failOnError</td> | <td valign="top">failOnError</td> | ||||
<td valign="top">Stop the buildprocess if the RPM build command exits with | <td valign="top">Stop the buildprocess if the RPM build command exits with | ||||
a non-zero retuncode. Defaults to false</td> | |||||
a non-zero returncode. Defaults to false</td> | |||||
<td align="center" valign="top">No</td> | <td align="center" valign="top">No</td> | ||||
</tr> | </tr> | ||||
</table> | </table> | ||||
@@ -139,7 +139,7 @@ more information on writing scripts, please refer to the | |||||
<td valign="top">loaderRef</td> | <td valign="top">loaderRef</td> | ||||
<td valign="top">the name of the loader that is | <td valign="top">the name of the loader that is | ||||
used to load the script, constructed from the specified | used to load the script, constructed from the specified | ||||
classpath. This allows multiple script defintions | |||||
classpath. This allows multiple script definitions | |||||
to reuse the same class loader. | to reuse the same class loader. | ||||
</td> | </td> | ||||
<td align="center" valign="top">No</td> | <td align="center" valign="top">No</td> | ||||
@@ -263,7 +263,7 @@ SHA256withRSA. | |||||
<p> | <p> | ||||
Timestamped JAR files are a new feature in Java1.5; a feature supported in Ant since | Timestamped JAR files are a new feature in Java1.5; a feature supported in Ant since | ||||
Ant 1.7. Ant does not yet support proxy setup for this singing process. | |||||
Ant 1.7. Ant does not yet support proxy setup for this signing process. | |||||
</p> | </p> | ||||
@@ -210,8 +210,8 @@ and <b>abort</b> execution and transaction and fail task.</p> | |||||
<tr> | <tr> | ||||
<td width="12%" valign="top">strictDelimiterMatching</td> | <td width="12%" valign="top">strictDelimiterMatching</td> | ||||
<td width="78%" valign="top">If false, delimiters will be searched | <td width="78%" valign="top">If false, delimiters will be searched | ||||
for in a case-insesitive manner (i.e. delimer="go" matches "GO") | |||||
and surrounding whitespace will be ignored (delimter="go" matches | |||||
for in a case-insensitive manner (i.e. delimiter="go" matches "GO") | |||||
and surrounding whitespace will be ignored (delimiter="go" matches | |||||
"GO "). <em>Since Ant 1.8.0</em>.</td> | "GO "). <em>Since Ant 1.8.0</em>.</td> | ||||
<td width="10%" valign="top">No, default <em>true</em></td> | <td width="10%" valign="top">No, default <em>true</em></td> | ||||
</tr> | </tr> | ||||
@@ -193,7 +193,7 @@ element which is used to perform Entity and URI resolution.</p> | |||||
<tr> | <tr> | ||||
<td valign="top">reloadstylesheet</td> | <td valign="top">reloadstylesheet</td> | ||||
<td valign="top">Control whether the stylesheet transformer is created | <td valign="top">Control whether the stylesheet transformer is created | ||||
anew for every transform opertaion. If you set this to true, performance may | |||||
anew for every transform operation. If you set this to true, performance may | |||||
suffer, but you may work around a bug in certain Xalan-J versions. | suffer, but you may work around a bug in certain Xalan-J versions. | ||||
Default is <code>false</code>. <em>Since Ant 1.5.2</em>.</td> | Default is <code>false</code>. <em>Since Ant 1.5.2</em>.</td> | ||||
<td valign="top" align="center">No</td> | <td valign="top" align="center">No</td> | ||||
@@ -235,7 +235,7 @@ element which is used to perform Entity and URI resolution.</p> | |||||
<tr> | <tr> | ||||
<td valign="top">failOnError</td> | <td valign="top">failOnError</td> | ||||
<td valign="top">Whether the build should fail if any error | <td valign="top">Whether the build should fail if any error | ||||
occurs. Note that transformation errors can still be surpressed by | |||||
occurs. Note that transformation errors can still be suppressed by | |||||
setting failOnTransformationError to false even if this attribute | setting failOnTransformationError to false even if this attribute | ||||
is true. | is true. | ||||
<em>Since Ant 1.8.0</em>.</td> | <em>Since Ant 1.8.0</em>.</td> | ||||
@@ -79,7 +79,7 @@ | |||||
possible, the second best option is to use the loaderref attribute | possible, the second best option is to use the loaderref attribute | ||||
and specify the same name for each and every typedef/taskdef - | and specify the same name for each and every typedef/taskdef - | ||||
this way the classes will share the same ClassLoader. Note that | this way the classes will share the same ClassLoader. Note that | ||||
the typedef/taskdef tasks must use identical classpath defintions | |||||
the typedef/taskdef tasks must use identical classpath definitions | |||||
(this includes the order of path components) for the loaderref | (this includes the order of path components) for the loaderref | ||||
attribute to work.</p> | attribute to work.</p> | ||||
@@ -121,7 +121,7 @@ archive.</p> | |||||
<tr> | <tr> | ||||
<td valign="top">stripAbsolutePathSpec</td> | <td valign="top">stripAbsolutePathSpec</td> | ||||
<td valign="top">whether Ant should remove leading '/' or '\' | <td valign="top">whether Ant should remove leading '/' or '\' | ||||
characters from the extracted file name before extracing it. | |||||
characters from the extracted file name before extracting it. | |||||
Note that this changes the entry's name before applying | Note that this changes the entry's name before applying | ||||
include/exclude patterns and before using the nested mappers (if | include/exclude patterns and before using the nested mappers (if | ||||
any). <em>since Ant 1.8.0</em></td> | any). <em>since Ant 1.8.0</em></td> | ||||
@@ -49,7 +49,7 @@ vss functionality as well as some Apache Ant tasks encapsulating frequently used | |||||
Although it is possible to use these commands on the desktop, | Although it is possible to use these commands on the desktop, | ||||
they were primarily intended to be used by automated build systems.</p> | they were primarily intended to be used by automated build systems.</p> | ||||
<p> | <p> | ||||
If you get a CreateProcesss IOError=2 when running these, it means | |||||
If you get a CreateProcess IOError=2 when running these, it means | |||||
that ss.exe was not found. Check to see if you can run it from the | that ss.exe was not found. Check to see if you can run it from the | ||||
command line -you may need to alter your path, or set the <tt>ssdir</tt> | command line -you may need to alter your path, or set the <tt>ssdir</tt> | ||||
property. | property. | ||||
@@ -261,7 +261,7 @@ to a value other than its default, <code>"add"</code>.</b></p> | |||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td valign="top">flattenAttributes</td> | <td valign="top">flattenAttributes</td> | ||||
<td valign="top">Whether to merge attributes occuring more than | |||||
<td valign="top">Whether to merge attributes occurring more than | |||||
once in a section (this can only happen for the Class-Path | once in a section (this can only happen for the Class-Path | ||||
attribute) into a single attribute. | attribute) into a single attribute. | ||||
<em>Since Ant 1.8.0</em>.</td> | <em>Since Ant 1.8.0</em>.</td> | ||||
@@ -339,7 +339,7 @@ using Ant's default manifest file. The content of | |||||
<code>WEB-INF/web.xml</code> is identical to | <code>WEB-INF/web.xml</code> is identical to | ||||
<code>src/metadata/myapp.xml</code>. | <code>src/metadata/myapp.xml</code>. | ||||
<p>We regulary receive bug reports that this task is creating the WEB-INF | |||||
<p>We regularly receive bug reports that this task is creating the WEB-INF | |||||
directory as web-inf (all lower case), and thus it is our fault your webapp doesn't work. The cause | directory as web-inf (all lower case), and thus it is our fault your webapp doesn't work. The cause | ||||
of these complaints lies in WinZip, which turns an all upper-case | of these complaints lies in WinZip, which turns an all upper-case | ||||
directory into an all lower case one in a fit of helpfulness. Please check that | directory into an all lower case one in a fit of helpfulness. Please check that | ||||
@@ -311,7 +311,7 @@ archive.</p> | |||||
zip family of tasks support an | zip family of tasks support an | ||||
option <code>createUnicodeExtraFields</code> since Ant 1.8.0 which | option <code>createUnicodeExtraFields</code> since Ant 1.8.0 which | ||||
makes Ant write these extra fields either for all entries ("always") | makes Ant write these extra fields either for all entries ("always") | ||||
or only those whose name cannot be encoded using the spcified | |||||
or only those whose name cannot be encoded using the specified | |||||
encoding (not-encodeable), it defaults to "never" since the extra | encoding (not-encodeable), it defaults to "never" since the extra | ||||
fields create bigger archives.</p> | fields create bigger archives.</p> | ||||
@@ -464,7 +464,7 @@ The code | |||||
</zip> | </zip> | ||||
</pre> | </pre> | ||||
<p> | <p> | ||||
<p>zips all files in the <code>htdocs/manual</code> directory into the <code>docs/user-guide</code> directory in the archive and includes all the files in any file that maches <code>examples*.zip</code>, such as all files within <code>examples1.zip</code> or <code>examples_for_brian.zip</code>. | |||||
<p>zips all files in the <code>htdocs/manual</code> directory into the <code>docs/user-guide</code> directory in the archive and includes all the files in any file that matches <code>examples*.zip</code>, such as all files within <code>examples1.zip</code> or <code>examples_for_brian.zip</code>. | |||||
The same can be achieved with | The same can be achieved with | ||||
<pre> | <pre> | ||||
<zip destfile="${dist}/manual.zip"> | <zip destfile="${dist}/manual.zip"> | ||||
@@ -159,7 +159,7 @@ | |||||
<h3><a name="loadFromInside">Load antlib from inside of the buildfile</a></h3> | <h3><a name="loadFromInside">Load antlib from inside of the buildfile</a></h3> | ||||
<p> | <p> | ||||
If you want to seperate the antlib from your local Ant installation, e.g. because you | |||||
If you want to separate the antlib from your local Ant installation, e.g. because you | |||||
want to hold that jar in your projects SCM system, you have to specify a classpath, so | want to hold that jar in your projects SCM system, you have to specify a classpath, so | ||||
that Ant could find that jar. The best solution is loading the antlib with <tt><taskdef></tt>. | that Ant could find that jar. The best solution is loading the antlib with <tt><taskdef></tt>. | ||||
</p> | </p> | ||||
@@ -190,7 +190,7 @@ | |||||
Definitions defined in antlibs may be used in antlibs. However | Definitions defined in antlibs may be used in antlibs. However | ||||
the namespace that definitions are placed in are dependent on | the namespace that definitions are placed in are dependent on | ||||
the <code><typedef></code> that uses the antlib. To deal with this | the <code><typedef></code> that uses the antlib. To deal with this | ||||
problem, the definitions are placed in the namepace URI <i>ant:current</i> | |||||
problem, the definitions are placed in the namespace URI <i>ant:current</i> | |||||
for the duration of the antlib execution. | for the duration of the antlib execution. | ||||
For example the following antlib defines the task <code><if></code>, the | For example the following antlib defines the task <code><if></code>, the | ||||
type <code><isallowed></code> and a macro | type <code><isallowed></code> and a macro | ||||
@@ -23,7 +23,7 @@ | |||||
<body> | <body> | ||||
<h2><a name="fileset">ClassFileSet</a></h2> | <h2><a name="fileset">ClassFileSet</a></h2> | ||||
<p>A classfileset is a specialised type of fileset which, given a set of | |||||
<p>A classfileset is a specialized type of fileset which, given a set of | |||||
"root" classes, will include all of the class files upon which the | "root" classes, will include all of the class files upon which the | ||||
root classes depend. This is typically used to create a jar with all of the | root classes depend. This is typically used to create a jar with all of the | ||||
required classes for a particular application. | required classes for a particular application. | ||||
@@ -178,7 +178,7 @@ distribution. | |||||
a class. However the bytes arrive to the filter as a sequence | a class. However the bytes arrive to the filter as a sequence | ||||
of characters. This means that one must be careful on the | of characters. This means that one must be careful on the | ||||
choice of character encoding to use. Most encoding lose information | choice of character encoding to use. Most encoding lose information | ||||
on conversion from an arbitary sequence of bytes to characters | |||||
on conversion from an arbitrary sequence of bytes to characters | |||||
and back again to bytes. In particular the usual default | and back again to bytes. In particular the usual default | ||||
character encodings (CP152 and UTF-8) do. | character encodings (CP152 and UTF-8) do. | ||||
For this reason, <em>since Ant 1.7</em>, the character | For this reason, <em>since Ant 1.7</em>, the character | ||||
@@ -1042,12 +1042,12 @@ a token and either returns a string or a null. | |||||
It the string is not null it is passed to the next filter. This | It the string is not null it is passed to the next filter. This | ||||
proceeds until all the filters are called. | proceeds until all the filters are called. | ||||
If a string is returned after all the filters, the string is | If a string is returned after all the filters, the string is | ||||
outputs with its associated token delimitier | |||||
outputs with its associated token delimiter | |||||
(if one is present). | (if one is present). | ||||
The trailing delimiter may be overridden by the <i>delimOutput</i> | The trailing delimiter may be overridden by the <i>delimOutput</i> | ||||
attribute. | attribute. | ||||
<p> | <p> | ||||
<a name="backslash"><em>blackslash interpretation</em></a> | |||||
<a name="backslash"><em>backslash interpretation</em></a> | |||||
A number of attributes (including <i>delimOutput</i>) interpret | A number of attributes (including <i>delimOutput</i>) interpret | ||||
backslash escapes. The following are understood: \n, \r, \f, \t | backslash escapes. The following are understood: \n, \r, \f, \t | ||||
and \\. | and \\. | ||||
@@ -1344,7 +1344,7 @@ concerning the choice of regular expression implementation. | |||||
<tr> | <tr> | ||||
<td vAlign=top>replace</td> | <td vAlign=top>replace</td> | ||||
<td vAlign=top>The substitution pattern to replace the matched | <td vAlign=top>The substitution pattern to replace the matched | ||||
regular expression. When omitted the orignal token is returned. | |||||
regular expression. When omitted the original token is returned. | |||||
</td> | </td> | ||||
<td vAlign=top align="center">No</td> | <td vAlign=top align="center">No</td> | ||||
</tr> | </tr> | ||||
@@ -1650,7 +1650,7 @@ order and copy them into <i>build</i> location. | |||||
Sort all files <code>*.txt</code> from <i>src</i> location using as | Sort all files <code>*.txt</code> from <i>src</i> location using as | ||||
sorting criterium <code>EvenFirstCmp</code> class, that sorts the file | sorting criterium <code>EvenFirstCmp</code> class, that sorts the file | ||||
lines putting even lines first then odd lines for example. The modified files | lines putting even lines first then odd lines for example. The modified files | ||||
are copied into <i>build</i> location. The <code>EventFirstCmp</code>, | |||||
are copied into <i>build</i> location. The <code>EvenFirstCmp</code>, | |||||
has to an instanciable class via <code>Class.newInstance()</code>, | has to an instanciable class via <code>Class.newInstance()</code>, | ||||
therefore in case of inner class has to be <em>static</em>. It also has to | therefore in case of inner class has to be <em>static</em>. It also has to | ||||
implement <code>java.util.Comparator</code> interface, for example: | implement <code>java.util.Comparator</code> interface, for example: | ||||
@@ -185,7 +185,7 @@ | |||||
be woven together under certain circumstances. This has a lot to do | be woven together under certain circumstances. This has a lot to do | ||||
with the Ant 1.6 | with the Ant 1.6 | ||||
<a href="../develop.html#nestedtype">add type introspection rules</a>: | <a href="../develop.html#nestedtype">add type introspection rules</a>: | ||||
Ant types and tasks are now free to accept arbritrary named types as | |||||
Ant types and tasks are now free to accept arbitrary named types as | |||||
nested elements, as long as the concrete type implements the interface | nested elements, as long as the concrete type implements the interface | ||||
expected by the task/type. The most obvious example for this is the | expected by the task/type. The most obvious example for this is the | ||||
<code><condition></code> task, which supports various nested conditions, all | <code><condition></code> task, which supports various nested conditions, all | ||||
@@ -113,7 +113,7 @@ If the name is left empty all names match, and are revoked. | |||||
If the actions are left empty all actions match, and are revoked. | If the actions are left empty all actions match, and are revoked. | ||||
</p> | </p> | ||||
<h3><a name="baseset">Base set</a></h3> | <h3><a name="baseset">Base set</a></h3> | ||||
A permissions set implictly contains the following permissions: | |||||
A permissions set implicitly contains the following permissions: | |||||
<blockquote><pre> | <blockquote><pre> | ||||
<grant class="java.net.SocketPermission" name="localhost:1024-" actions="listen"> | <grant class="java.net.SocketPermission" name="localhost:1024-" actions="listen"> | ||||
<grant class="java.util.PropertyPermission" name="java.version" actions="read"> | <grant class="java.util.PropertyPermission" name="java.version" actions="read"> | ||||
@@ -160,7 +160,7 @@ | |||||
special testenvironment got a new name: <i>bed</i>. Like you initialize the | special testenvironment got a new name: <i>bed</i>. Like you initialize the | ||||
test environment by calling setUp() and cleaning by calling tearDown() (<i>or like | test environment by calling setUp() and cleaning by calling tearDown() (<i>or like | ||||
to make your bed before go sleeping</i>) you have to do that work with your | to make your bed before go sleeping</i>) you have to do that work with your | ||||
<i>bed</i> by calling <tt>makeBed()</tt> respecitive <tt>cleanupBed()</tt>.</p> | |||||
<i>bed</i> by calling <tt>makeBed()</tt> respective <tt>cleanupBed()</tt>.</p> | |||||
<p>A usual test scenario is<ol> | <p>A usual test scenario is<ol> | ||||
<li>make the bed</li> | <li>make the bed</li> | ||||
@@ -789,7 +789,7 @@ | |||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td valign="top"> selres </td> | <td valign="top"> selres </td> | ||||
<td valign="top"> Should Resources whithout an InputStream, and | |||||
<td valign="top"> Should Resources without an InputStream, and | |||||
therefore without checking, be selected? (boolean) </td> | therefore without checking, be selected? (boolean) </td> | ||||
<td valign="top" align="center"> No, defaults to <i>true</i>. Only relevant | <td valign="top" align="center"> No, defaults to <i>true</i>. Only relevant | ||||
when used as ResourceSelector. </td> | when used as ResourceSelector. </td> | ||||
@@ -816,7 +816,7 @@ | |||||
<li> <b> comparatorclass </b>: same as attribute comparatorclass </li> | <li> <b> comparatorclass </b>: same as attribute comparatorclass </li> | ||||
<li> <b> update </b>: same as attribute update </li> | <li> <b> update </b>: same as attribute update </li> | ||||
<li> <b> seldirs </b>: same as attribute seldirs </li> | <li> <b> seldirs </b>: same as attribute seldirs </li> | ||||
<li> <b> algorithm.* </b>: Value is transfered to the algorithm via its | |||||
<li> <b> algorithm.* </b>: Value is transferred to the algorithm via its | |||||
<i>set</i>XX-methods </li> | <i>set</i>XX-methods </li> | ||||
<li> <b> cache.* </b>: Value is transfered to the cache via its | <li> <b> cache.* </b>: Value is transfered to the cache via its | ||||
<i>set</i>XX-methods </li> | <i>set</i>XX-methods </li> | ||||
@@ -957,7 +957,7 @@ | |||||
<blockquote><pre> | <blockquote><pre> | ||||
<modified cacheclassname="com.mycompany.MyCache"> | <modified cacheclassname="com.mycompany.MyCache"> | ||||
<classpath> | <classpath> | ||||
<pathelement location="lib/mycompony-antutil.jar"/> | |||||
<pathelement location="lib/mycompany-antutil.jar"/> | |||||
</classpath> | </classpath> | ||||
</modified> | </modified> | ||||
</pre></blockquote> | </pre></blockquote> | ||||
@@ -972,7 +972,7 @@ | |||||
<h4><a name="signedselector">Signed Selector</a></h4> | <h4><a name="signedselector">Signed Selector</a></h4> | ||||
<p> | <p> | ||||
The <code><signedselector></code> tag selects signed files and optionaly | |||||
The <code><signedselector></code> tag selects signed files and optionally | |||||
signed with a certain name. | signed with a certain name. | ||||
</p> | </p> | ||||
<p> | <p> | ||||
@@ -1117,7 +1117,7 @@ | |||||
</table> | </table> | ||||
<p> | <p> | ||||
The <code>self</code> bean maps to the selector, which has the following | The <code>self</code> bean maps to the selector, which has the following | ||||
attributes. Only the <code>selected</code> flag is writeable, the rest | |||||
attributes. Only the <code>selected</code> flag is writable, the rest | |||||
are read only via their getter methods. | are read only via their getter methods. | ||||
<table border="1" cellpadding="2" cellspacing="0"> | <table border="1" cellpadding="2" cellspacing="0"> | ||||
@@ -80,7 +80,7 @@ good convention, though.</p> | |||||
The xml element that contains the tag corresponding to the | The xml element that contains the tag corresponding to the | ||||
task gets converted to an UnknownElement at parser time. | task gets converted to an UnknownElement at parser time. | ||||
This UnknownElement gets placed in a list within a target | This UnknownElement gets placed in a list within a target | ||||
object, or recursivly within another UnknownElement. | |||||
object, or recursively within another UnknownElement. | |||||
</li> | </li> | ||||
<li> | <li> | ||||
When the target is executed, each UnknownElement is invoked | When the target is executed, each UnknownElement is invoked | ||||
@@ -262,7 +262,7 @@ the methods will be called, but we don't know which, this depends on | |||||
the implementation of your Java virtual machine.</p> | the implementation of your Java virtual machine.</p> | ||||
<h3><a name="nestedtype">Nested Types</a></h3> | <h3><a name="nestedtype">Nested Types</a></h3> | ||||
If your task needs to nest an arbitary type that has been defined | |||||
If your task needs to nest an arbitrary type that has been defined | |||||
using <code><typedef></code> you have two options. | using <code><typedef></code> you have two options. | ||||
<ol> | <ol> | ||||
<li><code>public void add(Type type)</code></li> | <li><code>public void add(Type type)</code></li> | ||||
@@ -510,7 +510,7 @@ If you wish to attach a listener from the command line you may use the | |||||
<p>will run Ant with a listener that generates an XML representation of the build progress. This | <p>will run Ant with a listener that generates an XML representation of the build progress. This | ||||
listener is included with Ant, as is the default listener, which generates the logging to standard output.</p> | listener is included with Ant, as is the default listener, which generates the logging to standard output.</p> | ||||
<p><b>Note: </b>A listener must not access System.out and System.err directly since ouput on | |||||
<p><b>Note: </b>A listener must not access System.out and System.err directly since output on | |||||
these streams is redirected by Ant's core to the build event system. Accessing these | these streams is redirected by Ant's core to the build event system. Accessing these | ||||
streams can cause an infinite loop in Ant. Depending on the version of Ant, this will | streams can cause an infinite loop in Ant. Depending on the version of Ant, this will | ||||
either cause the build to terminate or the Java VM to run out of Stack space. A logger, also, may | either cause the build to terminate or the Java VM to run out of Stack space. A logger, also, may | ||||
@@ -282,7 +282,7 @@ directory-based tasks. As of Ant 1.8.1 they are:</p> | |||||
**/.svn/** | **/.svn/** | ||||
**/.DS_Store | **/.DS_Store | ||||
</pre> | </pre> | ||||
<p>Ant 1.8.2 adds the folllowing default excludes:</p> | |||||
<p>Ant 1.8.2 adds the following default excludes:</p> | |||||
<pre> | <pre> | ||||
**/.git | **/.git | ||||
**/.git/** | **/.git/** | ||||
@@ -167,7 +167,7 @@ files are organized as follows. | |||||
<td>ant-current-src.zip</td> | <td>ant-current-src.zip</td> | ||||
<td> | <td> | ||||
ZIP-Archive containing the sources of Ant. If you have this you could compile Ant itself. | ZIP-Archive containing the sources of Ant. If you have this you could compile Ant itself. | ||||
If you do not have the <i>required</i> dependencies, the classes depeding on them are just not | |||||
If you do not have the <i>required</i> dependencies, the classes depending on them are just not | |||||
built. Again, it is preferred to use the standard way of getting the source package described above | built. Again, it is preferred to use the standard way of getting the source package described above | ||||
to make your download quicker and to reduce the load on Apache servers. | to make your download quicker and to reduce the load on Apache servers. | ||||
</td> | </td> | ||||
@@ -308,7 +308,7 @@ installed in a <b>short</b>, 8.3 path, such as C:\Ant. </i> | |||||
<td width="5%"> </td> | <td width="5%"> </td> | ||||
<td> | <td> | ||||
<p>On these systems you will also need to configure more environment | <p>On these systems you will also need to configure more environment | ||||
space to cater for the environment variables used in the Ant lauch script. | |||||
space to cater for the environment variables used in the Ant launch script. | |||||
To do this, you will need to add or update the following line in | To do this, you will need to add or update the following line in | ||||
the <code>config.sys</code> file | the <code>config.sys</code> file | ||||
</p> | </p> | ||||
@@ -381,7 +381,7 @@ Apache Ant version 1.7.1 compiled on June 27 2008 | |||||
<b>ANT_HOME</b> is used by the launcher script for finding the libraries. | <b>ANT_HOME</b> is used by the launcher script for finding the libraries. | ||||
<b>JAVA_HOME</b> is used by the launcher for finding the JDK/JRE to use. (JDK is recommended as some tasks | <b>JAVA_HOME</b> is used by the launcher for finding the JDK/JRE to use. (JDK is recommended as some tasks | ||||
require the java tools.) If not set, the launcher tries to find one via the %PATH% environment variable. | require the java tools.) If not set, the launcher tries to find one via the %PATH% environment variable. | ||||
<b>PATH</b> is set for user convinience. With that set you can just start <i>ant</i> instead of always typing | |||||
<b>PATH</b> is set for user convenience. With that set you can just start <i>ant</i> instead of always typing | |||||
<i>the/complete/path/to/your/ant/installation/bin/ant</i>. | <i>the/complete/path/to/your/ant/installation/bin/ant</i>. | ||||
</p> | </p> | ||||
@@ -878,7 +878,7 @@ you need jakarta-oro 2.0.8 or later, and <a href="#commons-net">commons-net</a>< | |||||
of rhino's javascript. | of rhino's javascript. | ||||
</p> | </p> | ||||
<p> | <p> | ||||
<strong>Note</strong>: BSF 2.4.0 uses jakarata-commons-logging | |||||
<strong>Note</strong>: BSF 2.4.0 uses jakarta-commons-logging | |||||
so it needs the commons-logging.jar. | so it needs the commons-logging.jar. | ||||
</p> | </p> | ||||
</td> | </td> | ||||
@@ -888,7 +888,7 @@ you need jakarta-oro 2.0.8 or later, and <a href="#commons-net">commons-net</a>< | |||||
<td>Groovy jars</td> | <td>Groovy jars</td> | ||||
<td>Groovy with script and scriptdef tasks<br> | <td>Groovy with script and scriptdef tasks<br> | ||||
You need to get the groovy jar and two asm jars from a groovy | You need to get the groovy jar and two asm jars from a groovy | ||||
installation. The jars are groovy-[version].jar, asm-[vesion].jar and | |||||
installation. The jars are groovy-[version].jar, asm-[version].jar and | |||||
asm-util-[version].jar and antlr-[version].jar. | asm-util-[version].jar and antlr-[version].jar. | ||||
As of groovy version 1.0-JSR-06, the jars are | As of groovy version 1.0-JSR-06, the jars are | ||||
groovy-1.0-JSR-06.jar, antlr-2.7.5.jar, asm-2.2.jar and asm-util-2.2.jar. | groovy-1.0-JSR-06.jar, antlr-2.7.5.jar, asm-2.2.jar and asm-util-2.2.jar. | ||||
@@ -926,7 +926,7 @@ you need jakarta-oro 2.0.8 or later, and <a href="#commons-net">commons-net</a>< | |||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<td>jpython.jar</td> | <td>jpython.jar</td> | ||||
<td>Python with script task <b>deprecated, jython is the prefered engine</b></td> | |||||
<td>Python with script task <b>deprecated, jython is the preferred engine</b></td> | |||||
<td><a href="http://www.jpython.org/" target="_top">http://www.jpython.org/</a></td> | <td><a href="http://www.jpython.org/" target="_top">http://www.jpython.org/</a></td> | ||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
@@ -1049,7 +1049,7 @@ absent.</li> | |||||
<li>JVM system properties | <li>JVM system properties | ||||
</li> | </li> | ||||
<li>The status of the temp directory. If this is not writeable, or its clock is | |||||
<li>The status of the temp directory. If this is not writable, or its clock is | |||||
horribly wrong (possible if it is on a network drive), a lot of tasks will fail | horribly wrong (possible if it is on a network drive), a lot of tasks will fail | ||||
with obscure error messages.</li> | with obscure error messages.</li> | ||||
@@ -1067,7 +1067,7 @@ your location, then dependency logic may get confused. | |||||
</p> | </p> | ||||
<p> | <p> | ||||
For under-IDE diagostics, use the <diagnostics> task to run the same | |||||
For under-IDE diagnostics, use the <diagnostics> task to run the same | |||||
tests as an ant task. This can be added to a diagnostics target in a build | tests as an ant task. This can be added to a diagnostics target in a build | ||||
file to see what tasks are available under the IDE, what the XML parser and | file to see what tasks are available under the IDE, what the XML parser and | ||||
classpath is, etc. | classpath is, etc. | ||||
@@ -298,7 +298,7 @@ AnsiColorLogger.DEBUG_COLOR=2;34</pre></code> | |||||
<p>Each key takes as value a color combination defined as | <p>Each key takes as value a color combination defined as | ||||
<b>Attribute;Foreground;Background</b>. In the above example, background | <b>Attribute;Foreground;Background</b>. In the above example, background | ||||
value has not been used.</p> | value has not been used.</p> | ||||
<p>This file must be specfied as the value of a system variable | |||||
<p>This file must be specified as the value of a system variable | |||||
named ant.logger.defaults and passed as an argument using the -D | named ant.logger.defaults and passed as an argument using the -D | ||||
option to the <b>java</b> command that invokes the Ant application. | option to the <b>java</b> command that invokes the Ant application. | ||||
An easy way to achieve this is to add -Dant.logger.defaults= | An easy way to achieve this is to add -Dant.logger.defaults= | ||||
@@ -36,7 +36,7 @@ for example) may not work against the shipping XSL engine. | |||||
<ul> | <ul> | ||||
<li> You should use a GNU version of <tt>tar</tt> to untar the Apache | <li> You should use a GNU version of <tt>tar</tt> to untar the Apache | ||||
Ant source tree, if you have downloaded this as a tar file. If you get | Ant source tree, if you have downloaded this as a tar file. If you get | ||||
wierd errors about missing files, this is the problem. | |||||
weird errors about missing files, this is the problem. | |||||
</li> | </li> | ||||
<li> Ant does not preserve file permissions when a file is copied, moved or | <li> Ant does not preserve file permissions when a file is copied, moved or | ||||
archived, because Java does not let it read or write the permissions. | archived, because Java does not let it read or write the permissions. | ||||
@@ -50,7 +50,7 @@ proxy configuration. | |||||
</p> | </p> | ||||
<p> | <p> | ||||
This is a long standing problem with Java and Ant. The only way to fix | This is a long standing problem with Java and Ant. The only way to fix | ||||
it is to explictly configure Ant with the proxy settings, either | |||||
it is to explicitly configure Ant with the proxy settings, either | |||||
by passing down the proxy details as JVM properties, or to | by passing down the proxy details as JVM properties, or to | ||||
tell Ant on a Java1.5+ system to have the JVM work it out for itself. | tell Ant on a Java1.5+ system to have the JVM work it out for itself. | ||||
@@ -155,7 +155,7 @@ default directories scanned are ANT_HOME/lib and a user specific directory, | |||||
${user.home}/.ant/lib. This arrangement allows the Ant installation to be | ${user.home}/.ant/lib. This arrangement allows the Ant installation to be | ||||
shared by many users while still allowing each user to deploy additional jars. | shared by many users while still allowing each user to deploy additional jars. | ||||
Such additional jars could be support jars for Ant's optional tasks or jars | Such additional jars could be support jars for Ant's optional tasks or jars | ||||
containing third-party tasks to be used in the build. It also allows the main Ant installation to be locked down which will please system adminstrators. | |||||
containing third-party tasks to be used in the build. It also allows the main Ant installation to be locked down which will please system administrators. | |||||
</p> | </p> | ||||
<p> | <p> | ||||
@@ -470,7 +470,7 @@ org.apache.tools.ant.Executor implementation specified here. | |||||
<tr> | <tr> | ||||
<td><code>ant.project-helper-repo.debug</code></td> | <td><code>ant.project-helper-repo.debug</code></td> | ||||
<td>boolean (default 'false')</td> | <td>boolean (default 'false')</td> | ||||
<td>Set it to true to enable debuging with Ant's | |||||
<td>Set it to true to enable debugging with Ant's | |||||
<a href="projecthelper.html#repository">ProjectHelper internal repository</a>. | <a href="projecthelper.html#repository">ProjectHelper internal repository</a>. | ||||
</td> | </td> | ||||
</tr> | </tr> | ||||
@@ -356,7 +356,7 @@ For another layout ... have a look inside Log4J's documentation about using othe | |||||
<h2>Configuration files</h2> | <h2>Configuration files</h2> | ||||
<p>Why we have used Log4J? "It's highly configurable"? No - all is hard coded! But that is not the debt of Log4J - it's | <p>Why we have used Log4J? "It's highly configurable"? No - all is hard coded! But that is not the debt of Log4J - it's | ||||
ours. We had coded <tt>BasicConfigurator.configure();</tt> which implies a simple, but hard coded configuration. More | ours. We had coded <tt>BasicConfigurator.configure();</tt> which implies a simple, but hard coded configuration. More | ||||
confortable would be using a property file. In the java source delete the BasicConfiguration-line from the main() method | |||||
comfortable would be using a property file. In the java source delete the BasicConfiguration-line from the main() method | |||||
(and the related import-statement). Log4J will search then for a configuration as described in it's manual. Then create | (and the related import-statement). Log4J will search then for a configuration as described in it's manual. Then create | ||||
a new file <tt>src/log4j.properties</tt>. That's the default name for Log4J's configuration and using that name would make | a new file <tt>src/log4j.properties</tt>. That's the default name for Log4J's configuration and using that name would make | ||||
life easier - not only the framework knows what is inside, you too!</p> | life easier - not only the framework knows what is inside, you too!</p> | ||||
@@ -301,7 +301,7 @@ can implement our task, so that these test cases will pass.</p> | |||||
is a common way, because we separate the prerequisites from the real work. On <b>//2</b> we iterate | is a common way, because we separate the prerequisites from the real work. On <b>//2</b> we iterate | ||||
over all nested filesets. If we don't want to handle multiple filesets, the <tt>addFileset()</tt> | over all nested filesets. If we don't want to handle multiple filesets, the <tt>addFileset()</tt> | ||||
method has to reject the further calls. We can get the result of a fileset via its DirectoryScanner | method has to reject the further calls. We can get the result of a fileset via its DirectoryScanner | ||||
like done in <b>//3</b>. After that we create a plattform independend String representation of | |||||
like done in <b>//3</b>. After that we create a platform independend String representation of | |||||
the file path (<b>//4</b>, can be done in other ways of course). We have to do the <tt>replace()</tt>, | the file path (<b>//4</b>, can be done in other ways of course). We have to do the <tt>replace()</tt>, | ||||
because we work with a simple string comparison. Ant itself is platform independant and can | because we work with a simple string comparison. Ant itself is platform independant and can | ||||
therefore run on filesystems with slash (/, e.g. Linux) or backslash (\, e.g. Windows) as | therefore run on filesystems with slash (/, e.g. Linux) or backslash (\, e.g. Windows) as | ||||
@@ -313,7 +313,7 @@ location of the file as property, if we had found one (<b>//6</b>).</p> | |||||
<p>Ok, much more easier in this simple case would be to add the <i>file</i> as additional | <p>Ok, much more easier in this simple case would be to add the <i>file</i> as additional | ||||
<i>include</i> element to all filesets. But I wanted to show how to handle complex situations | <i>include</i> element to all filesets. But I wanted to show how to handle complex situations | ||||
whithout being complex :-)</p> | |||||
without being complex :-)</p> | |||||
<p>The test case uses the ant property <i>ant.home</i> as reference. This property is set by the | <p>The test case uses the ant property <i>ant.home</i> as reference. This property is set by the | ||||
<tt>Launcher</tt> class which starts ant. We can use that property in our buildfiles as a | <tt>Launcher</tt> class which starts ant. We can use that property in our buildfiles as a | ||||
@@ -744,7 +744,7 @@ cd ant //3 | |||||
cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic update //4 | cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic update //4 | ||||
</pre></p> | </pre></p> | ||||
<p>We use the <i>-d</i> flag on <b>//1</b> to specifiy the cvs directory. You can | |||||
<p>We use the <i>-d</i> flag on <b>//1</b> to specify the cvs directory. You can | |||||
specify the environment variable CVSROOT with that value and after that you haven�t | specify the environment variable CVSROOT with that value and after that you haven�t | ||||
to use that flag any more. On <b>//2</b> we get the whole cvs tree of ant. (Sorry, | to use that flag any more. On <b>//2</b> we get the whole cvs tree of ant. (Sorry, | ||||
but that uses a lot of time ... 10 up to 30 minutes are not unusual ... but this has | but that uses a lot of time ... 10 up to 30 minutes are not unusual ... but this has | ||||
@@ -905,7 +905,7 @@ entry. For both we need some information:</p> | |||||
all locations as a property. See the included manual for details.</td> | all locations as a property. See the included manual for details.</td> | ||||
</tr> | </tr> | ||||
<tr> | <tr> | ||||
<th>attachements</th> | |||||
<th>attachments</th> | |||||
<td><i>all files needed to apply the path</td> | <td><i>all files needed to apply the path</td> | ||||
<td>Archive containing a patch with the new and modified resources</td> | <td>Archive containing a patch with the new and modified resources</td> | ||||
</tr> | </tr> | ||||
@@ -926,9 +926,9 @@ and the steps described there if you haven't one.</p> | |||||
<li>Choose "Ant" as product </li> | <li>Choose "Ant" as product </li> | ||||
<li>Version is the last "Alpha (nightly)" (at this time 1.7)</li> | <li>Version is the last "Alpha (nightly)" (at this time 1.7)</li> | ||||
<li>Component is "Core tasks"</li> | <li>Component is "Core tasks"</li> | ||||
<li>Plattform and Severity are ok with "Other" and "Normal"</li> | |||||
<li>Platform and Severity are ok with "Other" and "Normal"</li> | |||||
<li>Initial State is ok with "New"</li> | <li>Initial State is ok with "New"</li> | ||||
<li>Same with the empy "Assigned to"</li> | |||||
<li>Same with the empty "Assigned to"</li> | |||||
<li>It is not required to add yourself as CC, because you are the reporter and therefore will be | <li>It is not required to add yourself as CC, because you are the reporter and therefore will be | ||||
informed on changes</li> | informed on changes</li> | ||||
<li>URL: no url required</li> | <li>URL: no url required</li> | ||||
@@ -79,7 +79,7 @@ So the buildfile contains three targets. | |||||
This buildfile uses often the same value (src, classes, MyTask.jar), so we should rewrite that | This buildfile uses often the same value (src, classes, MyTask.jar), so we should rewrite that | ||||
using <code><property></code>s. On second there are some handicaps: <code><javac></code> requires that the destination | using <code><property></code>s. On second there are some handicaps: <code><javac></code> requires that the destination | ||||
directory exists; a call of "clean" with a non existing classes directory will fail; "jar" requires | directory exists; a call of "clean" with a non existing classes directory will fail; "jar" requires | ||||
the execution of some steps bofore. So the refactored code is: | |||||
the execution of some steps before. So the refactored code is: | |||||
<pre class="code"> | <pre class="code"> | ||||
<?xml version="1.0" encoding="ISO-8859-1"?> | <?xml version="1.0" encoding="ISO-8859-1"?> | ||||
@@ -208,7 +208,7 @@ Here is project 'MyTask'. | |||||
<h2>Deriving from Ant's Task</h2> | <h2>Deriving from Ant's Task</h2> | ||||
<p>Ok, that works ... But usually you will extend <tt>org.apache.tools.ant.Task</tt>. | <p>Ok, that works ... But usually you will extend <tt>org.apache.tools.ant.Task</tt>. | ||||
That class is integrated in Ant, get's the project-reference, provides documentation | That class is integrated in Ant, get's the project-reference, provides documentation | ||||
fiels, provides easier access to the logging facility and (very useful) gives you | |||||
fields, provides easier access to the logging facility and (very useful) gives you | |||||
the exact location where <i>in the buildfile</i> this task instance is used.</p> | the exact location where <i>in the buildfile</i> this task instance is used.</p> | ||||
<p>Oki-doki - let's us use some of these:</p> | <p>Oki-doki - let's us use some of these:</p> | ||||
@@ -558,9 +558,9 @@ For the declaration there are several ways: | |||||
<for ... /></code> | <for ... /></code> | ||||
</li> | </li> | ||||
<li>declare a bundle of tasks using a xml-file named antlib.xml, XML-namespace and | <li>declare a bundle of tasks using a xml-file named antlib.xml, XML-namespace and | ||||
<a href="Types/antlib.html#antlibnamespace"><code>antlib:</code> protocoll handler</a> | |||||
<a href="Types/antlib.html#antlibnamespace"><code>antlib:</code> protocol handler</a> | |||||
<br> | <br> | ||||
<code><project xmlns:ac="antlib:net.sf.antconrib"/> | |||||
<code><project xmlns:ac="antlib:net.sf.antcontrib"/> | |||||
<ac:for ... /></code> | <ac:for ... /></code> | ||||
</li> | </li> | ||||
</ul> | </ul> | ||||