diff --git a/manual/Tasks/BorlandEJBTasks.html b/manual/Tasks/BorlandEJBTasks.html index 126fe5c57..3ee56c6c9 100644 --- a/manual/Tasks/BorlandEJBTasks.html +++ b/manual/Tasks/BorlandEJBTasks.html @@ -24,7 +24,7 @@ -

BorlandDeployTool

+

BorlandDeploy Tool

by Benoit Moussaud (benoit.moussaud@criltelecom.com)

@@ -40,7 +40,7 @@ href="http://www.moussaud.org/ejbjar.html">FAQ for this task at his homepage.

Borland element

- +
@@ -92,11 +92,11 @@ his homepage.

if you have borland in your classpath. If you do not, you should use a nested <dtd> element, described in the ejbjar task - documentation. + documentation. - + @@ -112,7 +112,7 @@ his homepage.

- + @@ -136,8 +136,5 @@ his homepage.

The verify phase is turned on and the generate client phase as well. -

 

- - diff --git a/manual/Tasks/BorlandGenerateClient.html b/manual/Tasks/BorlandGenerateClient.html index 01956b25f..9454444a9 100644 --- a/manual/Tasks/BorlandGenerateClient.html +++ b/manual/Tasks/BorlandGenerateClient.html @@ -24,14 +24,14 @@ -

BorlandGenerateClient

+

BorlandGenerateClient

by Benoit Moussaud (benoit.moussaud@criltelecom.com)

Description

The BorlandGenerateClient is a task dedicated to Borland Application Server v 4.5. It offers to generate the client jar file corresponding to an ejb jar file.

Parameters

-
Attribute Description no
generateclient generateclient If true, turn on the generation of the corresponding ejbjar (default = false) no No, defaults to 4
java2iiopParams java2iiopParams If filled, the params are added to the java2iiop command (ex: -no_warn_missing_define) no
+
@@ -83,8 +83,6 @@ </classpath> </blgenclient> -
 
- diff --git a/manual/Tasks/ant.html b/manual/Tasks/ant.html index 87b78bb26..5579c2c00 100644 --- a/manual/Tasks/ant.html +++ b/manual/Tasks/ant.html @@ -24,7 +24,7 @@ -

Ant

+

Ant

Description

Runs Apache Ant on a supplied buildfile. This can be used to build @@ -81,7 +81,7 @@ defined outside of targets in the new project - but not those defined inside of targets.

Parameters

-
Attribute Description
+
@@ -115,7 +115,7 @@ inside of targets.

- @@ -156,11 +156,11 @@ false (see above).
Note that the refid attribute points to a reference in the calling project, not in the new one.

-

reference

+

reference

Used to choose references that shall be copied into the new project, optionally changing their id.

-
Attribute Description
outputFilename to write the ant output to. This is + Filename to write the Ant output to. This is relative to the value of the dir attribute if it has been set or to the base directory of the current project otherwise.
+
@@ -192,7 +192,7 @@ href="../Types/propertyset.html">propertysets.

instead of using the target attribute. These will be executed as if Ant had been invoked with a single target whose dependencies are the targets so specified, in the order specified.

-
Attribute Description
+
@@ -215,7 +215,7 @@ targets so specified, in the order specified.

no matter what any other attribute of this task says and no matter how deeply nested into levels of <ant> invocations this task lives.

- +

If you haven't set useNativeBasedir or set it to false, the following rules apply:

@@ -231,7 +231,7 @@ targets so specified, in the order specified.

different <ant> (or <antcall>) task "higher up", the following table shows the details:

-
Attribute Description
+
@@ -267,7 +267,7 @@ targets so specified, in the order specified.

attribute will always win, but if the dir attribute has been omitted an even more complex situation arises:

-
dir attribute inheritAll attribute
+
@@ -407,7 +407,5 @@ a <path> with the id path1, but

will copy the parent's definition of path1 into the new project using the id path2.

- - diff --git a/manual/Tasks/antcall.html b/manual/Tasks/antcall.html index 00cf61551..32044c884 100644 --- a/manual/Tasks/antcall.html +++ b/manual/Tasks/antcall.html @@ -24,7 +24,7 @@ -

AntCall

+

AntCall

Description

Call another target within the same buildfile optionally @@ -75,7 +75,7 @@ persist back to the calling project.

behavior of this task is undefined.

Parameters

-
parent dir attribute parent inheritAll attribute
+
@@ -122,11 +122,11 @@ down, even through additional <*ant*> tasks with inheritall s false (see above).

-

reference

+

reference

Used to choose references that shall be copied into the new project, optionally changing their id.

-
Attribute Description
+
@@ -158,7 +158,7 @@ href="../Types/propertyset.html">propertysets.

instead of using the target attribute. These will be executed as if Ant had been invoked with a single target whose dependencies are the targets so specified, in the order specified.

-
Attribute Description
+
@@ -195,7 +195,5 @@ targets so specified, in the order specified.

will copy the parent's definition of path1 into the new project using the id path2.

- - diff --git a/manual/Tasks/antlr.html b/manual/Tasks/antlr.html index ca0bcde72..c680f1d36 100644 --- a/manual/Tasks/antlr.html +++ b/manual/Tasks/antlr.html @@ -24,7 +24,7 @@ -

ANTLR

+

ANTLR

Description

Invokes the ANTLR Translator generator @@ -63,7 +63,7 @@ for more information.

Parameters

-
Attribute Description
+
@@ -160,7 +160,7 @@ for more information.

Attribute Description
-

Nested Elements

+

Nested Elements

ANTLR supports a nested <classpath> element, that represents a PATH like @@ -189,15 +189,12 @@ href="../using.html#arg">Command line arguments.

 <antlr
     target="etc/java.g"
-    outputdirectory="build/src"
-/>
+    outputdirectory="build/src"/>
 

This invokes ANTLR on grammar file etc/java.g, writing the generated files to build/src.

- - diff --git a/manual/Tasks/antstructure.html b/manual/Tasks/antstructure.html index ab7acc1a9..55810403a 100644 --- a/manual/Tasks/antstructure.html +++ b/manual/Tasks/antstructure.html @@ -24,8 +24,8 @@ -

AntStructure

-

Description

+

AntStructure

+

Description

Generates an DTD for Apache Ant buildfiles which contains information about all tasks currently known to Ant.

@@ -51,11 +51,11 @@ listed as #IMPLIED.

instead of the one that emits a DTD. In order to plug in your own structure, you have to implement the interface org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter -and <typedef> your class and use the new type as a nested -element of this task - see the example below. +and <typedef> your class and use the new type as a nested +element of this task - see the example below.

Parameters

- +
diff --git a/manual/Tasks/antversion.html b/manual/Tasks/antversion.html index cd9f838af..740b0a521 100644 --- a/manual/Tasks/antversion.html +++ b/manual/Tasks/antversion.html @@ -24,15 +24,15 @@ -

Antversion

+

Antversion

Description

-Stores the Apache Ant version (when used as task) or checks for a specific Ant version +Stores the Apache Ant version (when used as task) or checks for a specific Ant version (when used as condition). Since Ant 1.7.0

-
Attribute Description
+
@@ -41,14 +41,14 @@ Stores the Apache Ant version (when used as task) or checks for a specific Ant v - - diff --git a/manual/Tasks/apply.html b/manual/Tasks/apply.html index 5444a644f..78c3a4097 100644 --- a/manual/Tasks/apply.html +++ b/manual/Tasks/apply.html @@ -24,7 +24,7 @@ -

Apply/ExecOn

+

Apply/ExecOn

The name execon is deprecated and only kept for backwards compatibility.

Description

@@ -40,8 +40,7 @@ href="../Types/resources.html#collection">Resource Collections (since Ant 1.6) or FileLists (since Ant 1.6) -– - are passed as arguments to the system command.

+– are passed as arguments to the system command.

If you specify a nested mapper, the timestamp of each source file is compared to the timestamp of a target file which is defined by the nested mapper element and searched @@ -52,8 +51,8 @@ and you must not specify more than one mapper.

Note that you cannot interact with the forked program, the only way to send input to it is via the input and inputstring attributes.

-

Running Ant as a background process on - Unix(-like) systems

+

Running Ant as a background process on + Unix(-like) systems

If you run Ant as a background process (like ant &) and use the <apply> task with spawn @@ -62,7 +61,7 @@ to send input to it is via the input and inputstring attributes.

from the standard input.

Parameters

-
Attribute Description
atleastThe version that this at least. + The version that this Ant is of at least. The format is major.minor.point. No One of these.
exactlyThe version that this ant is exactly. + The version that this Ant is of exactly. The format is major.minor.point. No
+
@@ -85,7 +84,7 @@ to send input to it is via the input and inputstring attributes.

@@ -211,7 +210,7 @@ to send input to it is via the input and inputstring attributes.

+ Defaults to true. @@ -338,7 +337,7 @@ end of the command line (unless you set addsourcefile to false). If you need to place it somewhere different, use a nested <srcfile> element between your <arg> elements to mark the insertion point.

-
Attribute Description
spawn whether or not you want the commands to be spawned.
- If you spawn a command, its output will not be logged by ant.
+ If you spawn a command, its output will not be logged by Ant.
The input, output, error, and result property settings are not active when spawning a process.
since Ant 1.6
failifexecutionfails Stop the build if we can't start the program. - Defaults to true. No
+
@@ -363,7 +362,7 @@ use a nested <srcfile> element between your filename on the command line. If omitted, the target filenames will not be added to the command line at all. This element can only be specified if you also define a nested mapper.

-
Attribute Description
+
@@ -495,10 +494,5 @@ all files in the src-directory. Because the filename itself should not be passed to the jsmin program, the addsourcefile is set to false. - - - - - diff --git a/manual/Tasks/attrib.html b/manual/Tasks/attrib.html index ab09f6540..a925384fe 100644 --- a/manual/Tasks/attrib.html +++ b/manual/Tasks/attrib.html @@ -24,7 +24,7 @@ -

Attrib

+

Attrib

Since Apache Ant 1.6.

Description

@@ -33,10 +33,10 @@ directories. Right now it has effect only under Windows. Each of the 4 possible permissions has its own attribute, matching the arguments for the attrib command.

-

FileSets, +

FileSets, DirSets or FileLists can be specified using -nested <fileset>, <dirset> and +nested <fileset>, <dirset> and <filelist> elements.

Starting with Ant 1.7, this task supports arbitrary platform independent alternative.

Parameters

-
Attribute Description
+
- + - - + @@ -164,7 +164,5 @@ directory tree), so you'll have to experiment a little. to a FileSet with id other.shared.sources get the same attributes.

- - diff --git a/manual/Tasks/augment.html b/manual/Tasks/augment.html index 305e39a83..9a215b2e7 100644 --- a/manual/Tasks/augment.html +++ b/manual/Tasks/augment.html @@ -35,7 +35,7 @@ original element. Since Apache Ant 1.8.1

Parameters

-
Attribute DescriptionRequiredRequired
file the file or directory of which the permissions must be changed.Yes or nested + Yes or nested <fileset/list> elements.
readonly the readonly permission.at least one of the four. at least one of the four.
archive
+
diff --git a/manual/Tasks/available.html b/manual/Tasks/available.html index 6e4a17185..bda0f5854 100644 --- a/manual/Tasks/available.html +++ b/manual/Tasks/available.html @@ -24,7 +24,7 @@ -

Available

+

Available

Description

Sets a property if a resource is available at runtime. This resource can be a file, a directory, a class in the classpath, or a JVM system resource.

@@ -34,7 +34,7 @@ something other than the default by specifying the value attribute.

Normally, this task is used to set properties that are useful to avoid target execution depending on system parameters.

Parameters

-
Attribute Description
+
@@ -154,7 +154,5 @@ if the class javax.xml.transform.Transformer is found in the classp if the resource-file extratasks.properties is found.

- - diff --git a/manual/Tasks/basename.html b/manual/Tasks/basename.html index 0822d8f9e..b185b24ae 100644 --- a/manual/Tasks/basename.html +++ b/manual/Tasks/basename.html @@ -24,7 +24,7 @@ -

Basename

+

Basename

Description

Task to determine the basename of a specified file, optionally minus a @@ -37,9 +37,9 @@ directory, the basename will be the last directory element. If file is a full-path, relative-path, or simple filename, the basename will be the simple file name, without any directory elements.

-

+

Parameters

-
Attribute Description
+
@@ -81,12 +81,8 @@ will set cmdname to foo. <property environment="env"/> <basename property="temp.dirname" file="${env.TEMP}"/> - will set temp.dirname to the last directory element of -the path defined for the TEMP environment variable.

- - +the path defined for the TEMP environment variable. - diff --git a/manual/Tasks/bindtargets.html b/manual/Tasks/bindtargets.html index d8374a49c..fd4767b2b 100644 --- a/manual/Tasks/bindtargets.html +++ b/manual/Tasks/bindtargets.html @@ -24,7 +24,7 @@ -

Bindtargets

+

Bindtargets

Description

Make some target the extension of some defined @@ -58,7 +58,7 @@ and predictable as soon as every build file is loaded.

Since Apache Ant 1.8.2

Parameters

-
Attribute Description
+
diff --git a/manual/Tasks/buildnumber.html b/manual/Tasks/buildnumber.html index aaaa14cd8..7351e2241 100644 --- a/manual/Tasks/buildnumber.html +++ b/manual/Tasks/buildnumber.html @@ -24,7 +24,7 @@ -

BuildNumber

+

BuildNumber

Description

This is a basic task that can be used to track build numbers.

It will first attempt to read a build number from a file (by default, @@ -39,7 +39,7 @@ the number format.)

Parameters

-
Attribute Description
+
@@ -67,8 +67,5 @@ the number format.)

Read, increment, and write a build number to the file mybuild.number.

- - - diff --git a/manual/Tasks/cab.html b/manual/Tasks/cab.html index e981827a5..6d7a4d6cc 100644 --- a/manual/Tasks/cab.html +++ b/manual/Tasks/cab.html @@ -24,7 +24,7 @@ -

Cab

+

Cab

Description

The cab task creates Microsoft cab archive files. It is invoked similar to the jar or zip tasks. @@ -42,7 +42,7 @@ supports most attributes of <fileset> <include>, <exclude> and <patternset> elements.

Parameters

-
Attribute Description
+
@@ -120,16 +120,14 @@ element to specify the files to be included in the archive.

Examples

 <cab cabfile="${dist}/manual.cab"
-     basedir="htdocs/manual"
-  />
+     basedir="htdocs/manual"/>
 

cabs all files in the htdocs/manual directory into a file called manual.cab in the ${dist} directory.

 <cab cabfile="${dist}/manual.cab"
      basedir="htdocs/manual"
-     excludes="mydocs/**, **/todo.html"
-  />
+     excludes="mydocs/**, **/todo.html"/>
 

cabs all files in the htdocs/manual directory into a file called manual.cab in the ${dist} directory. Files in the directory mydocs, @@ -139,8 +137,7 @@ or files with the name todo.html are excluded.

basedir="htdocs/manual" includes="api/**/*.html" excludes="**/todo.html" - verbose="yes" - /> + verbose="yes"/>

Cab all files in the htdocs/manual directory into a file called manual.cab in the ${dist} directory. Only html files under the @@ -154,14 +151,10 @@ output.

<fileset dir="htdocs/manual" includes="api/**/*.html" - excludes="**/todo.html" - /> + excludes="**/todo.html"/> </cab>

is equivalent to the example above.

- - - diff --git a/manual/Tasks/ccm.html b/manual/Tasks/ccm.html index 9f4725f75..8e229097c 100644 --- a/manual/Tasks/ccm.html +++ b/manual/Tasks/ccm.html @@ -35,12 +35,12 @@

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.

-
-

CCMCheckin

+
+

CCMCheckin

Description

Task to checkin a file

Parameters

-
Attribute Description
+
@@ -76,12 +76,12 @@ Task to checkin a file

Checks in the file c:/wa/com/foo/MyFile.java. Comment attribute mycomment is added as a task comment. The task used is the one set as the default.

-
-

CCMCheckout

+
+

CCMCheckout

Description

Task to perform a Checkout command to Continuus

Parameters

-
Attribute Values
+
@@ -90,7 +90,7 @@ Task to perform a Checkout command to Continuus - + @@ -134,15 +134,12 @@ Task to perform a Checkout command to Continuus

Check out all the files in the lib directory having the .jar extension. Comment attribute mycomment is added as a task comment The used task is the one set as the default.

- - - -
-

CCMCheckinTask

+
+

CCMCheckinTask

Description

Task to perform a check in default task command to Continuus

Parameters

-
Attribute Values
file Path to the file that the command will operate onYes (file|fileset)Yes (file|fileset)
fileset
+
@@ -164,18 +161,18 @@ Task to perform a check in default task command to Continuus
Attribute ValuesNo
-

Examples

+

Examples

<ccmcheckintask comment="blahblah/>
 

Does a Checkin default task on all the checked out files in the current task.

-
-

CCMReconfigure

+
+

CCMReconfigure

Description

Task to perform an reconfigure command to Continuus.

Parameters

- +
@@ -210,12 +207,12 @@ Task to perform an reconfigure command to Continuus.

Does a Continuus reconfigure on the project ANTCCM_TEST#BMO_1.

-
-

CCMCreateTask

+
+

CCMCreateTask

Description

Create a Continuus task.

Parameters

-
Attribute Values
+
@@ -266,7 +263,5 @@ Create a Continuus task.

Creates a task for the release ANTCCM_TEST with the current user as the resolver for this task.

- - diff --git a/manual/Tasks/changelog.html b/manual/Tasks/changelog.html index 8d9a70b8d..e63e2a4d1 100644 --- a/manual/Tasks/changelog.html +++ b/manual/Tasks/changelog.html @@ -24,10 +24,10 @@ -

CvsChangeLog

+

CvsChangeLog

Description

Generates an XML-formatted report file of the change logs recorded in a -CVS repository.

+CVS repository.

Important: This task needs "cvs" on the path. If it isn't, you will get an error (such as error 2 on windows). If <cvs> doesn't work, try to execute cvs.exe from the command line in the target directory in which you are working. @@ -37,7 +37,7 @@ for certain other cvs clients - like CVSNT for example - and some operation may fail when using such an incompatible client.

Parameters

-
Attribute Values
+
@@ -129,7 +129,7 @@ operation may fail when using such an incompatible client. + false. Since Ant 1.8.0 @@ -137,7 +137,7 @@ operation may fail when using such an incompatible client. + branch on which startTag lives. Since Ant 1.8.0 @@ -145,14 +145,13 @@ operation may fail when using such an incompatible client. included in the report. - Since Ant 1.8.0 + branch on which endTag lives. Since Ant 1.8.0
Attribute Descriptionremote If set to true, works against the repository (using rlog) without a working copy. Default is - false. Since Ant 1.8.0 No
The start of a tag range. If endTag is also specified, they must both be on the same branch. If endTag is not specified, the end of the range will be the latest on the same - branch on which startTag lives. Since Ant 1.8.0 No
The end of a tag range. If startTag is also specified, they must both be on the same branch. If startTag is not specified, the start of the range will be the top of the - branch on which endTag lives. No

Parameters specified as nested elements

-

user

+

user

The nested <user> element allows you to specify a mapping between a user ID as it appears on the CVS server and a name to include in the formatted report. @@ -161,7 +160,7 @@ Anytime the specified user ID has made a change in the repository, the the name specified in displayname rather than the user ID.

- +
@@ -186,7 +185,7 @@ the name specified in displayname rather than the user ID. modules specified using this attribute can contain spaces in their name.

-
Attribute Description
+
@@ -201,8 +200,7 @@ the name specified in displayname rather than the user ID.

Examples

  <cvschangelog dir="dve/network"
-                destfile="changelog.xml"
-  />
+ destfile="changelog.xml"/>

Generates a change log report for all the changes that have been made under the dve/network directory. @@ -210,8 +208,7 @@ It writes these changes into the file changelog.xml.

  <cvschangelog dir="dve/network"
                 destfile="changelog.xml"
-                daysinpast="10"
-  />
+ daysinpast="10"/>

Generates a change log report for any changes that were made under the dve/network directory in the past 10 days. @@ -220,8 +217,7 @@ It writes these changes into the file changelog.xml.

  <cvschangelog dir="dve/network"
                 destfile="changelog.xml"
                 start="20 Feb 2002"
-                end="20 Mar 2002"
-  />
+ end="20 Mar 2002"/>

Generates a change log report for any changes that were made between February 20, 2002 and March 20, 2002 @@ -230,8 +226,7 @@ It writes these changes into the file changelog.xml.

  <cvschangelog dir="dve/network"
                 destfile="changelog.xml"
-                start="20 Feb 2002"
-  />
+ start="20 Feb 2002"/>

Generates a change log report for any changes that were made after February 20, 2002 under the dve/network directory. @@ -254,13 +249,13 @@ It writes these changes into the file changelog.xml.

destfile="changelogant.xml" tag="ANT_16_BRANCH"/>

Generate Report

-

Ant includes a basic XSLT stylesheet that you can use to generate +

Ant includes a basic XSLT stylesheet that you can use to generate a HTML report based on the xml output. The following example illustrates how to generate a HTML report from the XML report.

-        <style in="changelog.xml" 
-               out="changelog.html" 
+        <style in="changelog.xml"
+               out="changelog.html"
                style="${ant.home}/etc/changelog.xsl">
           <param name="title" expression="Ant ChangeLog"/>
           <param name="module" expression="ant"/>
@@ -287,8 +282,5 @@ This allows templates to be stored inside jar]]></msg>
 </changelog>
 
- - - diff --git a/manual/Tasks/checksum.html b/manual/Tasks/checksum.html index 29f48ddfd..8df2ff698 100644 --- a/manual/Tasks/checksum.html +++ b/manual/Tasks/checksum.html @@ -24,7 +24,7 @@ -

Checksum

+

Checksum

Description

Generates checksum for files. This task can also be used to @@ -53,7 +53,7 @@ or set the fileext attribute. The names of common hashing algorithms ca

Parameters

-
Attribute Description
+
@@ -129,27 +129,27 @@ or set the fileext attribute. The names of common hashing algorithms ca
Attribute Description
format Specifies the pattern to use as one of a - well-known format. Supported values are - + well-known format. Supported values are +
- + - + - + - + - +
name pattern description
CHECKSUM CHECKSUM {0}only the checksum itself only the checksum itself
MD5SUM MD5SUM {0} *{1} the format of GNU textutils md5sum
SVF SVF MD5 ({1}) = {0}the format of BSDs md5 command the format of BSDs md5 command
Since Ant 1.7.0 @@ -256,14 +256,10 @@ Works like Example 4, but only sets isChecksumEqual to true, if the checksum matches - it will never be set to false. This example demonstrates use with the Condition task. -

Note:

When working with more than one file, if condition and/or verifyproperty is used, the result will be true only if the checksums matched correctly for all files being considered. - - - diff --git a/manual/Tasks/chgrp.html b/manual/Tasks/chgrp.html index 2126fb741..783498ea9 100644 --- a/manual/Tasks/chgrp.html +++ b/manual/Tasks/chgrp.html @@ -24,7 +24,7 @@ -

Chgrp

+

Chgrp

Since Apache Ant 1.6.

Description

@@ -33,10 +33,10 @@ directories. Right now it has effect only under Unix. The group attribute is equivalent to the corresponding argument for the chgrp command.

-

FileSets, +

FileSets, DirSets or FileLists can be specified using -nested <fileset>, <dirset> and +nested <fileset>, <dirset> and <filelist> elements.

Starting with Ant 1.7, this task supports arbitrary value to your current os.

Parameters

- +
- + - @@ -153,7 +153,7 @@ belong to the coders group on a UNIX system.

makes all files below shared/sources1 (except those -below any directory named trial) belong to the coders group on a UNIX +below any directory named trial) belong to the coders group on a UNIX system. In addition all files belonging to a FileSet with id other.shared.sources get the same group.

@@ -172,14 +172,10 @@ group.

-

makes all .test.jsp, and .new files belong to -group webdev. Directories beginning with test_ also will belong +

makes all .test.jsp, and .new files belong to +group webdev. Directories beginning with test_ also will belong to webdev, but if there is a directory that ends in .new or a file that begins with test_ it will be unaffected.

- - - - diff --git a/manual/Tasks/chmod.html b/manual/Tasks/chmod.html index 59ecc5a9f..9410ddd83 100644 --- a/manual/Tasks/chmod.html +++ b/manual/Tasks/chmod.html @@ -24,7 +24,7 @@ -

Chmod

+

Chmod

Description

Changes the permissions of a file or all files inside specified directories. Right now it has effect only under Unix or NonStop Kernel (Tandem). @@ -37,7 +37,7 @@ write patterns.

href="../Types/fileset.html">FileSet and supports all of FileSet's attributes and nested elements directly. More sets can be specified using nested <fileset> or -<dirset> (since Apache Ant 1.6) elements.

+<dirset> (since Apache Ant 1.6) elements.

Starting with Ant 1.6, this task also supports nested filelists.

@@ -67,21 +67,21 @@ could use as initial value for these experiments.

platform independent alternative.

Parameters

-
Attribute DescriptionRequiredRequired
file the file or directory of which the group must be changed.Yes, unless nested + Yes, unless nested <fileset|filelist|dirset> elements are specified
+
- + - - + - baselinerootname="Application_Baseline_AUTO" identical="yes" full="no" - viewpath="v:\ApplicationCC" - /> + viewpath="v:\ApplicationCC"/>

Does a ClearCase mkbl on the Integration view at v:\ApplicationCC even if it is identical to a previous baseline. The new baseline with be incremental and named "Application_Baseline_AUTO".


- -

CCMkattr

+

CCMkattr

Description

Task to perform a "cleartool mkattr" command to ClearCase.
-Since ant 1.6.1 +Since Ant 1.6.1

Parameters

-
Attribute DescriptionRequiredRequired
filethe file or single directory of which the permissions + the file or single directory of which the permissions must be changed.exactly one of the two or nested <fileset/list> elements.exactly one of the two or nested <fileset/list> elements.
dirthe directory which holds the files whose permissions + the directory which holds the files whose permissions must be changed.
Note: for backwards compatibility reasons <chmod dir="some-dir"/> will @@ -167,7 +167,7 @@ UNIX system.

UNIX system.

-<chmod dir="${dist}/bin" perm="ugo+rx" 
+<chmod dir="${dist}/bin" perm="ugo+rx"
        includes="**/*.sh"/>
 
@@ -204,7 +204,7 @@ permissions.

keeps non-owners from touching cgi scripts, files with a .old -extension or directories beginning with private_. A directory +extension or directories beginning with private_. A directory ending in .old or a file beginning with private_ would remain unaffected.

@@ -212,17 +212,16 @@ unaffected.

Note on maxparallel attribute

Some shells have a limit of the number of characters that - a command line may contain. + a command line may contain. This maximum limit varies from shell to shell and from operating system to operating system. If one has a large number of files to change mode on, consider using the maxparallel attribute. For example when using AIX and the limit is reached, the system responds - with a warning: "Warning: + with a warning: "Warning: UNIXProcess.forkAndExec native error: The parameter or environment lists are too long". A value of about 300 seems to result in a command line that is acceptable.

- diff --git a/manual/Tasks/chown.html b/manual/Tasks/chown.html index 33a9f446a..936248f76 100644 --- a/manual/Tasks/chown.html +++ b/manual/Tasks/chown.html @@ -24,7 +24,7 @@ -

Chown

+

Chown

Since Apache Ant 1.6.

Description

@@ -33,10 +33,10 @@ directories. Right now it has effect only under Unix. The owner attribute is equivalent to the corresponding argument for the chown command.

-

FileSets, +

FileSets, DirSets or FileLists can be specified using -nested <fileset>, <dirset> and +nested <fileset>, <dirset> and <filelist> elements.

Starting with Ant 1.7, this task supports arbitrary value to your current os.

Parameters

- +
@@ -71,7 +71,7 @@ could use as initial value for these experiments.

- @@ -152,7 +152,7 @@ belong to coderjoe on a UNIX system.

makes all files below shared/sources1 (except those -below any directory named trial) belong to coderjoe on a UNIX +below any directory named trial) belong to coderjoe on a UNIX system. In addition all files belonging to a FileSet with id other.shared.sources get the same owner.

@@ -173,11 +173,8 @@ owner.

makes cgi scripts, files with a .old extension or directories beginning with private_ belong to the user named -webadmin. A directory ending in .old or a file beginning with +webadmin. A directory ending in .old or a file beginning with private_ would remain unaffected.

- - - diff --git a/manual/Tasks/clearcase.html b/manual/Tasks/clearcase.html index 902d5efe0..1302103a3 100644 --- a/manual/Tasks/clearcase.html +++ b/manual/Tasks/clearcase.html @@ -35,25 +35,25 @@ Sean Egan (sean at cm-logic dot com)

ClearCase Support

Table of Contents

-
-

Introduction

+
+

Introduction

Apache Ant provides several optional tasks for working with ClearCase. These tasks correspond to various ClearCase commands using the Cleartool program. The current tasks available for Ant correspond to only a few of the significant ClearCase commands.

@@ -67,12 +67,12 @@ functionality that is specific to that ClearCase command.

-
-

CCCheckin

+
+

CCCheckin

Description

Task to perform a "cleartool checkin" command to ClearCase.

Parameters

-
Attribute Description file the file or directory of which the owner must be changed.Yes or nested + Yes or nested <fileset/list> elements.
+
@@ -135,12 +135,12 @@ Task to perform a "cleartool checkin" command to ClearCase. Comment text from the file acomment.txt is added to ClearCase as a comment. All warning messages are suppressed. The file is checked in even if it is identical to the original.

-
-

CCCheckout

+
+

CCCheckout

Description

Task to perform a "cleartool checkout" command to ClearCase.

Parameters

-
Attribute Values
+
@@ -197,13 +197,13 @@ Task to perform a "cleartool checkout" command to ClearCase. + Since Ant 1.6.1 + Since Ant 1.6.1
Attribute Values
notco Fail if it's already checked out to the current view. Set to false to ignore it.
- Since ant 1.6.1
No
failonerr Throw an exception if the command fails. Default is true.
- Since ant 1.6.1
No
@@ -221,12 +221,12 @@ Task to perform a "cleartool checkout" command to ClearCase. It is checked out as reserved on branch called abranch. All warning messages are suppressed. A Some comment text is added to ClearCase as a comment.

-
-

CCUnCheckout

+
+

CCUnCheckout

Description

Task to perform a UnCheckout command to ClearCase.

Parameters

- +
@@ -246,8 +246,8 @@ Task to perform a UnCheckout command to ClearCase. - +
Attribute Values
failonerrThrow an exception if the command fails. Default is true
- Since ant 1.6.1
Throw an exception if the command fails. Default is true.
+ Since Ant 1.6.1
No
@@ -260,12 +260,12 @@ Task to perform a UnCheckout command to ClearCase.

Does a ClearCase uncheckout on the file c:/views/viewdir/afile. A copy of the file called c:/views/viewdir/afile.keep is kept.

-
-

CCUpdate

+
+

CCUpdate

Description

Task to perform an "cleartool update" command to ClearCase.

Parameters

- +
@@ -314,7 +314,7 @@ Task to perform an "cleartool update" command to ClearCase. + Since Ant 1.6.1
Attribute Values
failonerr Throw an exception if the command fails. Default is true.
- Since ant 1.6.1
No
@@ -333,15 +333,12 @@ Task to perform an "cleartool update" command to ClearCase. A graphical dialog will be displayed. The output will be logged to log.log and it will overwrite any hijacked files. The modified time will be set to the current time.

- - - -
-

CCMklbtype

+
+

CCMklbtype

Description

Task to perform a "mklbtype" command to ClearCase.

Parameters

- +
@@ -369,7 +366,7 @@ Task to perform a "mklbtype" command to ClearCase. - + @@ -394,8 +391,8 @@ Task to perform a "mklbtype" command to ClearCase. - +
Attribute Values
ordinaryEither global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. DefaultEither global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. Default No
failonerrThrow an exception if the command fails. Default is true
- Since ant 1.6.1
Throw an exception if the command fails. Default is true.
+ Since Ant 1.6.1
No
@@ -411,14 +408,12 @@ Task to perform a "mklbtype" command to ClearCase.

Does a ClearCase mklbtype to create a label type named VERSION_1. It is created as ordinary so it is available only to the current VOB. The text Development version 1 is added as a comment.

- - -
-

CCMklabel

+
+

CCMklabel

Description

Task to perform a "mklabel" command to ClearCase.

Parameters

- +
@@ -466,8 +461,8 @@ Task to perform a "mklabel" command to ClearCase. - +
Attribute Values
failonerrThrow an exception if the command fails. Default is true
- Since ant 1.6.1
Throw an exception if the command fails. Default is true.
+ Since Ant 1.6.1
No
@@ -485,14 +480,12 @@ Task to perform a "mklabel" command to ClearCase.

Does a ClearCase mklabel on the file c:/views/viewdir/afile under the main branch for version 2 (\main\2). Text Some comment text is added as a comment. It will recurse all subdirectories. - - -


-

CCRmtype

+
+

CCRmtype

Description

Task to perform a "rmtype" command to ClearCase.

Parameters

- +
@@ -501,30 +494,41 @@ Task to perform a "rmtype" command to ClearCase. @@ -558,7 +562,7 @@ Task to perform a "rmtype" command to ClearCase. + Since Ant 1.6.1
Attribute Values
typekind The kind of type to create. Valid types are: - +
+ + + + + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Kind Description
attype
- brtype
- eltype
- hltype
- lbtype
- trtype -
-
- -
- -
- -
- -
- - -
attribute type
- branch type
- element type
- hyperlink type
- label type
- trigger type -
attype-attribute type
brtype-branch type
eltype-element type
hltype-hyperlink type
lbtype-label type
trtype-trigger type
failonerr Throw an exception if the command fails. Default is true - Since ant 1.6.1 No
@@ -575,13 +579,12 @@ Task to perform a "rmtype" command to ClearCase.

Does a ClearCase rmtype to remove a label type (lbtype) named VERSION_1. Comment text from the file acomment.txt is added as a comment. All instances of the type are removed, including the type object itself.

-
- -

CCLock

+
+

CCLock

Description

Task to perform a "cleartool lock" command to ClearCase.

Parameters

- +
@@ -619,13 +622,13 @@ Task to perform a "cleartool lock" command to ClearCase. + Since Ant 1.6.1 + Since Ant 1.6.1 @@ -634,18 +637,16 @@ Task to perform a "cleartool lock" command to ClearCase.
 <cclock
-    objsel="stream:Application_Integration@\MyProject_PVOB"
-    />
+    objsel="stream:Application_Integration@\MyProject_PVOB"/>
 

Does a ClearCase lock on the object stream:Application_Integration@\MyProject_PVOB.


- -

CCUnlock

+

CCUnlock

Description

Task to perform a "cleartool unlock" command to ClearCase.

Parameters

-
Attribute Values
objsel Specifies the object(s) to be locked.
- Since ant 1.6.1
No
failonerr Throw an exception if the command fails. Default is true.
- Since ant 1.6.1
No
+
@@ -668,13 +669,13 @@ Task to perform a "cleartool unlock" command to ClearCase. + Since Ant 1.6.1 + Since Ant 1.6.1 @@ -683,18 +684,16 @@ Task to perform a "cleartool unlock" command to ClearCase.
 <ccunlock
-    objsel="stream:Application_Integration@\MyProject_PVOB"
-    />
+    objsel="stream:Application_Integration@\MyProject_PVOB"/>
 

Does a ClearCase unlock on the object stream:Application_Integration@\MyProject_PVOB.


- -

CCMkbl

+

CCMkbl

Description

Task to perform a "cleartool mkbl" command to ClearCase.

Parameters

-
Attribute Values
objsel Specifies the object(s) to be unlocked.
- Since ant 1.6.1
No
failonerr Throw an exception if the command fails. Default is true.
- Since ant 1.6.1
No
+
@@ -741,7 +740,7 @@ previous baseline. + Since Ant 1.6.1
Attribute Values
failonerr Throw an exception if the command fails. Default is true.
- Since ant 1.6.1
No
@@ -752,21 +751,19 @@ previous baseline.
+
@@ -823,20 +820,18 @@ Since ant 1.6.1
 <ccmkattr viewpath="c:/views/viewdir/afile"
     typename="BugFix"
-    typevalue="34445"
-    />
+    typevalue="34445"/>
 

Does a ClearCase mkattr on the file c:/views/viewdir/afile and attaches the attribute BugFix with a value of 34445 to it.

-
- -

CCMkdir

+
+

CCMkdir

Description

Task to perform a "cleartool mkdir" command to ClearCase.
-Since ant 1.6.1 +Since Ant 1.6.1

Parameters

-
Attribute Values
+
@@ -878,14 +873,13 @@ Since ant 1.6.1

Does a ClearCase mkdir on the dir c:/views/viewdir/adir and does not automatically check it out.

-
- -

CCMkelem

+
+

CCMkelem

Description

Task to perform a "cleartool mkelem" command to ClearCase.
-Since ant 1.6.1 +Since Ant 1.6.1

Parameters

-
Attribute Values
+
diff --git a/manual/Tasks/common.html b/manual/Tasks/common.html index 6fa3418e5..d1c37aeb3 100644 --- a/manual/Tasks/common.html +++ b/manual/Tasks/common.html @@ -24,10 +24,10 @@ -

Common Attributes of all Tasks

+

Common Attributes of all Tasks

All tasks share the following attributes:

-
Attribute Values
+
@@ -52,8 +52,5 @@
Attribute Description
- - - diff --git a/manual/Tasks/componentdef.html b/manual/Tasks/componentdef.html index e28e68130..7c2fe6d59 100644 --- a/manual/Tasks/componentdef.html +++ b/manual/Tasks/componentdef.html @@ -24,7 +24,7 @@ -

componentdef

+

componentdef

Description

Adds a component definition to the current project. @@ -54,9 +54,8 @@ classname="com.apache.tools.ant.types.resources.selectors.Or"/>

defines two components with the same name "or"; one is a condition - (see conditions) and one is + (see conditions) and one is a selector (see selectors).

- diff --git a/manual/Tasks/concat.html b/manual/Tasks/concat.html index 11372d07e..3d302d42d 100644 --- a/manual/Tasks/concat.html +++ b/manual/Tasks/concat.html @@ -19,17 +19,17 @@ -Concat + Concat -

Concat

+

Concat

Description

- Concatenates one or more + Concatenates one or more resources to a single file or to the console. The destination file will be created if it does not exist unless the resource @@ -38,7 +38,7 @@

Since Apache Ant 1.7.1, this task can be used as a Resource Collection - that will return exactly one + that will return exactly one resource.

@@ -51,7 +51,7 @@ Resource Collections are used to

Parameters

- +
@@ -93,7 +93,7 @@ Resource Collections are used to @@ -102,7 +102,7 @@ Resource Collections are used to + files. Since Ant 1.8.2 @@ -121,7 +121,7 @@ Resource Collections are used to @@ -135,7 +135,7 @@ Resource Collections are used to a new line. If this attribute is "yes" a new line will be appended to the stream if the file did not end in a new line. - since Ant 1.6. + Since Ant 1.6. Defaults to "no". This attribute does not apply to embedded text. @@ -146,7 +146,7 @@ Resource Collections are used to
Attribute Specifies whether or not the file specified by 'destfile' should be written to even if it is newer than all source files. - since Ant 1.8.2. + Since Ant 1.8.2. Defaults to "yes". No
forceReadOnly Overwrite read-only destination - files. since Ant 1.8.2 No; defaults to false.
outputencoding The encoding to use when writing the output file - since Ant 1.6. + Since Ant 1.6. Defaults to the value of the encoding attribute if given or the default JVM encoding otherwise. Specifies what the end of line character are for use by the fixlastline attribute. - since Ant 1.6 + Since Ant 1.6 Valid values for this property are:
  • cr: a single CR
  • @@ -167,7 +167,7 @@ Resource Collections are used to
binary - since Ant 1.6.2 + Since Ant 1.6.2 If this attribute is set to true, the task concatenates the files in a byte by byte fashion. If this attribute is false, concat will not normally work for binary files due to character encoding @@ -221,7 +221,7 @@ Resource Collections are used to

since Ant 1.6.

Used to prepend or postpend text into the concatenated stream.

The text may be in-line or be in a file.

- +
@@ -292,7 +292,7 @@ Resource Collections are used to </concat> -

Concatenate a series of files, expanding ant properties

+

Concatenate a series of files, expanding Ant properties

    <concat destfile="${build.dir}/subs">
       <path>
@@ -330,8 +330,5 @@ Resource Collections are used to
    </concat>
         
- - - - + diff --git a/manual/Tasks/condition.html b/manual/Tasks/condition.html index 405f95e7a..8505b818c 100644 --- a/manual/Tasks/condition.html +++ b/manual/Tasks/condition.html @@ -24,7 +24,7 @@ -

Condition

+

Condition

Description

Sets a property if a certain condition holds true - this is a generalization of Available and

Conditions are specified as nested elements, you must specify exactly one condition.

Parameters

-
Attribute Description
+
@@ -62,7 +62,7 @@ you must specify exactly one condition.

Attribute Description No
-

Parameters specified as nested elements

+

Parameters specified as nested elements

All conditions to test are specified as nested elements, for a complete list see here.

@@ -83,10 +83,8 @@ classpath.

<condition property="isMacOsButNotMacOsX"> <and> <os family="mac"/> - <not> <os family="unix"/> - </not> </and> </condition> @@ -98,13 +96,10 @@ in the Unix family as well.

   <condition property="isSunOSonSparc">
     <os name="SunOS" arch="sparc"/>
-
   </condition>
 

sets the property isSunOSonSparc if the current operating system is SunOS and if it is running on a sparc architecture.

- - diff --git a/manual/Tasks/conditions.html b/manual/Tasks/conditions.html index 77c76a191..ab392f994 100644 --- a/manual/Tasks/conditions.html +++ b/manual/Tasks/conditions.html @@ -24,8 +24,8 @@ -

Conditions

-

Conditions are nested elements of the +

Conditions

+

Conditions are nested elements of the <condition> and <waitfor> tasks. There are core conditions and custom conditions. Custom @@ -34,20 +34,20 @@ Custom Conditions. Core Conditions are described below.

-

Core Conditions

+

Core Conditions

These are the nested elements that can be used as conditions in the <condition> and <waitfor> tasks.

-

not

+

not

The <not> element expects exactly one other condition to be nested into this element, negating the result of the condition. It doesn't have any attributes and accepts all nested elements of the condition task as nested elements as well.

-

and

-The <and> element doesn't have any attributes and +

and

+

The <and> element doesn't have any attributes and accepts an arbitrary number of conditions as nested elements - all nested elements of the condition task are supported. This condition is true if all of its contained conditions are, conditions will be @@ -56,17 +56,18 @@ evaluated in the order they have been specified in the build file.

semantics as the Java && operator, as soon as one of the nested conditions is false, no other condition will be evaluated.

-

or

-The <or> element doesn't have any attributes and +

or

+

The <or> element doesn't have any attributes and accepts an arbitrary number of conditions as nested elements - all nested elements of the condition task are supported. This condition is true if at least one of its contained conditions is, conditions will be evaluated in the order they have been specified in the build -file.

The <or> condition has the same +file.

+

The <or> condition has the same shortcut semantics as the Java || operator, as soon as one of the nested conditions is true, no other condition will be evaluated.

-

xor

+

xor

The <xor> element performs an exclusive or on all nested elements, similar to the ^ operator in Java. It only evaluates to true if an odd number of nested conditions @@ -75,24 +76,24 @@ and <or> tests. It doesn't have any attributes and accepts all nested elements of the condition task as nested elements as well.

-

available

+

available

This condition is identical to the Available task, all attributes and nested elements of that task are supported, the property and value attributes are redundant and will be ignored.

-

uptodate

+

uptodate

This condition is identical to the Uptodate task, all attributes and nested elements of that task are supported, the property and value attributes are redundant and will be ignored.

-

os

+

os

Test whether the current operating system is of a given type. Each defined attribute is tested and the result is true only if all the tests succeed.

- +
@@ -137,9 +138,9 @@ the tests succeed.
  • openvms for OpenVMS
  • -

    equals

    +

    equals

    Tests whether the two given values are equal.

    -
    Attribute Description
    +
    @@ -176,9 +177,9 @@ the tests succeed.
    Attribute Description
    -

    isset

    +

    isset

    Test whether a given property has been set in this project.

    - +
    @@ -191,17 +192,17 @@ the tests succeed.
    Attribute Description
    -

    checksum

    +

    checksum

    This condition is identical to the Checksum task, all attributes and nested elements of that task are supported, the property and overwrite attributes are redundant and will be ignored.

    -

    http

    +

    http

    The http condition checks for a valid response from a web server of the specified url. By default, HTTP responses errors of 400 or greater are viewed as invalid.

    - +
    @@ -238,10 +239,10 @@ of 400 or greater are viewed as invalid.

    Attribute Description
    -

    socket

    +

    socket

    The socket condition checks for the existence of a TCP/IP listener at the specified host and port.

    - +
    @@ -259,7 +260,7 @@ TCP/IP listener at the specified host and port.

    Attribute Description
    -

    filesmatch

    +

    filesmatch

    Test two files for matching. Nonexistence of one file results in "false", although if neither exists they are considered equal in terms of content. This test does a byte for byte comparison, so test time scales with @@ -267,7 +268,7 @@ byte size. NB: if the files are different sizes, one of them is missing or the filenames match the answer is so obvious the detailed test is omitted.

    - +
    @@ -287,15 +288,15 @@ or the filenames match the answer is so obvious the detailed test is omitted.
    Attribute Descriptiontextfile Whether to ignore line endings when comparing files; defaults to false which triggers a binary - comparison. Since Ant 1.7 + comparison. Since Ant 1.7 No
    -

    contains

    +

    contains

    Tests whether a string contains another one.

    - +
    @@ -319,10 +320,10 @@ or the filenames match the answer is so obvious the detailed test is omitted.
    Attribute Description
    -

    istrue

    -

    Tests whether a string equals any of the ant definitions of true, +

    istrue

    +

    Tests whether a string equals any of the Ant definitions of true, that is "true","yes", or "on"

    - +
    @@ -339,10 +340,10 @@ that is "true","yes", or "on"

    <istrue value="false"/> -

    isfalse

    +

    isfalse

    Tests whether a string is not true, the negation of <istrue>

    -
    Attribute Description
    +
    @@ -359,14 +360,13 @@ that is "true","yes", or "on"

    <isfalse value="false"/> -

    isreference

    - +

    isreference

    Test whether a given reference has been defined in this project and - optionally - is of an expected type.

    This condition has been added in Apache Ant 1.6.

    -
    Attribute Description
    +
    @@ -385,7 +385,7 @@ that is "true","yes", or "on"

    Attribute Description
    -

    issigned

    +

    issigned

    Test whether a jarfile is signed. If the name of the @@ -397,7 +397,7 @@ that is "true","yes", or "on"

    This condition was added in Apache Ant 1.7.

    - +
    @@ -418,7 +418,7 @@ that is "true","yes", or "on"

    Attribute Description
    -

    isfileselected

    +

    isfileselected

    Test whether a file passes an embedded selector. @@ -426,7 +426,7 @@ that is "true","yes", or "on"

    This condition was added in Apache Ant 1.6.3.

    - +
    @@ -455,7 +455,7 @@ that is "true","yes", or "on"

    </isfileselected> -

    typefound

    +

    typefound

    Test whether a given type is defined, and that its implementation class can be loaded. Types include @@ -463,7 +463,7 @@ tasks, datatypes, scriptdefs, macrodefs and presetdefs.

    This condition was added in Apache Ant 1.7.

    -
    Attribute Description
    +
    @@ -491,7 +491,7 @@ tasks, datatypes, scriptdefs, macrodefs and presetdefs.

    <typefound uri="antlib:org.apache.maven.artifact.ant" name="artifact"/> -

    scriptcondition

    +

    scriptcondition

    Evaluate a condition based on a script in any Apache BSF @@ -506,7 +506,7 @@ an explanation of scripts and dependencies.

    This condition was added in Apache Ant 1.7.

    -
    Attribute Description
    +
    @@ -529,8 +529,8 @@ an explanation of scripts and dependencies. - - + + @@ -585,10 +585,10 @@ Example: </scriptcondition> -Sets the default value of the condition to true, then in the script, +Sets the default value of the condition to true, then in the script, sets the value to false. This condition always evaluates to "false" -

    parsersupports

    +

    parsersupports

    Tests whether Ant's XML parser supports a given feature or property, as per the SAX/JAXP specifications, by @@ -596,7 +596,7 @@ attempting to set the appropriate property/feature/

    This condition was added in Apache Ant 1.7.

    -
    Attribute Description
    value default boolean valueNo -default is "false"
    No - default is "false"
    src filename of script source
    +
    @@ -642,12 +642,12 @@ Check for XML Schema support. Check for Xerces-specific definition of the location of the no namespace schema. -

    isreachable

    +

    isreachable

    -

    Uses Java1.5+ networking APIs to probe for a (remote) system being +

    Uses Java 5+ networking APIs to probe for a (remote) system being reachable. Exactly what probe mechanisms are used is an implementation feature of the JVM. They may include ICMP "ping" packets, UDP or TCP connections -to port 7 "echo service" or other means. On Java1.4 and earlier, being able +to port 7 "echo service" or other means. On Java 1.4 and earlier, being able to resolve the hostname is considered success. This means that if DNS is not working or a URL/hostname is bad, the test will fail, but otherwise succeed even if the remote host is actually absent. @@ -672,7 +672,7 @@ not reachable on other ports (i.e. port 80), because of firewalls. This condition was added in Apache Ant 1.7.

    -
    Attribute Description
    +
    @@ -715,10 +715,10 @@ Probe for the maven repository being reachable. Probe for the maven repository being reachable using the hostname, ten second timeout..

    -

    length

    +

    length

    This condition is a facet of the Length task. It is used to test the length of a string or one or more files. - Since Ant 1.6.3 + Since Ant 1.6.3

    @@ -731,12 +731,12 @@ Probe for the maven repository being reachable using the hostname, ten second ti
     

    Verify that file foo is not empty.

    -

    isfailure

    +

    isfailure

    Test the return code of an executable (see the -Exec task) for failure. Since Ant 1.7

    +Exec task) for failure. Since Ant 1.7

    -
    Attribute Description
    +
    @@ -749,12 +749,12 @@ Probe for the maven repository being reachable using the hostname, ten second ti
    Attribute Description
    -

    resourcecount

    +

    resourcecount

    This condition is a facet of the ResourceCount task. - It is used to test the size of a + It is used to test the size of a resource collection. - Since Ant 1.7 + Since Ant 1.7

    @@ -762,7 +762,7 @@ Probe for the maven repository being reachable using the hostname, ten second ti
     

    Verify that a resource collection is not empty.

    -

    resourcesmatch

    +

    resourcesmatch

    Test resources for matching. Nonexistence of one or more resources results in "false", although if none exists they are considered equal in terms of content. By default this test does a byte for byte comparison, so test time scales with @@ -771,9 +771,9 @@ or the filenames match the answer is so obvious the detailed test is omitted. The resources to check are specified as nested resource collections, meaning that more than two resources can be checked; in this case all resources -must match. Since Ant 1.7 +must match. Since Ant 1.7

    - +
    @@ -789,12 +789,12 @@ must match. Since Ant 1.7
    Attribute Description
    -

    resourcecontains

    +

    resourcecontains

    Tests whether a resource contains a given (sub)string.

    The resources to check are specified via references or - in the - case of file resources via the resource attribute. Since Ant 1.7.1 + case of file resources via the resource attribute. Since Ant 1.7.1

    - +
    @@ -823,15 +823,16 @@ must match. Since Ant 1.7
    Attribute Description
    -

    hasmethod

    +

    hasmethod

    + +

    + Tests for a class having a method or field. If the class is not found + or fails to load, the build fails. -

    Tests for a class having a method or field. If the class is not found - or fails to load, the build fails. - - Since Ant 1.7 + Since Ant 1.7

    - +
    @@ -852,7 +853,7 @@ must match. Since Ant 1.7 - + @@ -871,7 +872,7 @@ must match. Since Ant 1.7
    Attribute Description name of a method to look for one of field or method
    ignoreSystemClasses should system classes be ignored?

    - There is also a nested <classpath> element, which can be used to specify + There is also a nested <classpath> element, which can be used to specify a classpath.

    @@ -880,14 +881,14 @@ must match. Since Ant 1.7
     
     

    Looks for the method trimToSize in the ArrayList class.

    -

    matches

    +

    matches

    Test if the specified string matches the specified regular expression pattern. - Since Ant 1.7

    + Since Ant 1.7

    - +
    @@ -986,18 +987,18 @@ must match. Since Ant 1.7 </au:assertFalse> -

    antversion

    +

    antversion

    This condition is identical to the Antversion task, all attributes are supported, the property attribute is redundant and will be ignored.

    -

    hasfreespace

    +

    hasfreespace

    Tests a partition to see if there is enough space. - Since Ant 1.7.0

    -

    Needed attribute can be specified using standard computing terms:
    + Since Ant 1.7.0

    +

    Needed attribute can be specified using standard computing terms:

    • K : Kilobytes (1024 bytes)
    • M : Megabytes (1024 K)
    • @@ -1005,9 +1006,8 @@ is redundant and will be ignored.

    • T : Terabytes (1024 G)
    • P : Petabytes (1024 T)
    -

    -
    Attribute Description
    +
    @@ -1031,12 +1031,12 @@ is redundant and will be ignored.

    <hasfreespace partition="c:" needed="100M"/> -

    islastmodified

    +

    islastmodified

    Tests the last modified date of a resource. Since Ant 1.8.0

    -
    Attribute Description
    +
    @@ -1081,7 +1081,7 @@ is redundant and will be ignored.

    </islastmodified> -

    resourceexists

    +

    resourceexists

    Tests a resource for existence. since Ant 1.8.0

    @@ -1096,12 +1096,12 @@ is redundant and will be ignored.

    </resourceexists> -

    javaversion

    +

    javaversion

    Tests the version of the JVM executing Ant. Since Ant 1.10.2

    -
    Attribute Description
    +
    @@ -1110,7 +1110,7 @@ is redundant and will be ignored.

    @@ -1118,7 +1118,7 @@ is redundant and will be ignored.

    @@ -1132,7 +1132,7 @@ is redundant and will be ignored.

    <javaversion atleast="9"/> -

    will evaluate to true if the current JVM is Java9 or above.

    +

    will evaluate to true if the current JVM is Java 9 or above.

    diff --git a/manual/Tasks/copy.html b/manual/Tasks/copy.html index d1b8ff2a4..5077327cf 100644 --- a/manual/Tasks/copy.html +++ b/manual/Tasks/copy.html @@ -24,7 +24,7 @@ -

    Copy

    +

    Copy

    Description

    Copies a file or resource collection to a new file or directory. By default, files are only copied if the source file is newer than the destination file, @@ -41,7 +41,7 @@ using a nested mapper (or the flatten attribute) may not be what you expect.

    -Note: If you employ filters in your copy operation, +Note: If you employ filters in your copy operation, you should limit the copy to text files. Binary files will be corrupted by the copy operation. This applies whether the filters are implicitly defined by the @@ -50,7 +50,7 @@ operation as filtersets. See encoding note.

    Parameters

    -
    Attribute Description
    atleast The version that this JVM is at least. - The format is major.minor.point. Starting with Java9 really + The format is major.minor.point. Starting with Java 9 really only the major number is determined. No One of these.
    exactly The version that this JVM is exactly. - The format is major.minor.point. Starting with Java9 really + The format is major.minor.point. Starting with Java 9 really only the major number is determined. No
    +
    @@ -331,8 +331,8 @@ the copied file takes on the case of the original. The workaround is to delete the file in the destination directory before you copy it.

    -

    - Important Encoding Note: +

    + Important Encoding Note: The reason that binary files when filtered get corrupted is that filtering involves reading in the file using a Reader class. This has an encoding specifying how files are encoded. There are a number @@ -369,8 +369,6 @@ the file in the destination directory before you copy it. Another trick is to change the LANG environment variable from something like "us.utf8" to "us".

    - - - - + + diff --git a/manual/Tasks/copydir.html b/manual/Tasks/copydir.html index 9e9e60e1c..564d6477b 100644 --- a/manual/Tasks/copydir.html +++ b/manual/Tasks/copydir.html @@ -24,7 +24,7 @@ -

    Copydir

    +

    Copydir

    Deprecated

    This task has been deprecated. Use the Copy task instead.

    Description

    @@ -44,7 +44,7 @@ supports most attributes of <fileset><include>, <exclude> and <patternset> elements.

    Parameters

    -
    Attribute Description
    +
    @@ -112,14 +112,12 @@ supports most attributes of <fileset>
    Attribute Description

    Examples

      <copydir src="${src}/resources"
    -           dest="${dist}"
    -  />
    + dest="${dist}"/>

    copies the directory ${src}/resources to ${dist}.

      <copydir src="${src}/resources"
                dest="${dist}"
                includes="**/*.java"
    -           excludes="**/Test.java"
    -  />
    + excludes="**/Test.java"/>

    copies the directory ${src}/resources to ${dist} recursively. All java files are copied, except for files with the name Test.java.

      <copydir src="${src}/resources"
    @@ -130,7 +128,5 @@ recursively. All java files are copied, except for files with the name Tes
     recursively. All java files are copied, except for the files under the mypackage/test
     directory.

    - - diff --git a/manual/Tasks/copyfile.html b/manual/Tasks/copyfile.html index e204a7e67..80306ae31 100644 --- a/manual/Tasks/copyfile.html +++ b/manual/Tasks/copyfile.html @@ -24,7 +24,7 @@ -

    Copyfile

    +

    Copyfile

    Deprecated

    This task has been deprecated. Use the Copy task instead.

    Description

    @@ -32,7 +32,7 @@ the source file is newer than the destination file, or when the destination file does not exist.

    Parameters

    - +
    @@ -67,7 +67,5 @@ does not exist.

    <copyfile src="${src}/index.html" dest="${dist}/help/index.html"/>

    - - diff --git a/manual/Tasks/cvs.html b/manual/Tasks/cvs.html index e941ed6d4..98d8f9888 100644 --- a/manual/Tasks/cvs.html +++ b/manual/Tasks/cvs.html @@ -24,7 +24,7 @@ -

    Cvs

    +

    Cvs

    Description

    Handles packages/modules retrieved from a CVS repository.

    @@ -45,7 +45,7 @@ href="http://issues.apache.org/bugzilla/show_bug.cgi?id=21657#c5">bugzilla report 21657 for recommended workarounds.

    Parameters

    -
    Attribute Description
    +
    @@ -163,7 +163,7 @@ report 21657 for recommended workarounds.

    modules specified using this attribute can contain spaces in their name.

    -
    Attribute Description
    +
    @@ -179,8 +179,7 @@ report 21657 for recommended workarounds.

    Examples

      <cvs cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic"
            package="ant"
    -       dest="${ws.dir}"
    -  />
    + dest="${ws.dir}"/>

    checks out the package/module "ant" from the CVS repository pointed to by the cvsRoot attribute, and stores the files in "${ws.dir}".

      <cvs dest="${ws.dir}" command="update"/>
    @@ -211,7 +210,7 @@ or: </cvs>

    -You may include as many <commandline> elements as you like. +You may include as many <commandline> elements as you like. Each will inherit the failonerror, compression, and other "global" parameters from the <cvs> element.

    @@ -224,7 +223,5 @@ before the command, and any command options should appear after the command as i above. See the cvs manual for details, specifically the Guide to CVS commands

    - - diff --git a/manual/Tasks/cvspass.html b/manual/Tasks/cvspass.html index 185dde794..f0890a3a3 100644 --- a/manual/Tasks/cvspass.html +++ b/manual/Tasks/cvspass.html @@ -24,7 +24,7 @@ -

    cvspass

    +

    cvspass

    Description

    Adds entries to a .cvspass file. Adding entries to this file has the same affect as a cvs login command.

    @@ -36,7 +36,7 @@ href="http://issues.apache.org/bugzilla/show_bug.cgi?id=21657#c5">bug zilla report 21657 for recommended workarounds.

    Parameters

    -
    Attribute Description
    +
    @@ -60,11 +60,8 @@ zilla report 21657 for recommended workarounds.

    Attribute Description

    Examples

      <cvspass cvsroot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic"
    -       password="anoncvs"
    -  />
    + password="anoncvs"/>

    Adds an entry into the ~/.cvspass password file.

    - - diff --git a/manual/Tasks/cvstagdiff.html b/manual/Tasks/cvstagdiff.html index 5350d8efc..36242f8dc 100644 --- a/manual/Tasks/cvstagdiff.html +++ b/manual/Tasks/cvstagdiff.html @@ -21,10 +21,10 @@ CvsTagDiff Task -

    CvsTagDiff

    +

    CvsTagDiff

    Description

    Generates an XML-formatted report file of the changes between two tags or dates recorded in a -CVS repository.

    +CVS repository.

    Important: This task needs "cvs" on the path. If it isn't, you will get an error (such as error 2 on windows). If <cvs> doesn't work, try to execute cvs.exe from the command line in the target directory in which you are working. @@ -34,7 +34,7 @@ for certain other cvs clients - like CVSNT for example - and some operation may fail when using such an incompatible client.

    Parameters

    - +
    @@ -77,7 +77,7 @@ operation may fail when using such an incompatible client.
    Attribute Description

    Parameters inherited from the cvs task

    - +
    @@ -107,8 +107,6 @@ operation may fail when using such an incompatible client. Use a nested <module> element if you want to specify a module with spaces in its name. - - @@ -141,7 +139,7 @@ operation may fail when using such an incompatible client. modules specified using this attribute can contain spaces in their name.

    -
    Attribute Description No
    Yes
    quiet
    +
    @@ -159,8 +157,7 @@ operation may fail when using such an incompatible client. destfile="tagdiff.xml" package="ant" startTag="ANT_14" - endTag="ANT_141" - /> + endTag="ANT_141"/>

    Generates a tagdiff report for all the changes that have been made in the ant module between the tags ANT_14 and ANT_141. @@ -170,8 +167,7 @@ It writes these changes into the file tagdiff.xml.

    destfile="tagdiff.xml" package="ant" startDate="2002-01-01" - endDate="2002-31-01" - /> + endDate="2002-31-01"/>

    Generates a tagdiff report for all the changes that have been made in the ant module in january 2002. In this example cvsRoot @@ -183,8 +179,7 @@ It writes these changes into the file tagdiff.xml.

    destfile="tagdiff.xml" package="ant jakarta-gump" startDate="2003-01-01" - endDate="2003-31-01" - /> + endDate="2003-31-01"/>

    Generates a tagdiff report for all the changes that have been made in the ant and jakarta-gump modules in january 2003. @@ -194,13 +189,13 @@ from a folder stored in cvs. It writes these changes into the file tagdiff.xml.

    Generate Report

    -

    Ant includes a basic XSLT stylesheet that you can use to generate +

    Ant includes a basic XSLT stylesheet that you can use to generate a HTML report based on the xml output. The following example illustrates how to generate a HTML report from the XML report.

    -        <style in="tagdiff.xml" 
    -               out="tagdiff.html" 
    +        <style in="tagdiff.xml"
    +               out="tagdiff.html"
                    style="${ant.home}/etc/tagdiff.xsl">
               <param name="title" expression="Ant Diff"/>
               <param name="module" expression="ant"/>
    @@ -210,19 +205,19 @@ how to generate a HTML report from the XML report.

    Output

    -The cvsroot and package attributes of the tagdiff element are new in ant 1.6.
    -Notes on entry attributes : -

    Attribute Description
    +The cvsroot and package attributes of the tagdiff element are new in Ant 1.6.
    +Notes on entry attributes: +

    +
    AttributeComment
    namewhen reporting on one package, the package name is removed from the output
    revisionsupplied for files which exist at the end of the reporting period
    prevrevisionsupplied for files which exist at the beginning of the reporting period.
    Old CVS servers do not supply it for deleted files. CVS 1.12.2 supplies it.
    -

     <?xml version="1.0" encoding="UTF-8"?>
    -<tagdiff startTag="ANT_14" endTag="ANT_141" 
    +<tagdiff startTag="ANT_14" endTag="ANT_141"
     cvsroot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" package="ant">
       <entry>
         <file>
    @@ -234,8 +229,5 @@ cvsroot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" package=&quo
     </tagdiff>
     
    - - - diff --git a/manual/Tasks/cvsversion.html b/manual/Tasks/cvsversion.html index 09e7cee13..777094fdf 100644 --- a/manual/Tasks/cvsversion.html +++ b/manual/Tasks/cvsversion.html @@ -24,14 +24,14 @@ -

    CvsVersion

    +

    CvsVersion

    Description

    This task allows to retrieve a CVS client and server version. Since Apache Ant 1.6.1.

    Parameters

    - +
    @@ -96,13 +96,9 @@ This task allows to retrieve a CVS client and server version.
      <cvsversion cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic"
            passfile="/home/myself/.cvspass"
            serverversionproperty="apachecvsversion"
    -       clientversionproperty="localcvsversion"
    -  />
    + clientversionproperty="localcvsversion"/>

    finds out the cvs client and server versions and stores the versions in the properties called apachecvsversion and localcvsversion

    - - - diff --git a/manual/Tasks/defaultexcludes.html b/manual/Tasks/defaultexcludes.html index 5511b9016..42a6c458e 100644 --- a/manual/Tasks/defaultexcludes.html +++ b/manual/Tasks/defaultexcludes.html @@ -24,7 +24,7 @@ -

    DefaultExcludes

    +

    DefaultExcludes

    since Apache Ant 1.6

    @@ -33,7 +33,7 @@ build, and prints out the current default excludes if desired.

    Parameters

    -
    Attribute Description
    +
    @@ -86,10 +86,10 @@ backup files and then restore normal behavior

    Notes

    -By default the pattern **/.svn and **/.svn/** are set as default -excludes. With version 1.3 Subversion supports the +By default the pattern **/.svn and **/.svn/** are set as default +excludes. With version 1.3 Subversion supports the "_svn hack". -That means, that the svn-libraries evaluate environment variables and use .svn +That means, that the svn-libraries evaluate environment variables and use .svn or _svn directory regarding to that value. We had chosen not to evaluate environment variables to get a more reliable build. Instead you have to change the settings by yourself by changing the exclude patterns: @@ -100,8 +100,5 @@ the exclude patterns: <defaultexcludes add="**/_svn/**"/> - - - diff --git a/manual/Tasks/delete.html b/manual/Tasks/delete.html index 635b10f1d..2a2ecbf1a 100644 --- a/manual/Tasks/delete.html +++ b/manual/Tasks/delete.html @@ -24,7 +24,7 @@ -

    Delete

    +

    Delete

    Description

    Deletes a single file, a specified directory and all its files and subdirectories, or a set of files specified by one or more @@ -53,7 +53,7 @@ in Directory-based Tasks, and see the control, use a nested <fileset>.

    Parameters

    -
    Attribute Description
    +
    @@ -84,7 +84,7 @@ in Directory-based Tasks, and see the - + @@ -219,10 +219,8 @@ and any subdirectories.

    </delete>

    deletes the subversion metadata directories under src. Because .svn -is on of the default excludes you have to use the +is on of the default excludes you have to use the defaultexcludes flag, otherwise Ant wont delete these directories and the files in it.

    - - diff --git a/manual/Tasks/deltree.html b/manual/Tasks/deltree.html index 98adf4f55..eeb976fc7 100644 --- a/manual/Tasks/deltree.html +++ b/manual/Tasks/deltree.html @@ -24,13 +24,13 @@ -

    Deltree

    +

    Deltree

    Deprecated

    This task has been deprecated. Use the Delete task instead.

    Description

    Deletes a directory with all its files and subdirectories.

    Parameters

    -
    Attribute Description
    verbose Whether to show the name of each deleted file.No, default "false"No, default "false"
    quiet
    +
    @@ -50,7 +50,5 @@ subdirectories.

    deletes the directory ${dist}, including its files and subdirectories.

    - - diff --git a/manual/Tasks/depend.html b/manual/Tasks/depend.html index a0943197b..c30109d90 100644 --- a/manual/Tasks/depend.html +++ b/manual/Tasks/depend.html @@ -36,79 +36,90 @@ respect to their source and then removing the class files of any other classes which depend on the out-of-date classes.

    -

    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 -any way but relies upon the class references encoded into the class files by the +

    +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 +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.

    -To learn more about how this information is obtained from the class files, +To learn more about how this information is obtained from the class files, please refer to the Java Virtual Machine Specification

    -

    Since a class' dependencies only change when the class itself changes, the -depend task is able to cache dependency information. Only those class files -which have changed will have their dependency information re-analysed. Note that -if you change a class' dependencies by changing the source, it will be -recompiled anyway. You can examine the dependency files created to understand -the dependencies of your classes. Please do not rely, however, on the format of -the information, as it may change in a later release.

    - -

    Once depend discovers all of the class dependencies, it "inverts" -this relation to determine, for each class, which other classes are dependent -upon it. This "affects" list is used to discover which classes are -invalidated by the out of date class. The class files of the invalidated -classes are removed, triggering the compilation of the affected classes.

    - -

    The depend task supports an attribute, "closure" which controls -whether depend will only consider direct class-class relationships or whether it -will also consider transitive, indirect relationships. For example, say there -are three classes, A, which depends on B, which in-turn depend on C. Now say -that class C is out of date. Without closure, only class B would be removed by -depend. With closure set, class A would also be removed. Normally direct -relationships are sufficient - it is unusual for a class to depend on another -without having a direct relationship. With closure set, you will notice that -depend typically removes far more class files.

    - -

    The classpath attribute for <depend> is optional. If it is present, +

    +Since a class' dependencies only change when the class itself changes, the +depend task is able to cache dependency information. Only those class files +which have changed will have their dependency information re-analysed. Note that +if you change a class' dependencies by changing the source, it will be +recompiled anyway. You can examine the dependency files created to understand +the dependencies of your classes. Please do not rely, however, on the format of +the information, as it may change in a later release. +

    + +

    +Once depend discovers all of the class dependencies, it "inverts" +this relation to determine, for each class, which other classes are dependent +upon it. This "affects" list is used to discover which classes are +invalidated by the out of date class. The class files of the invalidated +classes are removed, triggering the compilation of the affected classes. +

    + +

    +The depend task supports an attribute, "closure" which controls +whether depend will only consider direct class-class relationships or whether it +will also consider transitive, indirect relationships. For example, say there +are three classes, A, which depends on B, which in-turn depend on C. Now say +that class C is out of date. Without closure, only class B would be removed by +depend. With closure set, class A would also be removed. Normally direct +relationships are sufficient - it is unusual for a class to depend on another +without having a direct relationship. With closure set, you will notice that +depend typically removes far more class files. +

    + +

    The classpath attribute for <depend> is optional. If it is present, depend will check class dependencies against classes and jars on this classpath. -Any classes which depend on an element from this classpath and which are older -than that element will be deleted. A typical example where you would use this -facility would be where you are building a utility jar and want to make sure +Any classes which depend on an element from this classpath and which are older +than that element will be deleted. A typical example where you would use this +facility would be where you are building a utility jar and want to make sure classes which are out of date with respect to this jar are rebuilt. You should -not include jars in this classpath which you do not expect to change, -such as the JDK runtime jar or third party jars, since doing so will just slow -down the dependency check. This means that if you do use a classpath for the -depend task it may be different from the classpath necessary to actually +not include jars in this classpath which you do not expect to change, +such as the JDK runtime jar or third party jars, since doing so will just slow +down the dependency check. This means that if you do use a classpath for the +depend task it may be different from the classpath necessary to actually compile your code.

    -

    Performance

    +

    Performance

    -

    The performance of the depend task is dependent on a -number of factors such as class relationship complexity and how many class files -are out of date. The decision about whether it is cheaper to just recompile all -classes or to use the depend task will depend on the size of your project and -how interrelated your classes are.

    +

    +The performance of the depend task is dependent on a +number of factors such as class relationship complexity and how many class files +are out of date. The decision about whether it is cheaper to just recompile all +classes or to use the depend task will depend on the size of your project and +how interrelated your classes are. +

    Limitations

    -

    There are some source dependencies which depend will not detect.

    +

    +There are some source dependencies which depend will not detect. +

      -
    • If the Java compiler optimizes away a class relationship, - there can be a source dependency without a class dependency.
    • - +
    • If the Java compiler optimizes away a class relationship, + there can be a source dependency without a class dependency.
    • +
    • Non public classes cause two problems. Firstly depend cannot relate the class file to a source file. In the future this may be addressed - using the source file attribute in the classfile. Secondly, neither + using the source file attribute in the classfile. Secondly, neither depend nor the compiler tasks can detect when a non public class is missing. Inner classes are handled by the depend task.
    The most obvious example of these limitations is that the task can't tell -which classes to recompile when a constant primitive data type exported +which classes to recompile when a constant primitive data type exported by other classes is changed. For example, a change in the definition of something like
    @@ -118,7 +129,7 @@ public final class Constants {
     
    will not be picked up by other classes.

    Parameters

    -
    Attribute Description
    +
    @@ -141,7 +152,7 @@ will be analysed. If this is not present, the srcdir is used. +use a cache @@ -154,8 +165,7 @@ classes. Defaults to false - + @@ -167,13 +177,13 @@ classes. Defaults to false + classes, and which have no .java source. Useful when doing rmi development.
    Attribute Description cache This is a directory in which depend can store and retrieve dependency information. If this is not present, depend will not -use a cache No
    dumpIf true the dependency information will be written to the debug level log - If true the dependency information will be written to the debug level log No
    warnOnRmiStubs Flag to disable warnings about files that look like rmic generated stub/skeleton - classes, and which have no .java source. Useful when doing rmi development. No, default=true

    Parameters specified as nested elements

    -

    The depend task's classpath attribute is a +

    The depend task's classpath attribute is a PATH-like structure and can also be set via a nested <classpath> element.

    @@ -192,11 +202,12 @@ as well as the nested <include>, closure="yes"/>

    removes any classes in the ${build.classes} directory -that depend on out-of-date classes. Classes are considered out-of-date with +that depend on out-of-date classes. Classes are considered out-of-date with respect to the source in the ${java.dir} directory, using the same mechanism as the <javac> task. In this example, the -<depend> task caches its dependency -information in the depcache directory.

    +<depend> task caches its dependency +information in the depcache directory. +

     <depend srcdir="${java.dir}" destdir="${build.classes}"
    @@ -209,8 +220,5 @@ information in the depcache directory. 

    .java files, except those that match the list given in ${java.dir}/build_excludes.

    - - - diff --git a/manual/Tasks/dependset.html b/manual/Tasks/dependset.html index 34ec238b1..0f6099e60 100644 --- a/manual/Tasks/dependset.html +++ b/manual/Tasks/dependset.html @@ -59,7 +59,7 @@ well as other stylesheets imported by the main stylesheet.

    Parameters

    - +
    @@ -97,7 +97,7 @@ filelists. Multiple <srcfileset> filesets may be specified.

    The nested <srcfilelist> element specifies a FileList. All files included in -this filelist will be compared against all files included in all of the +this filelist will be compared against all files included in all of the <targetfileset> filesets and <targetfilelist> filelists. Multiple <srcfilelist> filelists may be specified.

    @@ -146,11 +146,11 @@ Multiple <targetfilelist> filelists may be specified. <targetfileset dir = "${output.dir}" includes = "**/*.html"/> - </dependset> + </dependset> -

    -In this example derived HTML files in the ${output.dir} directory +

    +In this example derived HTML files in the ${output.dir} directory will be removed if any are out-of-date with respect to:

    1. the DTD of their source XML files
    2. @@ -165,7 +165,5 @@ target files will also be removed. To ignore missing sources instead, use filesets instead of filelists for the sources.

      - - diff --git a/manual/Tasks/diagnostics.html b/manual/Tasks/diagnostics.html index cdb16930d..710b32ff5 100644 --- a/manual/Tasks/diagnostics.html +++ b/manual/Tasks/diagnostics.html @@ -24,15 +24,14 @@ -

      Diagnostics

      -

      Diagnostics

      +

      Diagnostics

      +

      Description

      -Runs Apache Ant's -diagnostics code inside Ant itself. This is good for -debugging Ant's configuration under an IDE. +Runs Apache Ant's -diagnostics code inside Ant itself. This is good for +debugging Ant's configuration under an IDE. Since Ant 1.7.0

      -

      Examples

      @@ -44,6 +43,5 @@ debugging Ant's configuration under an IDE.
           Prints out the current diagnostics dump.
       

      - diff --git a/manual/Tasks/dirname.html b/manual/Tasks/dirname.html index 03227b462..fdef3605a 100644 --- a/manual/Tasks/dirname.html +++ b/manual/Tasks/dirname.html @@ -24,12 +24,12 @@ -

      Dirname

      +

      Dirname

      Description

      Task to determine the directory path of a specified file.

      -

      +

      When this task executes, it will set the specified property to the value of the specified file (or directory) up to, but not including, the last path element. If the specified file is a path that ends in a @@ -42,7 +42,7 @@ a filename, the directory will be the current directory. determines the full directory path of the specified file.

      Parameters

      -
    Attribute Description
    +
    @@ -65,10 +65,7 @@ a filename, the directory will be the current directory. will set antfile.dir to the directory path for ${ant.file}.
      <dirname property="foo.dirname" file="foo.txt"/>
    -will set foo.dirname to the project's basedir.

    - - +will set foo.dirname to the project's basedir. - diff --git a/manual/Tasks/ear.html b/manual/Tasks/ear.html index de4a96260..c3adb56e1 100644 --- a/manual/Tasks/ear.html +++ b/manual/Tasks/ear.html @@ -24,11 +24,11 @@ -

    Ear

    +

    Ear

    Description

    An extension of the Jar task with special treatment for files that should end up in an Enterprise Application archive.

    -

    (The Ear task is a shortcut for specifying the particular layout of a EAR file. +

    (The Ear task is a shortcut for specifying the particular layout of a EAR file. The same thing can be accomplished by using the prefix and fullpath attributes of zipfilesets in a Zip or Jar task.)

    The extended zipfileset element from the zip task (with attributes prefix, fullpath, and src) is available in the Ear task.

    @@ -40,7 +40,7 @@ to avoid this behavior you must set the duplicate attribute to a value other than its default, "add".

    Parameters

    -
    Attribute Description
    +
    @@ -146,9 +146,9 @@ to a value other than its default, "add".

    -
    Attribute Description
    indexwhether to create an index - list to speed up classloading. This is a JDK 1.3+ specific + whether to create an index + list to speed up classloading. This is a JDK 1.3+ specific feature. Unless you specify additional jars with nested indexjars elements, only the contents of this jar will be included in the index. Defaults to @@ -294,8 +294,5 @@ These are inherited from <jar> </ear> - - - diff --git a/manual/Tasks/echo.html b/manual/Tasks/echo.html index bcf804ec1..57371e3bc 100644 --- a/manual/Tasks/echo.html +++ b/manual/Tasks/echo.html @@ -24,7 +24,7 @@ -

    Echo

    +

    Echo

    Description

    Echoes a message to the current loggers and listeners which means System.out unless overridden. A level @@ -35,7 +35,7 @@ The task can also echo to a file, in which case the option to append rather than overwrite the file is available, and the level option is ignored

    Parameters

    - +
    @@ -45,7 +45,7 @@ ignored

    @@ -136,7 +136,7 @@ ignored: - + @@ -184,10 +184,5 @@ ignored:
    Attribute Description message the message to echo. No. Text may also be included in a - character section within this element. If neither is included a + character section within this element. If neither is included a blank line will be emitted in the output.
    Ant-Statement -quiet, -qno statementno statement -verbose, -v -debug, -d
    - - - - - diff --git a/manual/Tasks/echoproperties.html b/manual/Tasks/echoproperties.html index ec1e4b44e..31a260573 100644 --- a/manual/Tasks/echoproperties.html +++ b/manual/Tasks/echoproperties.html @@ -24,7 +24,7 @@ -

    echoproperties

    +

    echoproperties

    Description

    Displays all the current properties (or a subset of them specified @@ -35,7 +35,7 @@ somewhat contrived means of returning data from an files.

    Parameters

    - +
    @@ -54,7 +54,6 @@ files.

    @@ -66,7 +65,7 @@ files.

    only those properties whose names match it will be echoed. - +
    Attribute Description a prefix which is used to filter the properties only those properties starting with this prefix will be echoed. -

    No
    No
    failonerror By default, the "failonerror" attribute is enabled. @@ -139,8 +138,5 @@ The equivalent snippet with </propertyset> is:

    </echoproperties> - - - diff --git a/manual/Tasks/echoxml.html b/manual/Tasks/echoxml.html index 74cbf7fb6..9569b1452 100644 --- a/manual/Tasks/echoxml.html +++ b/manual/Tasks/echoxml.html @@ -28,7 +28,7 @@

    Description

    Echo nested XML to the console or a file. Since Apache Ant 1.7

    Parameters

    - +
    @@ -71,4 +71,3 @@ Nested XML content is required. - diff --git a/manual/Tasks/ejb.html b/manual/Tasks/ejb.html index f5544983c..5eb6c3f2a 100644 --- a/manual/Tasks/ejb.html +++ b/manual/Tasks/ejb.html @@ -39,25 +39,25 @@
  • Rob van Oostrum(rob@springwellfarms.ca)
  • -
    +

    Table of Contents

    -
    -

    Introduction

    +
    +

    Introduction

    Ant provides a number of optional tasks for developing 1.x and 2.x Enterprise Java Beans (EJBs). In general these tasks are specific to the particular vendor's EJB Server.

    -

    The tasks support:
    +

    The tasks support:

      -
    • Borland +
    • Borland Application Server 4.5
    • -
    • iPlanet +
    • iPlanet Application Server 6.0
    • JBoss 2.1 and above EJB servers
    • @@ -69,6 +69,7 @@ In general these tasks are specific to the particular vendor's EJB Server.

      2.4.x and 2.5 Open Source EJB server
    • IBM WebSphere 4.0
    +

    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. Accordingly, development of these tasks is effectively frozen. Bug reports @@ -77,9 +78,9 @@ In general these tasks are specific to the particular vendor's EJB Server.

    and definitely not new EJB2.x servers.

    -
    -

    EJB Tasks

    -
    Attribute Description
    +
    +

    EJB Tasks

    +
    @@ -94,8 +95,8 @@ In general these tasks are specific to the particular vendor's EJB Server.

    TaskApplication Servers
    blgenclientBorland Application Server 4.5 and 5.x
    iplanet-ejbciPlanet Application Server 6.0
    -
    -

    ddcreator

    +
    +

    ddcreator

    Description:

    ddcreator will compile a set of Weblogic text-based deployment descriptors into a serialized EJB deployment descriptor. The selection of which of the text-based descriptors are to be compiled @@ -103,7 +104,7 @@ is based on the standard Ant include and exclude selection mechanisms.

    Parameters:

    - +
    @@ -135,8 +136,8 @@ is based on the standard Ant include and exclude selection mechanisms. </ddcreator> -
    -

    ejbc

    +
    +

    ejbc

    Description:

    The ejbc task will run Weblogic's ejbc tool. This tool will take a serialized deployment descriptor, examine the various EJB interfaces and bean classes and then generate the required support classes @@ -144,9 +145,9 @@ necessary to deploy the bean in a Weblogic EJB container. This will include the as well as the classes which implement the bean's home and remote interfaces.

    The ant task which runs this tool is able to compile several beans in a single operation. The beans to be -compiled are selected by including their serialized deployment descriptors. The standard ant +compiled are selected by including their serialized deployment descriptors. The standard Ant include and exclude constructs can be used to select the deployment descriptors -to be included.

    +to be included.

    Each descriptor is examined to determine whether the generated classes are out of date and need to be regenerated. The deployment descriptor is de-serialized to discover the home, remote and @@ -155,7 +156,7 @@ modification times. These times and the modification time of the serialized desc compared with the modification time of the generated classes. If the generated classes are not present or are out of date, the ejbc tool is run to generate new versions.

    Parameters:

    -
    Attribute Description
    +
    @@ -208,9 +209,8 @@ or are out of date, the ejbc tool is run to generate new versions.

    </ejbc> -
    -

    -iplanet-ejbc

    +
    +

    iplanet-ejbc

    Description:

    @@ -231,7 +231,7 @@ and skeletons.

    Parameters:

    -
    Attribute Description
    +
    @@ -281,7 +281,7 @@ Nested "classpath" elements may also be used. +source files will be retained. If omitted, it defaults to "no". @@ -291,7 +291,7 @@ source files will be retained. If omitted, it defaults to "no". +will be generated. If omitted, it defaults to "no". +directory. If omitted, the ejbc utility must be on the user's system path. @@ -331,21 +331,19 @@ Examples <pathelement path="${build.classpath}"/> </classpath> </iplanet-ejbc> - - -
    -

    wlrun

    +
    +

    wlrun

    Description:

    The wlrun task is used to start a weblogic server. The task runs a weblogic instance in a separate Java Virtual Machine. A number of parameters are used to control the operation of the weblogic instance. Note that the task, -and hence ant, will not complete until the weblogic instance is stopped.

    +and hence Ant, will not complete until the weblogic instance is stopped.

    Parameters:

    -
    Attribute Indicates whether or not the Java source files which are generated by ejbc will be saved or automatically deleted. If "yes", the -source files will be retained. If omitted, it defaults to "no". No
    Indicates whether or not the ejbc utility should log additional debugging statements to the standard output. If "yes", the additional debugging statements -will be generated. If omitted, it defaults to "no".
    No
    @@ -304,7 +304,7 @@ will be generated. If omitted, it defaults to "no".
    May be used to specify the "home" directory for this iAS installation. This is used to find the ejbc utility if it isn't included in the user's system path. If specified, it should refer to the "[install-location]/iplanet/ias6/ias" -directory. If omitted, the ejbc utility must be on the user's system path. No
    +
    @@ -476,21 +474,21 @@ Weblogic 6.0

    beahome="${bea.home}"/> -
    -

    wlstop

    +
    +

    wlstop

    Description:

    The wlstop task is used to stop a weblogic instance which is currently running. To shut down an instance you must supply both a username and a password. These will be stored in the clear in the build script used to stop the instance. For security reasons, this task is therefore only appropriate in a -development environment.

    +development environment.

    This task works for most version of Weblogic, including 6.0. You need to specify the BEA Home to have this task work correctly under 6.0

    Parameters:

    -
    Attribute Description
    +
    @@ -547,16 +545,15 @@ specify the BEA Home to have this task work correctly under 6.0

    beahome="${bea.home}"/> -
    - -

    ejbjar

    +
    +

    ejbjar

    Description:

    This task is designed to support building of EJB jar files (EJB 1.1 & 2.0). Support is currently provided for 'vanilla' EJB jar files - i.e. those containing only the user generated class files and the standard deployment descriptor. Nested elements provide support for vendor specific deployment tools. These currently -include:

    +include:

    • Borland Application Server 4.5
    • iPlanet Application Server 6.0
    • @@ -584,7 +581,7 @@ interfaces. These will be added to the generated jar.

      simply generate a generic EJB jar. Such jars are typically used as the input to vendor-specific deployment tools. For each nested deployment element, a vendor specific deployment tool is run to generate a jar file ready for deployment in -that vendor's EJB container.

      +that vendor's EJB container.

      The jar files are only built if they are out of date. Each deployment tool element will examine its target jar file and determine if it is out of date with @@ -606,10 +603,10 @@ Ejbjar handles the processing of multiple beans, and it uses a set of naming conventions to determine the name of the generated EJB jars. The naming convention that is used is controlled by the "naming" attribute. It supports the following values -

        +
        -
      • descriptor
      • -

        This is the default naming scheme. The name of the generated bean is derived from the +

        descriptor
        +

        This is the default naming scheme. The name of the generated bean is derived from the name of the deployment descriptor. For an Account bean, for example, the deployment descriptor would be named Account-ejb-jar.xml. Vendor specific descriptors are located using the same naming convention. The weblogic bean, for example, would be named @@ -619,29 +616,29 @@ is deployed in separate beans.

        This scheme is useful when you are using one bean per EJB jar and where you may be -deploying the same bean classes in different beans, with different deployment characteristics. + deploying the same bean classes in different beans, with different deployment characteristics.

        -
      • ejb-name
      • -

        This naming scheme uses the <ejb-name> element from the deployment descriptor to +

        ejb-name
        +

        This naming scheme uses the <ejb-name> element from the deployment descriptor to determine the bean name. In this situation, the descriptors normally use the generic descriptor names, such as ejb-jar.xml along with any associated vendor specific descriptor names. For example, If the value of the <ejb-name> were to be given in the deployment descriptor -as follows: -

        -<ejb-jar>
        +as follows:

        +
        <ejb-jar>
             <enterprise-beans>
                 <entity>
                     <ejb-name>Sample</ejb-name>
                     <home>org.apache.ant.ejbsample.SampleHome</home>
         
        - +

        then the name of the generated bean would be Sample.jar

        -

        This scheme is useful where you want to use the standard deployment descriptor names, which may be more -compatible with other EJB tools. This scheme must have one bean per jar. -

        -
      • directory
      • +This scheme is useful where you want to use the standard deployment descriptor names, which may be more +compatible with other EJB tools. This scheme must have one bean per jar. +

        +
        directory
        +

        In this mode, the name of the generated bean jar is derived from the directory containing the deployment descriptors. Again the deployment descriptors typically use the standard filenames. For example, if the path to the deployment descriptor is @@ -652,10 +649,10 @@ bean will be named sample.jar This scheme is also useful when you want to use standard style descriptor names. It is often most useful when the descriptors are located in the same directory as the bean source code, although that is not mandatory. This scheme can handle multiple beans per jar. -

        +

        -
      • basejarname
      • -

        +

        basejarname
        +

        The final scheme supported by the <ejbjar> task is used when you want to specify the generated bean jar name directly. In this case the name of the generated jar is specified by the "basejarname" attribute. Since all generated beans will have the same name, this task should @@ -666,11 +663,11 @@ be only used when each descriptor is in its own directory. This scheme is most appropriate when you are using multiple beans per jar and only process a single deployment descriptor. You typically want to specify the name of the jar and not derive it from the beans in the jar. -

        +

        -
      + -

      Dependencies

      +

      Dependencies

      In addition to the bean classes, ejbjar is able to ad additional classes to the generated ejbjar. These classes are typically the support classes which are used by the bean's classes or as parameters to the bean's methods.

      @@ -681,7 +678,7 @@ classes had to be loaded into Ant's JVM. This was not always possible due to cla

      The ejbjar task in Ant releases 1.5 and later uses the - BCEL library +BCEL library to analyze the bean's class files directly, rather than loading them into the JVM. This also allows ejbjar to add all of the required support classes for a bean and not just super classes. @@ -699,12 +696,12 @@ behaviour where super classes and super interfaces are added to the jar are added to the jar

    The super and full values require the - BCEL library +BCEL library to be available. If it is not, ejbjar will drop back to the behaviour corresponding to the value none.

    Parameters:

    -
    Attribute Description
    +
    @@ -819,7 +816,7 @@ the value none.

    Nested Elements

    In addition to the vendor specific nested elements, the ejbjar task provides -three nested elements.

    +three nested elements.

    Classpath

    @@ -827,7 +824,7 @@ three nested elements.

    to be set. It is useful when setting the classpath from a reference path. In all other respects the behaviour is the same as the classpath attribute.

    -

    dtd

    +

    dtd

    The <dtd> element is used to specify the local location of DTDs to be used when parsing the EJB deployment descriptor. Using a local DTD is much @@ -840,7 +837,7 @@ available in the classpath when Ant is started. If your want to run Ant without requiring the vendor classes in the classpath, you would need to use a <dtd> element.

    -
    Attribute Description
    +
    @@ -877,24 +874,23 @@ specific to that vendor's EJB container. The parameters for each supported deployment element are detailed here. -

    Jboss element

    +

    Jboss element

    The jboss element searches for the JBoss specific deployment descriptors and adds them -to the final ejb jar file. JBoss has two deployment descriptors: +to the final ejb jar file. JBoss has two deployment descriptors:

    • jboss.xml
    • for container manager persistence:
      -
    Attribute Description
    +
    CMP versionFile name
    CMP 1.0jaws.xml
    CMP 2.0jbosscmp-jdbc.xml
    -
    -. The JBoss server uses hot deployment and does +

    The JBoss server uses hot deployment and does not require compilation of additional stubs and skeletons.

    - +
    @@ -905,7 +901,7 @@ not require compilation of additional stubs and skeletons.

    + descriptordir namespace. @@ -934,7 +930,7 @@ not require compilation of additional stubs and skeletons.

    Attribute Description The base directory into which the generated weblogic ready jar files are deposited. Jar files are deposited in directories corresponding to their location within the - descriptordir namespace. Yes
    -

    Weblogic element

    +

    Weblogic element

    The weblogic element is used to control the weblogic.ejbc compiler for generating weblogic EJB jars. Prior to Ant 1.3, the method of locating CMP @@ -957,7 +953,7 @@ determining CMP descriptors, you will need to update your weblogic deployment descriptor's <type-storage> element. In the above example, you would define this as META-INF/Customer-weblogic-cmp-rdbms-jar.xml.

    - +
    @@ -968,7 +964,7 @@ define this as META-INF/Customer-weblogic-cmp-rdbms-jar.xml.

    + descriptordir namespace. @@ -1153,7 +1149,7 @@ weblogic element, as long as the newCMP attribute is set to "true" is derived from the standard weblogic element so it supports the same set of attributes plus these additional attributes

    -
    Attribute Description The base directory into which the generated weblogic ready jar files are deposited. Jar files are deposited in directories corresponding to their location within the - descriptordir namespace. Yes
    +
    @@ -1279,11 +1275,11 @@ This will create only one TOPLink-enabled ejb jar file - 'Address.jar'.

    -

    WebSphere element

    +

    WebSphere element

    The websphere element searches for the websphere specific deployment descriptors and adds them to the final ejb jar file. Websphere has two specific descriptors for session -beans: +beans:

    • ibm-ejb-jar-bnd.xmi
    • ibm-ejb-jar-ext.xmi
    • @@ -1293,11 +1289,12 @@ and another two for container managed entity beans:
    • Map.mapxmi
    • Schema.dbxmi
    +

    In terms of WebSphere, the generation of container code and stubs is called deployment. This step can be performed by the websphere element as part of the jar generation process. If the switch ejbdeploy is on, the ejbdeploy tool from the websphere toolset is called for every ejb-jar. Unfortunately, this step only works, if you use the ibm jdk. Otherwise, the rmic -(called by ejbdeploy) throws a ClassFormatError. Be sure to switch ejbdeploy off, if run ant with +(called by ejbdeploy) throws a ClassFormatError. Be sure to switch ejbdeploy off, if Ant runs with Oracle JDK or OpenJDK.

    @@ -1307,7 +1304,7 @@ classes, that are required to reflect the bean classes. For ejbdeploy to work, y the classpath of the ejbdeploy tool and set the websphere.home property (look at the examples below).

    -
    Attribute Description
    +
    @@ -1318,13 +1315,13 @@ the classpath of the ejbdeploy tool and set the websphere.home property ( + descriptordir namespace. + be sure, to run Ant with the IBM JDK. @@ -1358,7 +1355,7 @@ the classpath of the ejbdeploy tool and set the websphere.home property ( -
    Attribute DescriptionThe base directory into which the generated weblogic ready jar files are deposited. Jar files are deposited in directories corresponding to their location within the - descriptordir namespace. Yes
    ejbdeploy Decides whether ejbdeploy is called. When you set this to true, - be sure, to run ant with the ibm jdk. No, defaults to true
    dbVendorThis option is passed to ejbdeploy. + This option is passed to ejbdeploy.

    Valid options can be obtained by running the following command: @@ -1415,7 +1412,7 @@ in the descriptor dir:

    </ejbjar> -

    iPlanet Application Server (iAS) element

    +

    iPlanet Application Server (iAS) element

    The <iplanet< nested element is used to build iAS-specific stubs and @@ -1436,10 +1433,9 @@ and META-INF/ias-ejb-jar.xml.

    in the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir) as well as the iplanet element (for example, suffix). Refer to the appropriate documentation for more details.

    -

    -Parameters:

    +

    Parameters:

    - +
    @@ -1475,7 +1471,7 @@ elements may also be used. +source files will be retained. If omitted, it defaults to "no". @@ -1485,7 +1481,7 @@ source files will be retained. If omitted, it defaults to "no". +will be generated. If omitted, it defaults to "no". @@ -1497,7 +1493,7 @@ will be generated. If omitted, it defaults to "no". This is used to find the ejbc utility if it isn't included in the user's system path. If specified, it should refer to the [install-location]/iplanet/ias6/ias directory. If omitted, the ejbc utility must be on the user's system -path. +path. @@ -1506,7 +1502,7 @@ path. +If omitted, it defaults to ".jar". @@ -1582,7 +1578,7 @@ local DTDs are found in the [iAS-install-directory]/dtd directory. location="${ias.home}/APPS/IASEjb_jar_1_0.dtd"/> </ejbjar> -

    JOnAS (Java Open Application Server) element

    +

    JOnAS (Java Open Application Server) element

    The <jonas> nested element is used to build JOnAS-specific stubs and skeletons thanks to the GenIC specific tool, and construct a JAR @@ -1615,7 +1611,7 @@ documentation for more details.

    Parameters:

    -
    Attribute Indicates whether or not the Java source files which are generated by ejbc will be saved or automatically deleted. If "yes", the -source files will be retained. If omitted, it defaults to "no". No
    Indicates whether or not the ejbc utility should log additional debugging statements to the standard output. If "yes", the additional debugging statements -will be generated. If omitted, it defaults to "no". No
    No
    suffix String value appended to the JAR filename when creating each JAR. -If omitted, it defaults to ".jar". No
    +
    @@ -1708,7 +1704,7 @@ documentation for more details.

    + omitted, it defaults to ".jar". @@ -1774,14 +1770,14 @@ descriptors to use the naming standard. This will create only one ejb jar file - -

    Orion element

    +

    Orion element

    The orion element searches for the Orion Application Server specific deployment descriptors and adds them to the final ejb jar file. Orion has one deployment descriptor:

    • orion-ejb-jar.xml

    -
    Attribute
    jarsuffix String value appended to the JAR filename when creating each JAR. If - omitted, it defaults to ".jar". No
    +
    @@ -1792,7 +1788,7 @@ to the final ejb jar file. Orion has one deployment descriptor: + descriptordir namespace.
    Attribute DescriptionThe base directory into which the generated jar files are deposited. Jar files are deposited in directories corresponding to their location within the - descriptordir namespace. Yes
    @@ -1812,5 +1808,4 @@ to the final ejb jar file. Orion has one deployment descriptor: - diff --git a/manual/Tasks/exec.html b/manual/Tasks/exec.html index 8dfc6bc2a..00613358e 100644 --- a/manual/Tasks/exec.html +++ b/manual/Tasks/exec.html @@ -24,7 +24,7 @@ -

    Exec

    +

    Exec

    Description

    Executes a system command. When the os attribute is specified, then the command is only executed when Apache Ant is run on one of the specified operating @@ -40,13 +40,12 @@ EOF (-1). This is a change from Ant 1.5, where such an attempt would block.

    use vmlauncher="false" on some operating systems - but even this may fail (Solaris 8/9 has been reported as problematic). The resolveexecutable attribute should be more - reliable, as would be something like + reliable, as would be something like

       <property name="executable-full-path"
                 location="../relative/path/to/executable"/>
       <exec executable="${executable-full-path}" ...
     
    -

    Windows Users

    The <exec> task delegates to Runtime.exec which in turn @@ -87,7 +86,7 @@ for the executable parameter. This is because the Java VM in which Ant is running is a standard Windows executable and is not aware of the Cygwin environment (i.e., doesn't load cygwin1.dll). The only work-around for this is to compile a JVM under Cygwin (at your own risk). -See for instance +See for instance OpenJDK build instructions for cygwin.

    @@ -95,7 +94,7 @@ OpenJDK build instructions for cygwin.

    OpenVMS Users

    The command specified using executable and <arg> elements is executed exactly as specified -inside a temporary DCL script. This has some implications: +inside a temporary DCL script. This has some implications:

    • paths have to be written in VMS style
    • if your executable points to a DCL script remember to @@ -103,7 +102,7 @@ prefix it with an @-sign (e.g. executable="@[FOO]BAR.COM"), just as you would in a DCL script
    -For <exec> to work in an environment with a Java VM +

    For <exec> to work in an environment with a Java VM older than version 1.4.1-2 it is also required that the logical JAVA$FORK_SUPPORT_CHDIR is set to TRUE in the job table (see the JDK Release Notes).

    @@ -122,7 +121,7 @@ interpretation of exit codes.

    href="http://listserv.uark.edu/scripts/wa.exe?A1=ind0404&L=vmesa-l#33">reported on the VMESA-LISTSERV that shell scripts invoked via the Ant Exec task must have their interpreter specified, i.e., the scripts must -start with something like: +start with something like:

    @@ -130,7 +129,7 @@ start with something like:
     
    -or the task will fail as follows: +

    or the task will fail as follows:

    @@ -138,10 +137,8 @@ or the task will fail as follows:
     [exec] Result: 255
     
    -

    -

    Running Ant as a background process on - Unix(-like) systems

    +

    Running Ant as a background process on Unix(-like) systems

    If you run Ant as a background process (like ant &) and use the <exec> task with spawn @@ -150,7 +147,7 @@ or the task will fail as follows: from the standard input.

    Parameters

    - +
    @@ -197,7 +194,7 @@ or the task will fail as follows: @@ -278,9 +275,10 @@ or the task will fail as follows: + Defaults to true. - + + @@ -331,10 +329,10 @@ or the task will fail as follows:

    Command line arguments should be specified as nested <arg> elements. See Command line arguments.

    -

    env

    +

    env

    It is possible to specify environment variables to pass to the system command via nested <env> elements.

    -
    Attribute Descriptionspawn whether or not you want the command to be spawned
    Default is false.
    - If you spawn a command, its output will not be logged by ant.
    + If you spawn a command, its output will not be logged by Ant.
    The input, output, error, and result property settings are not active when spawning a process.
    since Ant 1.6
    failifexecutionfails Stop the build if we can't start the program. - Defaults to true. No
    newenvironment Do not propagate old environment when new environment variables are specified.
    +
    @@ -345,8 +343,8 @@ system command via nested <env> elements.

    @@ -367,14 +365,14 @@ system command via nested <env> elements.

    replaced by the absolute filename of the file by Ant.
    Attribute Description The name of the environment variable.
    - Note: (Since Ant 1.7) - For windows, the name is case-insensitive. + Note: since Ant 1.7, + for Windows, the name is case-insensitive.
    Yes
    -

    redirector

    -Since Ant 1.6.2 +

    redirector

    +Since Ant 1.6.2

    A nested I/O Redirector can be specified. In general, the attributes of the redirector behave as the corresponding attributes available at the task level. The most notable peculiarity stems from the retention of the <exec> attributes for backwards compatibility. Any file mapping is done -using a null sourcefile; therefore not all +using a null sourcefile; therefore not all Mapper types will return results. When no results are returned, redirection specifications will fall back to the task level attributes. In practice this means that @@ -448,18 +446,14 @@ Output is sent to the file "redirector.out" and stored in a property of the same name. Similarly, error output is sent to a file and a property, both named "redirector.err". -

    Note: do not try to specify arguments using a simple arg-element and separate them by spaces. This results in only a single argument containing the entire string.

    -Timeouts: If a timeout is specified, when it is reached the +Timeouts: If a timeout is specified, when it is reached the sub process is killed and a message printed to the log. The return value of the execution will be "-1", which will halt the build if failonerror=true, but be ignored otherwise. - - - +

    - diff --git a/manual/Tasks/fail.html b/manual/Tasks/fail.html index eabe30b86..07d43228e 100644 --- a/manual/Tasks/fail.html +++ b/manual/Tasks/fail.html @@ -24,14 +24,14 @@ -

    Fail

    +

    Fail

    Description

    Exits the current build (just throwing a BuildException), optionally printing additional information.

    The message of the Exception can be set via the message attribute or character data nested into the element.

    Parameters

    - +
    @@ -69,7 +69,7 @@ or character data nested into the element.

    conditional failure can be achieved using a single nested <condition> element, which should contain exactly one core or custom condition. For information about conditions, see - here.
    Since Ant 1.6.2 + here.
    Since Ant 1.6.2

    Examples

    @@ -140,4 +140,3 @@ will fail.

    - diff --git a/manual/Tasks/filter.html b/manual/Tasks/filter.html index 16ba88c61..90e85a937 100644 --- a/manual/Tasks/filter.html +++ b/manual/Tasks/filter.html @@ -24,7 +24,7 @@ -

    Filter

    +

    Filter

    Description

    Sets a token filter for this project or read multiple token filter from an input file and sets these as filters. @@ -36,7 +36,7 @@ Note 2: Either token and value attributes must be provided, or only the filtersfile attribute.

    Parameters

    -
    Attribute Description
    +
    @@ -49,13 +49,13 @@ filtersfile attribute.

    - - +
    Attribute Description
    valuethe string that should be put to replace the token when the + the string that should be put to replace the token when the file is copied Yes*
    filtersfileThe file from which the filters must be read. This file must be a formatted as a property file. The file from which the filters must be read. This file must be a formatted as a property file. Yes*
    @@ -64,7 +64,7 @@ filtersfile attribute.

      <filter token="year" value="2000"/>
       <copy todir="${dest.dir}" filtering="true">
         <fileset dir="${src.dir}"/>
    -  </copy>
    + </copy>

    will copy recursively all the files from the src.dir directory into the dest.dir directory replacing all the occurrences of the string @year@ with 2000.

    @@ -72,8 +72,5 @@ with 2000.

    will read all property entries from the deploy_env.properties file and set these as filters. - - - diff --git a/manual/Tasks/fixcrlf.html b/manual/Tasks/fixcrlf.html index 2637401b7..5f7ebce0b 100644 --- a/manual/Tasks/fixcrlf.html +++ b/manual/Tasks/fixcrlf.html @@ -24,7 +24,7 @@ -

    FixCRLF

    +

    FixCRLF

    Description

    Adjusts a text file to local conventions. @@ -62,12 +62,12 @@

    - Since Apache Ant 1.7, this task can be used in a + Since Apache Ant 1.7, this task can be used in a filterchain.

    Parameters

    - +
    @@ -81,47 +81,47 @@ - + - - + + - + - + - + - + - + @@ -129,27 +129,27 @@ ("yes"/"no"). Default excludes are used when omitted. - + - + + Since Ant 1.7 - + + date of source files. Since Ant 1.6.3 - + @@ -280,7 +280,7 @@ + of a processed file.
    Ignored if EOL is asis.
    Since Ant 1.6.1
    Attribute DescriptionsrcDir Where to find the files to be fixed up. One of these  
    fileName of a single file to fix. Since Ant 1.7 Name of a single file to fix. Since Ant 1.7 
    destDir Where to place the corrected files. Defaults to srcDir (replacing the original file). No  
    includes comma- or space-separated list of patterns of files that must be included. All files are included when omitted. No  
    includesfile the name of a file. Each line of this file is taken to be an include pattern. No  
    excludes comma- or space-separated list of patterns of files that must be excluded. No files (except default excludes) are excluded when omitted. No  
    excludesfile the name of a file. Each line of this file is taken to be an exclude pattern. No  
    defaultexcludes No  
    encoding The encoding of the files. No; defaults to default JVM encoding.  
    outputencoding The encoding to use when writing the files. - Since Ant 1.7 No; defaults to the value of the encoding attribute.  
    preservelastmodified Whether to preserve the last modified - date of source files. Since Ant 1.6.3 No; default is false  
    eol
    fixlast Whether to add a missing EOL to the last line - of a processed file.
    Ignored if EOL is asis.
    Since Ant 1.6.1
    No; default is true
    @@ -322,6 +322,5 @@ DOS systems, and are removed if run on Unix systems. You never know what editor a user will use to browse READMEs.

    - diff --git a/manual/Tasks/ftp.html b/manual/Tasks/ftp.html index 83c18e311..494f0d891 100644 --- a/manual/Tasks/ftp.html +++ b/manual/Tasks/ftp.html @@ -24,7 +24,7 @@ -

    FTP

    +

    FTP

    Description

    The ftp task implements a basic FTP client that can send, receive, list, delete files, and create directories. See below for descriptions and examples of how @@ -48,13 +48,13 @@ write patterns.

    This task does not currently use the proxy information set by the <setproxy> task, and cannot go through -a firewall via socks. +a firewall via socks.

    -Warning: there have been problems reported concerning the ftp get with the newer attribute. -Problems might be due to format of ls -l differing from what is expected by commons-net, +Warning: there have been problems reported concerning the ftp get with the newer attribute. +Problems might be due to format of ls -l differing from what is expected by commons-net, for instance due to specificities of language used by the ftp server in the directory listing. If you encounter such a problem, please send an email including a sample directory listing -coming from your ftp server (ls -l on the ftp prompt). +coming from your ftp server (ls -lcode> on the ftp prompt).

    If you can connect but not upload or download, try setting the passive @@ -62,7 +62,7 @@ attribute to true to use the existing (open) channel, instead of having the serv try to set up a new connection.

    Parameters

    - +
    @@ -92,8 +92,7 @@ try to set up a new connection.

    + since Ant 1.7. @@ -129,13 +128,13 @@ try to set up a new connection.

    - - @@ -148,37 +147,34 @@ try to set up a new connection.

    + Since Ant 1.6 - - + + Since Ant 1.7 - + Since Ant 1.6 @@ -218,7 +214,7 @@ try to set up a new connection.

    and get operations to be skipped with a warning and the remainder of the files still transferred. Default: false
    - + + since Ant 1.8.0 @@ -262,12 +258,12 @@ try to set up a new connection.

    "http://commons.apache.org/net/download_net.cgi"> jakarta-commons-net-1.4.0 or greater
    .

    - Use these options when the standard options don't work, because + Use these options when the standard options don't work, because

    • the server is in a different timezone and you need timestamp dependency checking
    • the default timestamp formatting doesn't match the server display and list parsing therefore fails
    -

    +

    If none of these is specified, the default mechanism of letting the system auto-detect the server OS type based on the FTP SYST command and assuming standard formatting for that OS type will be used. @@ -278,7 +274,7 @@ try to set up a new connection.

    Please understand that these options are incompatible with the autodetection scheme. If any of these options is specified, (other than with a value of - "" ) a system type must be chosen and if systemTypeKey is not + "") a system type must be chosen and if systemTypeKey is not specified, UNIX will be assumed. The philosophy behind this is that these options are for setting non-standard formats, and a build-script author who knows what system he is dealing with will know what options to need to be @@ -293,8 +289,7 @@ try to set up a new connection.

    "MVS". If not specified, (or specified as "") and if no other xxxConfig attributes are specified, the autodetection mechanism based on the FTP SYST command will be used.
    - Since ant 1.7 - + Since Ant 1.7 + Since Ant 1.7 - + - + Since Ant 1.7 - + Since Ant 1.7 @@ -374,9 +366,7 @@ try to set up a new connection.

    If you require a language other than the above, see also the shortMonthNamesConfig attribute.
    - Since ant 1.7 - - + Since Ant 1.7 @@ -388,93 +378,70 @@ try to set up a new connection.

    "jan|feb|mar|apr|maí|jún|júl|ágú|sep|okt|nóv|des". This attribute exists primarily to support languages not supported by the serverLanguageCode attribute.
    - Since ant 1.7 - + Since Ant 1.7
    Attribute Description
    account the account to use on the ftp server. - since Ant 1.7. - No
    verbosedisplays information on each file transferred if set + displays information on each file transferred if set to "yes". Defaults to "no". No
    dependstransfers only new or changed files if set to + transfers only new or changed files if set to "yes". Defaults to "no". No
    timediffauto set to "true" - to make ant calculate the time difference between client and server.
    + to make Ant calculate the time difference between client and server.
    requires write access in the remote directory
    - Since ant 1.6
    No
    timestampGranularity Specify either MINUTE, NONE, (or you may specify "" which is equivalent to not specifying a value, - useful for property-file driven scripts). Allows override of the typical situation - in PUT and GET where local filesystem timestamps are HH:mm:ss - and the typical FTP server's timestamps are HH:mm. This can throw + useful for property-file driven scripts). Allows override of the typical situation + in PUT and GET where local filesystem timestamps are HH:mm:ss + and the typical FTP server's timestamps are HH:mm. This can throw off uptodate calculations. However, the default values should suffice for most applications.
    - Since ant 1.7 -
    No. Only applies in "puts" and "gets" where the - default values are MINUTE for PUT and NONE for GET. + default values are MINUTE for PUT and NONE for GET. (It is not as necessary in GET because we have the preservelastmodified option.)
    timediffmillisDeprecated. Number of milliseconds to add to the time on - the remote machine to get the time on the local machine. The timestampGranularity - attribute (for which the default values should suffice in most situations), and the - serverTimeZoneConfig option, should make this unnecessary. - serverTimeZoneConfig does the math for you and also knows about + Deprecated. Number of milliseconds to add to the time on + the remote machine to get the time on the local machine. The timestampGranularity + attribute (for which the default values should suffice in most situations), and the + serverTimeZoneConfig option, should make this unnecessary. + serverTimeZoneConfig does the math for you and also knows about Daylight Savings Time.
    - Since ant 1.6 -
    No
    No
    preservelastmodified Give the copied files the same last modified @@ -252,7 +248,7 @@ try to set up a new connection.

    connect to the same host as the control connection. This is a security measure that is enabled by default, but it may be useful to disable it in certain firewall scenarios. - since Ant 1.8.0
    No, default is true
    No, but if any of the following xxxConfig attributes is specified, UNIX will be assumed, even if "" is specified here. @@ -305,19 +300,18 @@ try to set up a new connection.

    Specify as a Java TimeZone identifier, (e.g. GMT, America/Chicago or - Asia/Jakarta) the timezone used by the server for timestamps. This - enables timestamp dependency checking even when the server is in a different - time zone from the client. Time Zones know, also, about daylight savings time, - and do not require you to calculate milliseconds of difference. If not specified, + Asia/Jakarta) the timezone used by the server for timestamps. This + enables timestamp dependency checking even when the server is in a different + time zone from the client. Time Zones know, also, about daylight savings time, + and do not require you to calculate milliseconds of difference. If not specified, (or specified as ""), the time zone of the client is assumed.
    - Since ant 1.7 -
    No
    defaultDateFormatConfigSpecify in Java + Specify in Java SimpleDateFormat notation, (e.g. yyyy-MM-dd), the date format generally used by the FTP server @@ -326,23 +320,21 @@ try to set up a new connection.

    older than a year old. (See recentDateFormatConfig). If not specified, (or specified as ""), the default date format for the system type indicated by the systemTypeKey attribute will be used.
    - Since ant 1.7 -
    No.
    recentDateFormatConfigSpecify in Java + Specify in Java SimpleDateFormat notation, (e.g. MMM dd hh:mm) the date format used by the FTP server to parse dates less than a year old. If not specified (or specified as ""), and if the system type indicated by the system key uses a recent date format, its standard format will be used.
    - Since ant 1.7 -
    No
    No
    No

    Note about remotedir attribute

    - +
    - - - + + + - + +which the files are sent +evaluated on the local machine - + +which the files are retrieved +the remotedir matching the include/exclude patterns of +the fileset - + +which files get deleted +the remotedir matching the include/exclude patterns of +the fileset - + +the remotedir matching the include/exclude patterns of +the fileset - - + + +which the mode of files get changed +the remotedir matching the include/exclude patterns of +the fileset - + +which directories get removed +under the remotedir matching the include/exclude +patterns of the fileset
    Action
    -
    meaning of remotedir
    -
    use of nested fileset -(s)
    -
    Actionmeaning of remotediruse of nested fileset(s)
    send/put
    -
    send/put base directory to -which the files are sent
    -
    they are used normally and -evaluated on the local machine
    -
    recv/get
    -
    recv/get base directory from -which the files are retrieved
    -
    the remote files located under -the remotedir matching the include/exclude patterns of -the fileset 
    del/delete
    -
    del/delete base directory from -which files get deleted
    -
    the remote files located under -the remotedir matching the include/exclude patterns of -the fileset
    -
    list
    -
    list base directory from which files are listed
    the remote files located under -the remotedir matching the include/exclude patterns of -the fileset
    -
    mkdirdirectory to create
    -
    not used
    -
    directory to createnot used
    chmod base directory from -which the mode of files get changed
    -
    the remote files located under -the remotedir matching the include/exclude patterns of -the fileset
    -
    rmdir
    -
    rmdir base directory from -which directories get removed
    -
    the remote directories located -under the remotedir matching the include/exclude -patterns of the fileset
    -

    Parameters specified as nested elements

    @@ -485,8 +452,8 @@ the files to be retrieved, or deleted, or listed, or whose mode you want to chan

    The attribute followsymlinks of fileset is supported on local (put) as well as remote (get, chmod, delete) filesets. -Before ant 1.6 there was no support of symbolic links in remote filesets. -In order to exclude symbolic links (preserve the behavior of ant 1.5.x and older), +Before Ant 1.6 there was no support of symbolic links in remote filesets. +In order to exclude symbolic links (preserve the behavior of Ant 1.5.x and older), you need to explicitly set followsymlinks to false. On remote filesets hidden files are not checked for being symbolic links. Hidden files are currently assumed to not be symbolic links. @@ -501,8 +468,8 @@ files are currently assumed to not be symbolic links. <fileset dir="htdocs/manual"/> </ftp> -

    Logs in to ftp.apache.org as anonymous and -uploads all files in the htdocs/manual directory +

    Logs in to ftp.apache.org as anonymous and +uploads all files in the htdocs/manual directory to the default directory for that user.

      <ftp server="ftp.apache.org"
            remotedir="incoming"
    @@ -512,7 +479,7 @@ to the default directory for that user.

    <fileset dir="htdocs/manual"/> </ftp>

    Logs in to ftp.apache.org as anonymous and -uploads all new or changed files in the htdocs/manual directory +uploads all new or changed files in the htdocs/manual directory to the incoming directory relative to the default directory for anonymous.

      <ftp server="ftp.apache.org"
    @@ -560,13 +527,13 @@ in text mode.

    <fileset dir="htdocs/manual"> <include name="**/*.html"/> </fileset> - </ftp>

    Logs in to the Windows-based ftp.nt.org as -coder with password java1 and uploads all -HTML files in the htdocs/manual directory to the + </ftp>

    Logs in to the Windows-based ftp.nt.org as +coder with password java1 and uploads all +HTML files in the htdocs/manual directory to the c:\uploads directory. Progress messages are displayed as each file is uploaded.

    Getting Files

    -

    Getting files from an FTP server works pretty much the same way as +

    Getting files from an FTP server works pretty much the same way as sending them does. The only difference is that the nested filesets use the remotedir attribute as the base directory for the files on the FTP server, and the dir attribute as the local directory to put the files @@ -581,8 +548,8 @@ into. The file structure from the FTP site is preserved on the local machine. -

    Logs in to ftp.apache.org as anonymous and -recursively downloads all .html files from default directory for that user +

    Logs in to ftp.apache.org as anonymous and +recursively downloads all .html files from default directory for that user into the htdocs/manual directory on the local machine.

       <ftp action="get"
    @@ -621,8 +588,8 @@ recursively downloads all .html files from default directory for that user
     into the htdocs/manual directory on the local machine.

    Deleting Files

    -As you've probably guessed by now, you use nested fileset elements to -select the files to delete from the remote FTP server. Again, the +As you've probably guessed by now, you use nested fileset elements to +select the files to delete from the remote FTP server. Again, the filesets are relative to the remote directory, not a local directory. In fact, the dir attribute of the fileset is ignored completely. @@ -669,14 +636,14 @@ remotedir attribute.

    directory. As with all other actions, the directory separator character must be correct according to the desires of the FTP server.

    Removing Directories

    -This action uses nested fileset elements to -select the directories to remove from the remote FTP server. The -filesets are relative to the remote directory, not a local directory. +This action uses nested fileset elements to +select the directories to remove from the remote FTP server. The +filesets are relative to the remote directory, not a local directory. The dir attribute of the fileset is ignored completely. The directories to be removed must be empty, or contain only other directories that have been also selected to be removed by the filesets patterns, otherwise a BuildException will be thrown. -Also, if you don't have permission to remove a directory, a BuildException is +Also, if you don't have permission to remove a directory, a BuildException is thrown.
    @@ -700,25 +667,22 @@ it tries to remove a directory it is sure all the directories under it are
     already removed.
     Obviously all the files in the tree must have been already deleted.
     

    -

    As an example suppose you want to delete everything contained into +

    As an example suppose you want to delete everything contained into /somedir, so invoke first the <ftp> task with action="delete", then with action="rmdir" specifying in both cases -remotedir="/somedir" and - +remotedir="/somedir" and

         <fileset>
             <include name="**"/>
         </fileset>
     
    - +

    The directory specified in the remotedir parameter is never selected for remove, so if you need to remove it, specify its parent in -remotedir parameter and include it in the +remotedir parameter and include it in the <fileset> pattern, like "somedir/**".

    - - diff --git a/manual/Tasks/genkey.html b/manual/Tasks/genkey.html index 96959c2ff..5010a201c 100644 --- a/manual/Tasks/genkey.html +++ b/manual/Tasks/genkey.html @@ -24,12 +24,12 @@ -

    GenKey

    +

    GenKey

    Description

    -

    Generates a key in a keystore.

    +

    Generates a key in a keystore.

    Parameters

    - +
    @@ -99,11 +99,11 @@ have a name and a value. When using the subelement it is automatically encoded properly and commas (",") are replaced with "\,".

    -

    The following two examples are identical:

    +

    The following two examples are identical:

    Examples

    -<genkey alias="apache-group" storepass="secret" 
    +<genkey alias="apache-group" storepass="secret"
       dname="CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US"/>
     
    @@ -119,7 +119,5 @@ with "\,".

    </genkey> - - diff --git a/manual/Tasks/get.html b/manual/Tasks/get.html index e63b59df8..eeeecfecd 100644 --- a/manual/Tasks/get.html +++ b/manual/Tasks/get.html @@ -24,22 +24,22 @@ -

    Get

    +

    Get

    Description

    Gets files from URLs. When the verbose option is "on", this task displays a '.' for every 100 Kb retrieved. Any URL schema supported by -the runtime is valid here, including http:, ftp: and jar:; +the runtime is valid here, including http:, ftp: and jar:;

    The usetimestamp option enables you to control downloads so that the remote file is -only fetched if newer than the local copy. If there is no local copy, the download always takes -place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp. -NB: This timestamp facility only works on downloads using the HTTP protocol. +only fetched if newer than the local copy. If there is no local copy, the download always takes +place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp. +NB: This timestamp facility only works on downloads using the HTTP protocol.

    A username and password can be specified, in which case basic 'slightly encoded plain text' authentication is used. This is only secure over an HTTPS link.

    -

    Proxies. Since Apache Ant 1.7.0, Ant running on Java1.5 or later can +

    Proxies. Since Apache Ant 1.7.0, Ant running on Java 5 or later can use the proxy settings of the operating system if enabled with the -autoproxy option. There is also the @@ -47,9 +47,9 @@ plain text' authentication is used. This is only secure over an HTTPS link. for earlier Java versions. With proxies turned on, <get> requests against localhost may not work as expected, if the request is relayed to the proxy.

    - +

    Parameters

    -
    Attribute Description
    +
    @@ -91,12 +91,12 @@ plain text' authentication is used. This is only secure over an HTTPS link. - + - + - + - +
    Attribute Descriptionusername username for 'BASIC' http authentication if password is set
    passwordpassword: required password: required if username is set
    maxtime Maximum time in seconds a single download may take, @@ -104,7 +104,7 @@ plain text' authentication is used. This is only secure over an HTTPS link. error. Since Ant 1.8.0 No: default 0 which means no maximum time
    retries The number of attempts to make for opening the URI.
    @@ -172,10 +172,9 @@ plain text' authentication is used. This is only secure over an HTTPS link.

    header

    Any arbitrary number of HTTP headers can be added to a request.
    - The attributes of a nested

    <header/> 
    node are as follow: -

    + The attributes of a nested <header/> node are as follows:

    - +
    @@ -197,18 +196,18 @@ plain text' authentication is used. This is only secure over an HTTPS link.
      <get src="http://ant.apache.org/" dest="help/index.html"/>

    Gets the index page of http://ant.apache.org/, and stores it in the file help/index.html.

    -
      <get src="http://www.apache.org/dist/ant/KEYS" 
    -    dest="KEYS" 
    +
      <get src="http://www.apache.org/dist/ant/KEYS"
    +    dest="KEYS"
         verbose="true"
         usetimestamp="true"/>

    Gets the PGP keys of Ant's (current and past) release managers, if the local copy -is missing or out of date. Uses the verbose option +is missing or out of date. Uses the verbose option for progress information.

    -
      <get src="https://insecure-bank.org/statement/user=1214" 
    -    dest="statement.html" 
    +
      <get src="https://insecure-bank.org/statement/user=1214"
    +    dest="statement.html"
         username="1214";
         password="secret"/>

    @@ -253,7 +252,7 @@ the input task to query for a password.

     <get dest="downloads">
    -  <url url="http://ant.apache.org/index.html"/> 
    +  <url url="http://ant.apache.org/index.html"/>
       <url url="http://ant.apache.org/faq.html"/>
     </get>
     
    @@ -272,4 +271,3 @@ the input task to query for a password.

    necessary.

    - diff --git a/manual/Tasks/gunzip.html b/manual/Tasks/gunzip.html index 32e2cf216..aaf364b68 100644 --- a/manual/Tasks/gunzip.html +++ b/manual/Tasks/gunzip.html @@ -23,7 +23,6 @@ -This document's new home is here +This document's new home is here - diff --git a/manual/Tasks/gzip.html b/manual/Tasks/gzip.html index 6054d319c..8e3d0dd35 100644 --- a/manual/Tasks/gzip.html +++ b/manual/Tasks/gzip.html @@ -23,7 +23,6 @@ -This document's new home is here +This document's new home is here - diff --git a/manual/Tasks/hostinfo.html b/manual/Tasks/hostinfo.html index 851b40360..8986ebd55 100644 --- a/manual/Tasks/hostinfo.html +++ b/manual/Tasks/hostinfo.html @@ -24,7 +24,7 @@ -

    HostInfo

    +

    HostInfo

    Description

    Sets the NAME, DOMAIN, ADDR4, and ADDR6 @@ -38,10 +38,10 @@ The DOMAIN contains the domain part of the canonical name of the ho If the host is not found, the domain will contain the domain as provided to the task, or localdomain if no host / domain was provided.
    The ADDR4 contains the IPv4 address of the host with the widest meaning.
    -If no IPv4 address is found and a host has been provided the address 0.0.0.0 +If no IPv4 address is found and a host has been provided the address 0.0.0.0 is returned, when no host was provided the address 127.0.0.1 is returned.
    -The ADDR6 contains the IPv6 address of the host with the widest meaning.
    -If no IPv6 address is found and a host has been provided the address :: +The ADDR6 contains the IPv6 address of the host with the widest meaning.
    +If no IPv6 address is found and a host has been provided the address :: is returned, when no host was provided the address ::1 is returned.

    @@ -51,7 +51,7 @@ to indicate, for example, the host where the build was performed on. The best place for this task is probably in an initialization target.

    Parameters

    -
    Attribute Description
    +
    @@ -79,18 +79,18 @@ The best place for this task is probably in an initialization target.

    -Sets the NAME, DOMAIN, ADDR4, and +Sets the NAME, DOMAIN, ADDR4, and ADDR6 for the local host, using the most "global" address available.

       <hostinfo prefix="remotehost" host="www.apache.org"/>
     

    -Sets the properties remotehost.NAME to eos, -remotehost.DOMAIN to apache.org, -remotehost.ADDR4 to 140.211.11.130 and +Sets the properties remotehost.NAME to eos, +remotehost.DOMAIN to apache.org, +remotehost.ADDR4 to 140.211.11.130 and remotehost.ADDR6 to :: -for the host with the name www.apache.org (provided the canonical name and ip +for the host with the name www.apache.org (provided the canonical name and ip addresses do not change).

    diff --git a/manual/Tasks/image.html b/manual/Tasks/image.html index 077b3721a..20459d046 100644 --- a/manual/Tasks/image.html +++ b/manual/Tasks/image.html @@ -24,7 +24,7 @@ -

    Image

    +

    Image

    Description

    Applies a chain of image operations on a set of files.

    Requires Java Advanced Image API from Sun.

    @@ -33,47 +33,47 @@ Class-Diagram

    Parameters

    -
    Attribute Description
    +
    - - - + + + - - - + + + - - + - + - - + - + - - + - + - - - + + + @@ -89,7 +89,7 @@ - + @@ -107,14 +107,14 @@ - - - + + + - - - + + +
    Attribute Description Required
    failonerror Boolean value. If false, note errors to the output but keep going. no (defaults to true) failonerrorBoolean value. If false, note errors to the output but keep going.no (defaults to true)
    srcdir Directory containing the images. yes, unless nested fileset is used srcdirDirectory containing the images.yes, unless nested fileset is used
    encoding Image encoding type.
    +
    encodingImage encoding type.
    Valid (caseinsensitive) are: jpg, jpeg, tif, tiff
    no (defaults to JPEG) no (defaults to JPEG)
    overwrite Boolean value. Sets whether or not to overwrite + overwriteBoolean value. Sets whether or not to overwrite a file if there is naming conflict. no (defaults to false) no (defaults to false)
    gc Boolean value. Enables garbage collection after + gcBoolean value. Enables garbage collection after each image processed. no (defaults to false) no (defaults to false)
    destdir Directory where the result images are stored. no (defaults to value of srcdir) destdirDirectory where the result images are stored.no (defaults to value of srcdir)
    No
    excludesexcludes comma- or space-separated list of patterns of files that must be excluded. No files (except default excludes) are excluded when omitted. NoNo
    caseSensitive Boolean value. Sets case sensitivity of the file system. no (defaults to false) caseSensitiveBoolean value. Sets case sensitivity of the file system.no (defaults to false)
    followSymlinks Boolean value. Sets whether or not symbolic links should be followed. no (defaults to true) followSymlinksBoolean value. Sets whether or not symbolic links should be followed.no (defaults to true)
    @@ -133,48 +133,52 @@ ImageOperation can handle nested Rotate, Draw, Rectangle, Text and Scale objects

    Rotate

    Adds a Rotate ImageOperation to chain.

    Parameters
    - +
    - - - + + +
    Attribute Description Required
    angle Float value. Sets the angle of rotation in degrees. no (defaults to 0.0F) angleFloat value. Sets the angle of rotation in degrees.no (defaults to 0.0F)

    Scale

    Adds a Scale ImageOperation to chain.

    Parameters
    - +
    - - + + - + + + + - - + + - + - - + + - +
    Attribute Description Required
    proportions Sets which dimension to control proportions from. Valid values are:
      +
    proportionsSets which dimension to control proportions from. Valid values are: +
    • "ignore" - treat the dimensions independently.
    • "height" - keep proportions based on the width.
    • "width" - keep proportions based on the height.
    • "cover" - keep proportions and fit in the supplied dimensions.
    • "fit" - keep proportions and cover the supplied dimensions.
    • -
    no (defaults to ignore) no (defaults to ignore)
    width Sets the width of the image, either as an integer or a %. widthSets the width of the image, either as an integer or a %. no (defaults to 100%) no (defaults to 100%)
    height Sets the height of the image, either as an integer or a %. heightSets the height of the image, either as an integer or a %. no (defaults to 100%) no (defaults to 100%)
    @@ -182,21 +186,21 @@ ImageOperation can handle nested Rotate, Draw, Rectangle, Text and Scale objects

    Adds a Draw ImageOperation to chain. DrawOperation DataType objects can be nested inside the Draw object.

    Parameters
    - +
    - - - + + + - - - + + +
    Attribute Description Required
    xloc X-Position where to draw nested image elements. no (defaults to 0) xlocX-Position where to draw nested image elements.no (defaults to 0)
    yloc Y-Position where to draw nested image elements. no (defaults to 0) ylocY-Position where to draw nested image elements.no (defaults to 0)
    @@ -250,12 +254,5 @@ and stores the src.

    Same as above but stores the resulting file names will be prefixed by "scaled-".

    -
    -
    - - - - - diff --git a/manual/Tasks/import.html b/manual/Tasks/import.html index 4cf8de086..aaa75d0c9 100644 --- a/manual/Tasks/import.html +++ b/manual/Tasks/import.html @@ -14,7 +14,6 @@ See the License for the specific language governing permissions and limitations under the License. --> - @@ -22,7 +21,7 @@ Import Task -

    Import

    +

    Import

    Description

    Imports another build file into the current project. @@ -44,7 +43,7 @@

    In the common use case where only Ant's default project helper is - used, it basically works like the + used, it basically works like the Entity Includes as explained in the Ant FAQ, as if the imported file was contained in the importing file, minus the top <project> @@ -57,12 +56,11 @@

    There are two further functional aspects that pertain to this task and -that are not possible with entity includes: +that are not possible with entity includes:

    • target overriding
    • special properties
    -

    Target overriding

    If a target in the main file is also present in at least one of the @@ -165,7 +163,7 @@ project).

    Parameters

    - +
    @@ -179,7 +177,7 @@ project).

    diff --git a/manual/Tasks/include.html b/manual/Tasks/include.html index e2109235d..23ab6ba00 100644 --- a/manual/Tasks/include.html +++ b/manual/Tasks/include.html @@ -14,7 +14,6 @@ See the License for the specific language governing permissions and limitations under the License. --> - @@ -22,7 +21,7 @@ Include Task -

    Include

    +

    Include

    Description

    Include another build file into the current project. @@ -53,12 +52,11 @@

    There are two further functional aspects that pertain to this task and -that are not possible with entity includes: +that are not possible with entity includes:

    • target rewriting
    • special properties
    -

    Target rewriting

    Any target in the included file will be renamed @@ -160,7 +158,7 @@ project).

    Parameters

    -
    Attribute The file to import. If this is a relative file name, the file name will be resolved relative to the importing file. Note, this is unlike most other - ant file attributes, where relative files are resolved relative to ${basedir}. + Ant file attributes, where relative files are resolved relative to ${basedir}. Yes or a nested resource collection
    +
    diff --git a/manual/Tasks/input.html b/manual/Tasks/input.html index b04affc5c..e0139c387 100644 --- a/manual/Tasks/input.html +++ b/manual/Tasks/input.html @@ -24,11 +24,11 @@ -

    Input

    +

    Input

    Description

    Allows user interaction during the build process by prompting for -input. To do so, it uses the configured +input. To do so, it uses the configured InputHandler.

    The prompt can be set via the message attribute or as character @@ -42,7 +42,7 @@ one of the predefined.

    user. This property can then be used during the following build run. Input behaves according to property task which means that existing properties cannot be overridden. -Since Apache Ant 1.6, <input> will not prompt for input if +Since Apache Ant 1.6, <input> will not prompt for input if a property should be set by the task that has already been set in the project (and the task wouldn't have any effect).

    @@ -50,8 +50,8 @@ project (and the task wouldn't have any effect).

    characters to the console, this is a critical security defect, we must fix it immediately, etc, etc. This problem was due to the lack in early versions of Java of a (fully functional) facility for handling secure console input. -In Java 1.6 that shortcoming in Java's API was addressed and Ant versions 1.7.1 -and 1.8 have added support for Java 1.6's secure console input feature +In Java 6 that shortcoming in Java's API was addressed and Ant versions 1.7.1 +and 1.8 have added support for Java 6 secure console input feature (see handler type).

    @@ -60,7 +60,7 @@ type it in. For this situation, place the password in a (secured) property file and load in before the input task.

    Parameters

    -
    Attribute
    +
    @@ -101,16 +101,16 @@ file and load in before the input task.

    Handler

    Since Ant 1.7, a nested <handler> element can be used to specify an InputHandler, so that different InputHandlers may be used -among different Input tasks. +among different Input tasks.

    -
    Attribute Description
    +
    - - + + @@ -142,7 +142,7 @@ among different Input tasks.
    Attribute Description Required
    type
    type one of "default","propertyfile", "greedy", or "secure" (since Ant 1.8). One of theseNo
    -
    +

    The classpath can also be specified by means of one or more nested <classpath> elements.

    @@ -157,8 +157,7 @@ implementation you use.

    continue..." and pause the build run until return key is pressed (again, the concrete behavior is implementation dependent).

      <input
    -    message="Press Return key to continue..."
    -  />
    + message="Press Return key to continue..."/>

    Will display the message "Press Return key to continue..." and pause the build run until return key is pressed (see above).

    @@ -166,8 +165,7 @@ continue..." and pause the build run until return key is pressed <input message="All data is going to be deleted from DB continue (y/n)?" validargs="y,n" - addproperty="do.delete" - /> + addproperty="do.delete"/> <condition property="do.abort"> <equals arg1="n" arg2="${do.delete}"/> </condition> @@ -179,20 +177,17 @@ exit build with following message "Build aborted by user.".

      <input
         message="Please enter db-username:"
    -    addproperty="db.user"
    -  />
    + addproperty="db.user"/>

    Will display the message "Please enter db-username:" and set the property db.user to the value entered by the user.

      <input
         message="Please enter db-username:"
         addproperty="db.user"
    -    defaultvalue="Scott-Tiger"
    -  />
    + defaultvalue="Scott-Tiger"/>

    Same as above, but will set db.user to the value Scott- Tiger if the user enters no value (simply types <return>).

    - diff --git a/manual/Tasks/jar.html b/manual/Tasks/jar.html index 6920eff55..5ec3cfe23 100644 --- a/manual/Tasks/jar.html +++ b/manual/Tasks/jar.html @@ -24,7 +24,7 @@ -

    Jar

    +

    Jar

    Description

    Jars a set of files.

    The basedir attribute is the reference directory from where to jar.

    @@ -91,12 +91,12 @@ to a value other than its default, "add".

    To cryptographically sign your JAR file, use the SignJar task on the JAR that you create from this task.

    For creating a simple version of a JEP-238 multi release jar, -you don't need any special tools. Just set the required manifest entry and place the files where required, as you could see -in the JEP238-example. If you want to tune this kind of jar, e.g. decreasing the size by deleting -'same' classes from the versions-branches, you have to do more ...

    +you don't need any special tools. Just set the required manifest entry and place the files where required, as you could see +in the JEP238-example. If you want to tune this kind of jar, e.g. decreasing the size by deleting +'same' classes from the versions-branches, you have to do more ...

    Parameters

    - +
    @@ -203,9 +203,9 @@ in the JEP238-example. If you want to tune this ki - - + @@ -365,9 +365,9 @@ If the manifest values have changed the jar will be updated or rebuilt, as appropriate.

    -

    indexjars

    +

    indexjars

    -

    since ant 1.6.2

    +

    since Ant 1.6.2

    The nested indexjars element specifies a PATH like structure. Its content is @@ -393,9 +393,9 @@ depend on your manifest:

    the indexmetainf attribute has been set to true.

    -

    service

    +

    service

    -

    since ant 1.7.0

    +

    since Ant 1.7.0

    The nested service element specifies a service. @@ -413,7 +413,7 @@ depend on your manifest:

    "provider" nested elements.

    -

    Attribute Description
    indexwhether to create an index - list to speed up classloading. This is a JDK 1.3+ specific + whether to create an index + list to speed up classloading. This is a JDK 1.3+ specific feature. Unless you specify additional jars with nested indexjars elements, only the contents of this jar will be included in the index. Defaults to @@ -263,7 +263,7 @@ in the JEP238-example. If you want to tune this ki
  • ignore = logs a message on verbose level (default)
  • Since Ant 1.7.1
    No, defaults to ignore. No, defaults to ignore.
    preserve0permissions
    +
    @@ -439,8 +439,8 @@ depend on your manifest:

    If a JAR file has more that one implementation of the service, a number of nested <provider> elements may be used.

    - - + +

    Examples

    Simple

    @@ -453,8 +453,7 @@ called app.jar in the ${dist}/lib directory.

      <jar destfile="${dist}/lib/app.jar"
            basedir="${build}/classes"
    -       excludes="**/Test.class"
    -  />
    + excludes="**/Test.class"/>

    jars all files in the ${build}/classes directory into a file called app.jar in the ${dist}/lib directory. Files with the name Test.class are excluded.

    @@ -462,8 +461,7 @@ with the name Test.class are excluded.

      <jar destfile="${dist}/lib/app.jar"
            basedir="${build}/classes"
            includes="mypackage/test/**"
    -       excludes="**/Test.class"
    -  />
    + excludes="**/Test.class"/>

    jars all files in the ${build}/classes directory into a file called app.jar in the ${dist}/lib directory. Only files under the directory mypackage/test are used, and files with @@ -472,8 +470,7 @@ the name Test.class are excluded.

    Multiple filesets

      <jar destfile="${dist}/lib/app.jar">
         <fileset dir="${build}/classes"
    -             excludes="**/Test.class"
    -    />
    +             excludes="**/Test.class"/>
         <fileset dir="${src}/resources"/>
       </jar>

    jars all files in the ${build}/classes directory and also @@ -542,7 +539,7 @@ by Java).

    </jar>

    This is an example of an inline manifest specification including the version of the build -program (Implementation-Version). Note that the Built-By attribute will take the value of the Ant +program (Implementation-Version). Note that the Built-By attribute will take the value of the Ant property ${user.name}. The manifest produced by the above would look like this:

    @@ -562,7 +559,7 @@ Sealed: false

    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 JDK 6 scripting interface:

    <jar destfile="pinky.jar">
       <fileset dir="build/classes"/>
    @@ -575,7 +572,7 @@ Sealed: false

    The following shows how to create a jar file specifing a service - with two implementations of the JDK6 scripting interface: + with two implementations of the JDK 6 scripting interface:

     <jar destfile="pinkyandbrain.jar">
    @@ -588,22 +585,21 @@ Sealed: false
    - -

    JEP238 example: a Multi-Release JAR Files

    +

    JEP238 example: a Multi-Release JAR Files

    Here we want to create a Multi-Release JAR File according the specification JEP-238. - It defines on top of a JAR the possibility to place additional or overwriting classes - in a jar, which are available according to the Java version you run.
    - Basically it sais, that you have to set the manifest entry Multi-Release: true - and place all additional or overwriting classes in - META-INF/versions/number/package-structure, e.g. + It defines on top of a JAR the possibility to place additional or overwriting classes + in a jar, which are available according to the Java version you run.
    + Basically it sais, that you have to set the manifest entry Multi-Release: true + and place all additional or overwriting classes in + META-INF/versions/number/package-structure, e.g. META-INF/versions/9/org/apache/ant/MyClass.class

    In this example we expect that the normal classes are compiled into - ${java.classes} and the Java9 classes are compiled into - ${java9.classes}. + ${java.classes} and the Java 9 classes are compiled into + ${java9.classes}.

         <jar destfile="mrjar.jar">
    @@ -612,9 +608,9 @@ Sealed: false
    <attribute name="Multi-Release" value="true"/> </manifest> <!-- directory structure according to the spec ... --> - <!-- ... default classes loadable by old (<Java9) versions --> + <!-- ... default classes loadable by old (<Java 9) versions --> <fileset dir="${java.classes}"/> - <!-- ... per release classes, require Java9+ for loadable via standard ClassLoader --> + <!-- ... per release classes, require Java 9+ for loadable via standard ClassLoader --> <zipfileset prefix="META-INF/versions/9/" dir="${java9.classes}"/> </jar> diff --git a/manual/Tasks/jarlib-available.html b/manual/Tasks/jarlib-available.html index adb732f03..616985516 100644 --- a/manual/Tasks/jarlib-available.html +++ b/manual/Tasks/jarlib-available.html @@ -24,7 +24,7 @@ -

    jarlib-available

    +

    jarlib-available

    Description

    Check whether an extension is present in a fileset or an extensionSet. If the extension is present then a property is set.

    @@ -39,7 +39,7 @@ Java Standard Edition package, in file Extension and ExtensionSet documentation for further details

    Parameters

    -
    Attribute Description
    +
    @@ -127,8 +127,5 @@ sets of files to check for extension.

    </jarlib-available> - - - diff --git a/manual/Tasks/jarlib-display.html b/manual/Tasks/jarlib-display.html index 0ddbaa34e..1c9d1397f 100644 --- a/manual/Tasks/jarlib-display.html +++ b/manual/Tasks/jarlib-display.html @@ -24,7 +24,7 @@ -

    jarlib-display

    +

    jarlib-display

    Description

    Display the "Optional Package" and "Package Specification" information contained within the specified jars.

    @@ -39,7 +39,7 @@ Java Standard Edition package, in file Extension and ExtensionSet documentation for further details

    Parameters

    -
    Attribute Description
    +
    @@ -73,8 +73,5 @@ Extension and ExtensionSet documentation for further details

    </jarlib-display> - - - diff --git a/manual/Tasks/jarlib-manifest.html b/manual/Tasks/jarlib-manifest.html index 019b55459..e2f5bda8d 100644 --- a/manual/Tasks/jarlib-manifest.html +++ b/manual/Tasks/jarlib-manifest.html @@ -24,7 +24,7 @@ -

    jarlib-manifest

    +

    jarlib-manifest

    Description

    Task to generate a manifest that declares all the dependencies in manifest. The dependencies are determined by looking in the @@ -41,7 +41,7 @@ Java Standard Edition package, in file Extension and ExtensionSet documentation for further details

    Parameters

    -
    Attribute Description
    +
    @@ -116,8 +116,5 @@ Extension and ExtensionSet documentation for further details

    </jarlib-manifest> - - - diff --git a/manual/Tasks/jarlib-resolve.html b/manual/Tasks/jarlib-resolve.html index 2ef4f87ba..cfb5f5b3b 100644 --- a/manual/Tasks/jarlib-resolve.html +++ b/manual/Tasks/jarlib-resolve.html @@ -24,7 +24,7 @@ -

    jarlib-resolve

    +

    jarlib-resolve

    Description

    Try to locate a jar to satisfy an extension and place location of jar into property. The task allows you to @@ -38,13 +38,13 @@ works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document Optional Package Versioning in the documentation bundle for your -Java2 Standard Edition package, in file +Java Standard Edition package, in file guide/extensions/versioning.html or the online Extension and ExtensionSet documentation for further details

    Parameters

    -
    Attribute Description
    +
    @@ -76,7 +76,7 @@ Extension and ExtensionSet documentation for further details

    location

    The location sub element allows you to look for a library in a location relative to project directory.

    -
    Attribute Description
    +
    @@ -92,7 +92,7 @@ Extension and ExtensionSet documentation for further details

    url

    The url resolver allows you to download a library from a URL to a local file.

    -
    Attribute Description
    +
    @@ -119,7 +119,7 @@ Extension and ExtensionSet documentation for further details

    ant

    The ant resolver allows you to run an Apache Ant build file to generate a library.

    -
    Attribute Description
    +
    @@ -204,8 +204,5 @@ Extension and ExtensionSet documentation for further details

    </jarlib-resolve> - - - diff --git a/manual/Tasks/java.html b/manual/Tasks/java.html index 36d50ce53..880243d35 100644 --- a/manual/Tasks/java.html +++ b/manual/Tasks/java.html @@ -24,7 +24,7 @@ -

    Java

    +

    Java

    Description

    Executes a Java class within the running (Apache Ant) VM or forks another VM if specified.

    @@ -36,8 +36,7 @@ JVM. sending input to it via the input and inputstring attributes.

    -

    Running Ant as a background process on - Unix(-like) systems

    +

    Running Ant as a background process on Unix(-like) systems

    If you run Ant as a background process (like ant &) and use the <java> task with spawn @@ -47,14 +46,14 @@ attributes.

    standard input.

    Parameters

    -
    Attribute Description
    +
    - - + + @@ -92,7 +91,7 @@ attributes.

    - @@ -166,7 +165,7 @@ attributes.

    + redirected. @@ -287,7 +286,7 @@ and treated like indicated in failonerror.

    Note:
    If you do not specify permissions, a set of default permissions will be added to your Java invocation to make -sure that the ant run will continue or terminated as indicated by +sure that the Ant run will continue or terminated as indicated by failonerror. All permissions not granted per default will be checked by whatever security manager was already in place. exitVM will be disallowed. @@ -306,20 +305,20 @@ subelement.

    since Ant 1.6.

    -

    redirector

    -Since Ant 1.6.2 +

    redirector

    +Since Ant 1.6.2

    A nested I/O Redirector can be specified. In general, the attributes of the redirector behave as the corresponding attributes available at the task level. The most notable peculiarity stems from the retention of the <java> attributes for backwards compatibility. Any file mapping is done -using a null sourcefile; therefore not all +using a null sourcefile; therefore not all Mapper types will return results. When no results are returned, redirection specifications will fall back to the task level attributes. In practice this means that defaults can be specified for input, output, and error output files.

    -

    Errors and return codes

    +

    Errors and return codes

    By default the return code of a <java> is ignored. Alternatively, you can set resultproperty to the name of a property and have it assigned to the result code (barring immutability, @@ -327,22 +326,21 @@ of course). When you set failonerror="true", the only possible value for resultproperty is 0. Any non-zero response is treated as an error and would mean the build exits. -

    Similarly, if failonerror="false" and fork="false" -, then <java> must return 0 otherwise the build will +

    Similarly, if failonerror="false" and fork="false", +then <java> must return 0 otherwise the build will exit, as the class was run by the build JVM.

    -

    modulepath

    -Since Ant 1.9.7 +

    modulepath

    +Since Ant 1.9.7

    Java's modulepath attribute is a PATH like structure and can also be set via a nested modulepath element.

    -

    upgrademodulepath

    -Since Ant 1.9.7 +

    upgrademodulepath

    +Since Ant 1.9.7

    The location of modules that replace upgradeable modules in the runtime image can be specified using this PATH like structure.

    -

    JAR file execution

    The parameter of the jar attribute is of type File; @@ -351,9 +349,9 @@ base directory of the project, not the directory in which the Java task is run. If you need to locate a JAR file relative to the directory the task will be run in, you need to explicitly create the full path to the JAR file.

    -

    When using the jar attribute, all classpath settings are +

    When using the jar attribute, all classpath settings are ignored according to Oracle's -specification. +specification.

    Examples

    diff --git a/manual/Tasks/javac.html b/manual/Tasks/javac.html index 366240242..045e1a309 100644 --- a/manual/Tasks/javac.html +++ b/manual/Tasks/javac.html @@ -14,7 +14,7 @@ See the License for the specific language governing permissions and limitations under the License. --> - + @@ -24,7 +24,7 @@ -

    Javac

    +

    Javac

    Description

    Compiles a Java source tree.

    The source and destination directory will be recursively scanned for Java @@ -57,7 +57,7 @@ element(s), or by using wildcard patterns. See the section on directory-based tasks, for information on how the inclusion/exclusion of files works, and how to write wildcard patterns.

    -

    It is possible to use different compilers. This can be specified by +

    It is possible to use different compilers. This can be specified by either setting the global build.compiler property, which will affect all <javac> tasks throughout the build, by setting the compiler attribute, specific to the current @@ -65,9 +65,9 @@ setting the compiler attribute, specific to the current typedeffed or componentdeffed type that implements org.apache.tools.ant.taskdefs.compilers.CompilerAdapter. -Valid values for either the +Valid values for either the build.compiler property or the compiler -attribute are:

    +attribute are:

    • classic (the standard compiler of JDK 1.1/1.2) – javac1.1 and @@ -106,7 +106,7 @@ classname in the build.compiler property or the

      The fork attribute overrides the build.compiler property or compiler attribute setting and -expects a JDK1.1 or higher to be set in JAVA_HOME. +expects a JDK 1.1 or higher to be set in JAVA_HOME.

      You can also use the compiler attribute to tell Ant which JDK version it shall assume when it puts together the command @@ -136,7 +136,7 @@ invoking the compiler.

      corresponding .java file the file will not get compiled even if a native header file generated for it would be outdated.

      Parameters

      -
    Attribute Description Required
    classname
    classname the Java class to execute. Either jar, classname or module
    spawnif enabled allows to start a process which will outlive ant.
    +
    if enabled allows to start a process which will outlive Ant.
    Requires fork=true, and not compatible with timeout, input, output, error, result attributes.
    (disabled by default)
    error The file to which the standard error of the command should be - redirected. No
    +
    @@ -299,7 +299,8 @@ invoking the compiler.

    - + @@ -424,7 +425,7 @@ invoking the compiler.

    Attribute Description No
    depend Enables dependency-tracking + dependEnables dependency-tracking for compilers that support this (jikes and classic). No
    updatedProperty - The property to set (to the value "true") + The property to set (to the value "true") if compilation has taken place and has been successful. Since Ant 1.7.1. @@ -568,7 +569,7 @@ are specified like Command-line Arguments but have an additional attribute that can be used to enable arguments only if a given compiler implementation will be used.

    - +
    @@ -630,8 +631,7 @@ used.

    destdir="${build}" classpath="xyz.jar" debug="on" - source="1.4" - /> + source="1.4"/>

    compiles all .java files under the ${src} directory, and stores the .class files in the ${build} directory. @@ -643,8 +643,7 @@ so you can use assert statements.

    destdir="${build}" fork="true" source="1.2" - target="1.2" - /> + target="1.2"/>

    compiles all .java files under the ${src} directory, and stores the .class files in the ${build} directory. This will fork off the javac @@ -655,8 +654,7 @@ the class files should be runnable under JDK 1.2+ as well.

      <javac srcdir="${src}"
              destdir="${build}"
              fork="java$$javac.exe"
    -         source="1.5"
    -  />
    + source="1.5"/>

    compiles all .java files under the ${src} directory, and stores the .class files in the ${build} directory. This will fork off the javac @@ -669,8 +667,7 @@ The source level is 1.5, so you can use generics.

    includes="mypackage/p1/**,mypackage/p2/**" excludes="mypackage/p1/testpackage/**" classpath="xyz.jar" - debug="on" - /> + debug="on"/>

    compiles .java files under the ${src} directory, and stores the .class files in the ${build} directory. @@ -686,8 +683,7 @@ so the actual values used will depend on which JDK you ran Ant with.

    includes="mypackage/p1/**,mypackage/p2/**" excludes="mypackage/p1/testpackage/**" classpath="xyz.jar" - debug="on" - /> + debug="on"/>

    is the same as the previous example, with the addition of a second source path, defined by @@ -715,10 +711,9 @@ Java VM of a different version:

    destdir="${build}" fork="yes" executable="/opt/java/jdk1.1/bin/javac" - compiler="javac1.1" - /> + compiler="javac1.1"/> -

    Note: +

    Note: If you wish to compile only source files located in certain packages below a common root, use the include/exclude attributes or <include>/<exclude> nested elements @@ -732,13 +727,13 @@ for additional information.

    If you wish to compile only files explicitly specified and disable javac's default searching mechanism then you can unset the sourcepath -attribute: +attribute:

      <javac sourcepath="" srcdir="${src}"
              destdir="${build}" >
         <include name="**/*.java"/>
         <exclude name="**/Example.java"/>
       </javac>
    -That way the javac will compile all java source files under "${src}" +

    That way the javac will compile all java source files under "${src}" directory but skip the examples. The compiler will even produce errors if some of the non-example files refers to them.

    @@ -746,14 +741,12 @@ the non-example files refers to them.

    If you wish to compile with a special JDK (another than the one Ant is currently using), set the executable and fork attribute. Using taskname -could show in the log, that these settings are fix. -

      <javac srcdir="" 
    +could show in the log, that these settings are fix.

    +
      <javac srcdir=""
              destdir=""
    -         executable="path-to-java14-home/bin/javac" 
    +         executable="path-to-java14-home/bin/javac"
              fork="true"
    -         taskname="javac1.4" />
    -

    - + taskname="javac1.4"/>

    Note: If you are using Ant on Windows and a new DOS window pops up for every use of an external compiler, this may be a problem of the JDK you are @@ -762,13 +755,12 @@ using. This problem may occur with all JDKs < 1.2.

    If you want to activate other compiler options like lint you could use -the <compilerarg> element: +the <compilerarg> element:

      <javac srcdir="${src.dir}"
              destdir="${classes.dir}"
              classpathref="libraries">
         <compilerarg value="-Xlint"/>
    -  </javac> 
    -

    + </javac>

    If you want to use a custom CompilerAdapter org.example.MyAdapter you can either @@ -776,8 +768,7 @@ the <compilerarg> element:

     <javac srcdir="${src.dir}"
            destdir="${classes.dir}"
    -       compiler="org.example.MyAdapter"/>
    -
    + compiler="org.example.MyAdapter"/>

    or a define a type and nest this into the task like in:

     <componentdef classname="org.example.MyAdapter"
    @@ -794,8 +785,7 @@ the <compilerarg> element:
              destdir="${build}"
              includeantruntime="false"
              modulepath="modules"
    -         source="9"
    -  />
    + source="9"/>

    compiles all .java files in a single module under the ${src} directory, and stores the .class files in the ${build} directory. The compilation uses application modules located in modules folder.The source level is 9 to enable modules.

    @@ -804,8 +794,7 @@ the <compilerarg> element: destdir="${build}" includeantruntime="false" modulepath="modules" - source="9" - /> + source="9"/>

    compiles all .java files in gen/classes, lin32/classes and lin64/classes in all source modules under the ${src} directory. Generates module directories in the ${build} directory. Each generated module directory under @@ -831,7 +820,7 @@ interpreted as anything other than false. By default, build.compiler.warnings is true, while all others are false.

    -
    Attribute Description
    +
    @@ -893,7 +882,7 @@ while all others are false.

    build.compiler.jvc.extensions to false before invoking <javac>.

    -

    Bootstrap Options

    +

    Bootstrap Options

    The Sun javac compiler has a bootclasspath command line option - this corresponds to the "bootclasspath" attribute/element @@ -913,9 +902,6 @@ while all others are false.

    </javac> - -

    -

    OpenJDK Notes

    The openjdk @@ -945,7 +931,7 @@ while all others are false.

    Note on package-info.java

    - package-info.java files were introduced in Java5 to + package-info.java files were introduced in Java 5 to allow package level annotations. On compilation, if the java file does not contain runtime annotations, there will be no .class file for the java file. Up to Ant 1.7.1, when the <javac> diff --git a/manual/Tasks/javacc.html b/manual/Tasks/javacc.html index 3c0dcfa85..0dba9cdf2 100644 --- a/manual/Tasks/javacc.html +++ b/manual/Tasks/javacc.html @@ -24,10 +24,10 @@ -

    JavaCC

    +

    JavaCC

    Description

    - Invokes the JavaCC compiler + Invokes the JavaCC compiler compiler on a grammar file.

    @@ -48,7 +48,7 @@

    Parameters

    -
    Property Description
    +
    @@ -194,8 +194,7 @@ target="src/Parser.jj" outputdirectory="build/src" javacchome="c:/program files/JavaCC" - static="true" -/> + static="true"/>

    This invokes JavaCC on grammar file src/Parser.jj, writing the generated @@ -203,8 +202,5 @@ invoking JavaCC.

    - - - diff --git a/manual/Tasks/javadoc.html b/manual/Tasks/javadoc.html index 430435ff8..390d893bb 100644 --- a/manual/Tasks/javadoc.html +++ b/manual/Tasks/javadoc.html @@ -24,7 +24,7 @@ -

    Javadoc/Javadoc2

    +

    Javadoc/Javadoc2

    Description

    Generates code documentation using the javadoc tool.

    The source directory will be recursively scanned for Java source files to process @@ -81,7 +81,7 @@ to <javadoc> using classpath, classpathref attributes or with the exclude patterns of the packageset (and vice versa).

    Parameters

    -
    Attribute Description
    +
    @@ -523,8 +523,8 @@ to <javadoc> using classpath, classpathref attributes or order to mitigate CVE-2013-1571. Defaults to true. Since Ant 1.9.2
    There is a frame injection attack possible in javadocs generated by Oracle - JDKs prior to Java7 Update 25 (details). - When this flag is set to true, Ant will check whether the docs are vulnerable + JDKs prior to Java 7 update 25 (details). + When this flag is set to true, Ant will check whether the docs are vulnerable and will try to fix them. @@ -532,7 +532,7 @@ to <javadoc> using classpath, classpathref attributes or
    Attribute Description 1.4
    -

    Format of the group attribute

    +

    Format of the group attribute

    The arguments are comma-delimited. Each single argument is 2 space-delimited strings, where the first one is the group's title and the second one a colon delimited list of packages.

    @@ -588,7 +588,7 @@ javadoc as source files.

    Same as one entry in the list given by packagenames.

    Parameters
    - +
    @@ -611,7 +611,7 @@ Same as for package.

    Same as one entry in the list given by sourcefiles.

    Parameters
    -
    Attribute Description
    +
    @@ -651,7 +651,7 @@ syntax (or both at once), but with the nested elements you can easily specify multiple occurrences of the arguments.

    Parameters
    -
    Attribute Description
    +
    @@ -692,7 +692,7 @@ specify multiple occurrences of the arguments.

    Attribute Description
    -

    group

    +

    group

    Separates packages on the overview page into whatever groups you specify, one group per table. This performs the same role as the group attribute. You can use either syntax (or both at once), but with the @@ -700,7 +700,7 @@ nested elements you can easily specify multiple occurrences of the arguments.

    Parameters
    - +
    @@ -745,14 +745,14 @@ of the doclet element is shown below:

    </javadoc> -

    tag

    +

    tag

    If you want to specify a standard tag using a nested tag element because you want to determine the order the tags are output, you must not set the description attribute for those tags.

    Parameters
    -
    Attribute Description
    +
    @@ -803,12 +803,12 @@ the javadoc program.
    Attribute Description
    -

    taglet

    +

    taglet

    The taglet nested element is used to specify custom taglets beyond the default taglets.

    Parameters
    - +
    @@ -908,8 +908,5 @@ arguments. Since Ant 1.6

    <link href="http://docs.oracle.com/javase/7/docs/api/"/> </javadoc> - - - diff --git a/manual/Tasks/javah.html b/manual/Tasks/javah.html index 088b6e85d..82de03b94 100644 --- a/manual/Tasks/javah.html +++ b/manual/Tasks/javah.html @@ -24,13 +24,13 @@ -

    Javah

    +

    Javah

    Description

    Generates JNI headers from a Java class.

    -

    When this task executes, it will generate the C header and source files that +

    When this task executes, it will generate the C header and source files that are needed to implement native methods. JNI operates differently depending on -whether JDK1.2+ -or pre-JDK1.2 +whether JDK 1.2+ +or pre-1.2 JDK systems are used.

    If you are building with Java 8 or above consider @@ -39,12 +39,13 @@ systems are used.

    generate the native header files with a single step.

    Note the javah has been deprecated as of Java 9 - and removed as of Java 10. Trying to use it with Java10 will + and removed as of Java 10. Trying to use it with Java 10 will fail.

    -

    It is possible to use different compilers. This can be selected -with the implementation attribute or a nested element. Here are the choices of the attribute:

    +

    It is possible to use different +compilers. This can be selected with the implementation +attribute or a nested element. Here are the choices of the +attribute:

    • default - the default compiler for the platform.
    • sun (the standard compiler of the JDK)
    • @@ -64,7 +65,7 @@ name="implementationvalues">Here are the choices of the attribute:

      breaking the amount of classes to compile into smaller chunks.

      Parameters

      -
    Attribute Description
    +
    @@ -88,13 +89,13 @@ name="implementationvalues">Here are the choices of the attribute:

    - + - + @@ -143,7 +144,7 @@ specified like Command-line Arguments but have an additional attribute that can be used to enable arguments only if a given compiler implementation will be used.

    -
    Attribute Description
    forcespecifies that output files should always be written (JDK1.2 only)specifies that output files should always be written (JDK 1.2 only) No
    oldspecifies that old JDK1.0-style header files should be generated - (otherwise output file contain JNI-style native method function prototypes) (JDK1.2 only)specifies that old JDK 1.0-style header files should be generated + (otherwise output file contain JNI-style native method function prototypes) (JDK 1.2 only) No
    +
    @@ -201,7 +202,7 @@ only if a given compiler implementation will be used.

    Examples

      <javah destdir="c" class="org.foo.bar.Wibble"/>
    -

    makes a JNI header of the named class, using the JDK1.2 JNI model. Assuming +

    makes a JNI header of the named class, using the JDK 1.2 JNI model. Assuming the directory 'c' already exists, the file org_foo_bar_Wibble.h is created there. If this file already exists, it is left unchanged.

      <javah outputFile="wibble.h">
    @@ -251,5 +252,4 @@ describe its progress.

    nested elements of its own.

    - diff --git a/manual/Tasks/jdepend.html b/manual/Tasks/jdepend.html index 7a9639da3..9b30e810a 100644 --- a/manual/Tasks/jdepend.html +++ b/manual/Tasks/jdepend.html @@ -14,27 +14,24 @@ See the License for the specific language governing permissions and limitations under the License. --> - - -JDepend Task - + JDepend Task -

    JDepend

    +

    JDepend

    Description

    -

    Invokes the JDepend parser.

    +

    Invokes the JDepend parser.

    -

    This parser "traverses a set of Java source file directories and generates design quality metrics for each Java package". +

    This parser "traverses a set of Java source file directories and generates design quality metrics for each Java package". It allows to "automatically measure the quality of a design in terms of its extensibility, reusability, and maintainability to -effectively manage and control package dependencies."

    +effectively manage and control package dependencies."

    Source file directories are defined by nested <sourcespath>; Class file directories are defined @@ -43,68 +40,68 @@ href="#nested">nested elements.

    Optionally, you can also set the outputfile name where the output is stored. By default the task writes its report to the standard output.

    -

    The task requires at least the JDepend 1.2 version.

    +

    The task requires at least the JDepend 1.2 version.

    Parameters

    -
    Attribute Description
    +
    - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - + - + - - - + + +
    AttributeDescriptionRequiredAttributeDescriptionRequired
    outputfileThe output file name. If not set, the output is printed on the standard output.NooutputfileThe output file name. If not set, the output is printed on the standard output.No
    formatThe format to write the output in. The default is "text", the alternative is "xml"NoformatThe format to write the output in. The default is "text", the alternative is "xml"No
    forkRun the tests in a separate VM.No, default is "off"forkRun the tests in a separate VM.No, default is "off"
    haltonerrorStop the build process if an error occurs during the jdepend analysis.No, default is "off"haltonerrorStop the build process if an error occurs during the jdepend analysis.No, default is "off"
    timeoutCancel the operation if it doesn't finish in the given time (measured in milliseconds). (Ignored if fork is disabled.)NotimeoutCancel the operation if it doesn't finish in the given time (measured in milliseconds). (Ignored if fork is disabled.)No
    jvmThe command used to invoke the Java Virtual Machine, default is 'java'. The command is resolved by java.lang.Runtime.exec(). (Ignored if fork is disabled.)No, default "java"jvmThe command used to invoke the Java Virtual Machine, default is 'java'. The command is resolved by java.lang.Runtime.exec(). (Ignored if fork is disabled.)No, default "java"
    dirThe directory to invoke the VM in. (Ignored if fork is disabled)NodirThe directory to invoke the VM in. (Ignored if fork is disabled)No
    includeruntimeImplicitly add the classes required to run jdepend + includeruntimeImplicitly add the classes required to run jdepend in forked mode. (Ignored if fork is disabled). Since Apache Ant 1.6.No, default is "no".No, default is "no".
    classpathrefthe classpath to use, given as reference to a PATH defined elsewhere.Noclasspathrefthe classpath to use, given as reference to a PATH defined elsewhere.No
    -

    Nested Elements

    +

    Nested Elements

    jdepend supports four nested elements: -<classpath>, <classespath> and +<classpath>, <classespath> and <sourcespath>, that represent PATH like structures, and <exclude>.

    @@ -127,7 +124,6 @@ to ignore (requires JDepend 2.5 or above).

            <pathelement location="build"/>     </classespath> </jdepend> - @@ -152,7 +148,7 @@ classpath reference.

    This invokes JDepend in a separate VM on the src and testsrc directories, writing the output to the <docs/jdepend.xml> file in xml format. The -classpath is defined using nested elements.

    +classpath is defined using nested elements.

    @@ -170,8 +166,5 @@ classpath is defined using nested elements. 

    files to analyze, and will ignore all classes in the java.* and javax.* packages.

    - - - diff --git a/manual/Tasks/jjdoc.html b/manual/Tasks/jjdoc.html index 52b922570..f3721b5b2 100644 --- a/manual/Tasks/jjdoc.html +++ b/manual/Tasks/jjdoc.html @@ -14,18 +14,15 @@ See the License for the specific language governing permissions and limitations under the License. --> - - JJDoc Task -

    -JJDoc

    +

    JJDoc

    Since Apache Ant 1.6

    Description

    @@ -36,7 +33,7 @@ It can operate in three modes, determined by command line options.

    To use the jjdoc task, set the target attribute to the name of the JavaCC grammar file to process. You also need to specify the directory containing the JavaCC installation using the javacchome attribute, -so that ant can find the JavaCC classes. Optionally, you can also set the +so that Ant can find the JavaCC classes. Optionally, you can also set the outputfile to write the generated BNF documentation file to a specific (directory and) file. Otherwise jjdoc writes the generated BNF documentation file as the JavaCC grammar file with a suffix .txt or .html.

    @@ -45,55 +42,55 @@ generated BNF documentation file.

    Parameters

    - +
    - + - + - + - + - + - + - + - + - + - + - - + - + - - + - + - + - + @@ -108,16 +105,13 @@ option. Example
    -
    <jjdoc 
    -    target="src/Parser.jj" 
    +
    <jjdoc
    +    target="src/Parser.jj"
         outputfile="doc/ParserBNF.html"
    -    javacchome="c:/program files/JavaCC" 
    -/>
    +    javacchome="c:/program files/JavaCC"/>
    This invokes JJDoc on grammar file src/Parser.jj, writing the generated BNF documentation file, ParserBNF.html, file to doc. -
    - diff --git a/manual/Tasks/jjtree.html b/manual/Tasks/jjtree.html index 7fbb2a9f8..70529bb8b 100644 --- a/manual/Tasks/jjtree.html +++ b/manual/Tasks/jjtree.html @@ -14,21 +14,17 @@ See the License for the specific language governing permissions and limitations under the License. --> - - JJTree Task -

    -JJTree

    +

    JJTree

    -

    -Description

    +

    Description

    Invokes the JJTree preprocessor for the JavaCC compiler compiler. It inserts parse tree building actions at various places in the JavaCC source that it generates. The output of @@ -49,143 +45,143 @@ generated JavaCC file.

    Parameters

    -
    AttributeAttributeDescriptionDescriptionRequiredRequired
    targettargetThe javacc grammar file to process.The javacc grammar file to process.YesYes
    javacchomejavacchomeThe directory containing the JavaCC distribution.The directory containing the JavaCC distribution.YesYes
    outputfileoutputfileThe file to write the generated BNF documentation file to. If not set, +The file to write the generated BNF documentation file to. If not set, the file is written with the same name as the JavaCC grammar file but with a the suffix .html or .txt. NoNo
    texttextSets the TEXT BNF documentation option. This is a boolean +Sets the TEXT BNF documentation option. This is a boolean option.NoNo
    onetableonetableSets the ONE_TABLE BNF documentation option. This is a boolean option.Sets the ONE_TABLE BNF documentation option. This is a boolean option.NoNo
    +
    - + - + - + - + - + - + - + - + - + - + - - + - + - - + - + - - + - + - + - + - + - - + - + - + - + - + - - + - + - - + - + - + - + - + - + - + - + - + - + - + - - + - + - + - + @@ -196,16 +192,14 @@ option.
    AttributeAttributeDescriptionDescriptionRequiredRequired
    targettargetThe jjtree grammar file to process.The jjtree grammar file to process.YesYes
    javacchomejavacchomeThe directory containing the JavaCC distribution.The directory containing the JavaCC distribution.YesYes
    outputdirectoryoutputdirectoryThe directory to write the generated JavaCC grammar and node files to. +The directory to write the generated JavaCC grammar and node files to. If not set, the files are written to the directory containing the grammar file. NoNo
    outputfileoutputfileThe file to write the generated JavaCC grammar file +The file to write the generated JavaCC grammar file to. If not set, the file is written with the same name as the JJTree grammar file but with a the suffix .jj. This is a filename relative to outputdirectory if specified, the project's basedir.NoNo
    buildnodefilesbuildnodefilesSets the BUILD_NODE_FILES grammar option. This is a boolean +Sets the BUILD_NODE_FILES grammar option. This is a boolean option.NoNo
    multimultiSets the MULTI grammar option. This is a boolean option.Sets the MULTI grammar option. This is a boolean option.NoNo
    nodedefaultvoidnodedefaultvoidSets the NODE_DEFAULT_VOID grammar option. This is a boolean +Sets the NODE_DEFAULT_VOID grammar option. This is a boolean option.NoNo
    nodefactorynodefactorySets the NODE_FACTORY grammar option. This is boolean option.Sets the NODE_FACTORY grammar option. This is boolean option.NoNo
    nodescopehooknodescopehookSets the NODE_SCOPE_HOOK grammar option. This is a boolean +Sets the NODE_SCOPE_HOOK grammar option. This is a boolean option.NoNo
    nodeusesparsernodeusesparserSets the NODE_USES_PARSER grammar option. This is a boolean +Sets the NODE_USES_PARSER grammar option. This is a boolean option.NoNo
    staticstaticSets the STATIC grammar option. This is a boolean option.Sets the STATIC grammar option. This is a boolean option.NoNo
    visitorvisitorSets the VISITOR grammar option. This is a boolean option.Sets the VISITOR grammar option. This is a boolean option.NoNo
    nodepackagenodepackageSets the NODE_PACKAGE grammar option. This is a string option.Sets the NODE_PACKAGE grammar option. This is a string option.NoNo
    visitorexceptionvisitorexceptionSets the VISITOR_EXCEPTION grammar option. This is a string +Sets the VISITOR_EXCEPTION grammar option. This is a string option.NoNo
    nodeprefixnodeprefixSets the NODE_PREFIX grammar option. This is a string option.Sets the NODE_PREFIX grammar option. This is a string option.NoNo
    -

    -Example

    +

    Example

    <jjtree 
    -    target="src/Parser.jjt" 
    +    target="src/Parser.jjt"
         outputdirectory="build/src"
    -    javacchome="c:/program files/JavaCC" 
    -    nodeusesparser="true"
    -/>
    +    javacchome="c:/program files/JavaCC" +    nodeusesparser="true"/>
    This invokes JJTree on grammar file src/Parser.jjt, writing the generated grammar file, Parser.jj, file to build/src. The grammar option NODE_USES_PARSER @@ -214,7 +208,7 @@ is set to true when invoking JJTree.

    Comparison output locations between command line JJTree and different Ant taskdef versions

    - +
    @@ -541,23 +535,17 @@ is set to true when invoking JJTree.
    Command Line JJTree options
         and Generated Files (working directory: /tmp)
    -

    *) Footnote: When running JJTree with the Ant taskdef jjtree the option -OUTPUT_DIRECTORY must always -be set, because the project's basedir and the Ant working directory might differ. So even if you don't specify the jjtree taskdef -outputdirectory JJTree will be called with the -OUTPUT_DIRECTORY set to the project's basedirectory. -But when the -OUTPUT_DIRECTORY is set, the -OUTPUT_FILE setting is handled as if relative to this --OUTPUT_DIRECTORY. Thus when the -OUTPUT_FILE is absolute or contains a drive letter we have a -problem. +

    *) Footnote: When running JJTree with the Ant taskdef jjtree the option -OUTPUT_DIRECTORY must always +be set, because the project's basedir and the Ant working directory might differ. So even if you don't specify the jjtree taskdef +outputdirectory JJTree will be called with the -OUTPUT_DIRECTORY set to the project's basedirectory. +But when the -OUTPUT_DIRECTORY is set, the -OUTPUT_FILE setting is handled as if relative to this +-OUTPUT_DIRECTORY. Thus when the -OUTPUT_FILE is absolute or contains a drive letter we have a +problem. Therefore absolute outputfiles (when the outputdirectory isn't specified) are made relative to the default directory. And for this reason outputfiles that contain a drive letter can't be supported.

    -

    By the way: specifying a drive letter in the -OUTPUT_FILE when the -OUTPUT_DIRECTORY is set, also +

    By the way: specifying a drive letter in the -OUTPUT_FILE when the -OUTPUT_DIRECTORY is set, also results in strange behavior when running JJTree from the command line.

    -
    - - - - - diff --git a/manual/Tasks/jlink.html b/manual/Tasks/jlink.html index 45ef96152..0937d1d55 100644 --- a/manual/Tasks/jlink.html +++ b/manual/Tasks/jlink.html @@ -21,7 +21,7 @@ -

    Jlink

    +

    Deprecated

    This task has been deprecated. Use a zipfileset or zipgroupfileset with the @@ -31,32 +31,32 @@

    Description:

    Links entries from sub-builds and libraries.

    -

    The jlink task can be used to build jar and zip files, similar to +

    The jlink task can be used to build jar and zip files, similar to the jar task. -However, jlink provides options for controlling the way entries from +However, jlink provides options for controlling the way entries from input files -are added to the output file. Specifically, capabilities for merging +are added to the output file. Specifically, capabilities for merging entries from multiple zip or jar files is available.

    -

    If a mergefile is specified directly (eg. at the top level of a +

    If a mergefile is specified directly (eg. at the top level of a mergefiles -pathelement) and the mergefile ends in ".zip" or +pathelement) and the mergefile ends in ".zip" or ".jar", -entries in the mergefile will be merged into the outfile. A file with +entries in the mergefile will be merged into the outfile. A file with any other extension -will be added to the output file, even if it is specified in the +will be added to the output file, even if it is specified in the mergefiles element. -Directories specified in either the mergefiles or addfiles element +Directories specified in either the mergefiles or addfiles element are added to the -output file as you would expect: all files in subdirectories are +output file as you would expect: all files in subdirectories are recursively added to -the output file with appropriate prefixes in the output file +the output file with appropriate prefixes in the output file (without merging).

    -In the case where duplicate entries and/or files are found among the +In the case where duplicate entries and/or files are found among the files to be merged or added, jlink merges or adds the first entry and ignores all subsequent entries.

    @@ -66,11 +66,11 @@ jlink ignores META-INF directories in mergefiles. Users should supply their own manifest information for the output file.

    -

    It is possible to refine the set of files that are being jlinked. +

    It is possible to refine the set of files that are being jlinked. This can be -done with the includes, includesfile, excludes, +done with the includes, includesfile, excludes, excludesfile, -and defaultexcludes attributes on the addfiles and +and defaultexcludes attributes on the addfiles and mergefiles nested elements. With the includes or includesfile attribute you specify the files you want to have included by using patterns. @@ -85,7 +85,7 @@ relative to the base directory.

    Parameters:

    - +
    @@ -98,7 +98,7 @@ relative to the base directory.

    - @@ -107,7 +107,7 @@ relative to the base directory.

    - @@ -118,7 +118,7 @@ mergefiles or addfiles

    Examples

    -

    The following will merge the entries in mergefoo.jar and mergebar.jar +

    The following will merge the entries in mergefoo.jar and mergebar.jar into out.jar. mac.jar and pc.jar will be added as single entries to out.jar.

    @@ -148,9 +148,9 @@ mac.jar and pc.jar will be added as single entries to out.jar.

    </jar>
    -

    Suppose the file foo.jar contains two entries: bar.class and +

    Suppose the file foo.jar contains two entries: bar.class and barnone/myClass.zip. -Suppose the path for file foo.jar is build/tempbuild/foo.jar. The +Suppose the path for file foo.jar is build/tempbuild/foo.jar. The following example will provide the entry tempbuild/foo.jar in the out.jar.

    @@ -171,7 +171,5 @@ namely bar.class and barnone/myClass.zip

    </jlink>
    - - diff --git a/manual/Tasks/jspc.html b/manual/Tasks/jspc.html index 1e84ace4f..678d02dda 100644 --- a/manual/Tasks/jspc.html +++ b/manual/Tasks/jspc.html @@ -80,7 +80,7 @@ and test your pages, all in one go.

    Parameters

    The Task has the following attributes:

    -
    Attribute Description
    compresswhether or not the output should be compressed. + whether or not the output should be compressed. true, yes, or on result in compressed output. If omitted, output will be uncompressed (inflated).
    mergefiles files to be merged into the output, if possible.At least one of + At least one of mergefiles or addfiles
    +
    @@ -242,7 +242,7 @@ a reference to an existing classpath Instructions to jasper to build an entire web application. The base directory must have a WEB-INF subdirectory beneath it. When used, the task hands off all dependency checking to the compiler. -
    Attribute Description
    +
    diff --git a/manual/Tasks/junit.html b/manual/Tasks/junit.html index a6879a89b..d4b594df1 100644 --- a/manual/Tasks/junit.html +++ b/manual/Tasks/junit.html @@ -21,7 +21,7 @@ -

    JUnit

    +

    JUnit

    Description

    This task runs tests from the JUnit testing framework. The latest @@ -71,7 +71,7 @@ FAQ for details. elements).

    Parameters

    -
    Attribute Description
    +
    @@ -152,7 +152,7 @@ elements).

    @@ -234,7 +234,7 @@ elements).

    formatter output to find the failing tests. since Ant 1.8.0 - +
    Attribute Description
    maxmemory Maximum amount of memory to allocate to the forked VM. - Ignored if fork is disabled. Note: + Ignored if fork is disabled. Note: If you get java.lang.OutOfMemoryError: Java heap space in some of your tests then you need to raise the size like maxmemory="128m" No
    enableTestListenerEvents Whether Ant should send fine grained information @@ -268,21 +268,21 @@ clean up, and still fail the build in the event of a failure.

    stack traces before reporting them. It works with both the plain and XML formatters. It filters out any lines that begin with the following string patterns:
    -   "junit.framework.TestCase"
    -   "junit.framework.TestResult"
    -   "junit.framework.TestSuite"
    -   "junit.framework.Assert."
    -   "junit.swingui.TestRunner"
    -   "junit.awtui.TestRunner"
    -   "junit.textui.TestRunner"
    -   "java.lang.reflect.Method.invoke("
    -   "sun.reflect."
    -   "org.apache.tools.ant."
    -   "org.junit."
    -   "junit.framework.JUnit4TestAdapter"
    -   " more"
    - -

    Nested Elements

    + "junit.framework.TestCase" + "junit.framework.TestResult" + "junit.framework.TestSuite" + "junit.framework.Assert." + "junit.swingui.TestRunner" + "junit.awtui.TestRunner" + "junit.textui.TestRunner" + "java.lang.reflect.Method.invoke(" + "sun.reflect." + "org.apache.tools.ant." + "org.junit." + "junit.framework.JUnit4TestAdapter" + " more" + +

    Nested Elements

    The <junit> task supports a nested <classpath> @@ -353,20 +353,20 @@ support it (i.e. Java 1.1).

    since Ant 1.6.

    permissions

    -

    Security permissions can be revoked and granted during the execution of the +

    Security permissions can be revoked and granted during the execution of the class via a nested permissions element. For more information please see permissions

    Settings will be ignored if fork is enabled.

    since Ant 1.6.

    - +

    assertions

    You can control enablement of Java 1.4 assertions with an <assertions> subelement.

    - +

    Assertion statements are currently ignored in non-forked mode.

    since Ant 1.6.

    @@ -407,14 +407,14 @@ can be specified.

    that your tests have written as some characters are illegal in XML documents and will be dropped.

    -

    The fourth formatter named failure (since Ant 1.8.0) +

    The fourth formatter named failure (since Ant 1.8.0) collects all failing testXXX() methods and creates a new TestCase which delegates only these failing methods. The name and the location can be specified via Java System property or Ant property -ant.junit.failureCollector. The value has to point to the directory and +ant.junit.failureCollector. The value has to point to the directory and the name of the resulting class (without suffix). It defaults to java-tmp-dir/FailedTests.

    - +
    @@ -450,14 +450,14 @@ the name of the resulting class (without suffix). It defaults to java-tmp-dir - +
    Attribute Descriptionunless Only use formatter if the named property is not set. No; default is true.

    test

    Defines a single test class.

    - +
    @@ -487,7 +487,7 @@ the name of the resulting class (without suffix). It defaults to java-tmp-dir is specified, then no test method from the suite will be executed.

    - +
    Attribute DescriptionNo; default is to run all test methods in the suite.
    fork Run the tests in a separate VM. @@ -581,7 +581,7 @@ generates a test class name for each resource that ends in prior to Ant 1.7 only <fileset> has been supported.

    - +
    @@ -697,8 +697,7 @@ supported.

    to your junit task.

    -

    ant.junit.enabletestlistenerevents - magic property

    +

    ant.junit.enabletestlistenerevents magic property

    Since Ant 1.8.2 the enableTestListenerEvents attribute of the task controls whether fine grained logging messages @@ -760,7 +759,7 @@ stopped if the test fails.

    Runs my.test.TestCase in the same VM, ignoring the given CLASSPATH; only a warning is printed if this test fails. In addition to the plain text test results, for this test a XML result -will be output to result.xml. +will be output to result.xml. Then, for each matching file in the directory defined for ${src.tests} a test is run in a separate VM. If a test fails, the build process is @@ -776,7 +775,7 @@ aborted. Results are collected in files named <delete> <fileset dir="${collector.dir}" includes="${collector.class}*.class"/> </delete> - <!-- compile the FailedTests class if present --> + <!-- compile the FailedTests class if present --> <javac srcdir="${collector.dir}" destdir="${collector.dir}"/> <available file="${collector.dir}/${collector.class}.class" property="hasFailingTests"/> <junit haltonerror="false" haltonfailure="false"> @@ -802,8 +801,8 @@ aborted. Results are collected in files named

    On the first run all tests are collected via the <batchtest/> element. Its plain formatter shows the output on the console. The -failure formatter creates a java source file in -${build.dir}/failingTests/FailedTests.java which extends +failure formatter creates a java source file in +${build.dir}/failingTests/FailedTests.java which extends junit.framework.TestCase and returns from a suite() method a test suite for the failing tests.
    On a second run the collector class exists and instead of the <batchtest/> diff --git a/manual/Tasks/junitreport.html b/manual/Tasks/junitreport.html index fea85e57b..c0219bee9 100644 --- a/manual/Tasks/junitreport.html +++ b/manual/Tasks/junitreport.html @@ -22,7 +22,7 @@ -

    JUnitReport

    +

    JUnitReport

    Description

    Merge the individual XML files generated by the JUnit task and eventually apply a stylesheet on the resulting merged document to provide a browsable report of @@ -39,10 +39,10 @@ href="http://xml.apache.org/xalan-j/">Xalan 2.4.1+ or Xalan XSLTC (JDK 1.4 contains a version of Xalan-J 2.x while JDK 1.5 ships with a version of XSLTC). Starting from JDK 1.4.2-01 it ships with a bundled Xalan-J 2.4.1+, meaning that JDK version prior to 1.4.2-01 won't work -out of the box. The table below summarize the compatibility status. +out of the box. The table below summarize the compatibility status.

    -
    Attribute Description
    - +
    XalanSun JDK BundleStatus
    +
    XalanSun JDK BundleStatus
    2.4.1+JDK 1.4.2-01+OK
    XSLTCJDK 1.5.xOK
    2.xJDK 1.4.xDEPRECATED
    Use ${ant.home}/etc/junit-frames-xalan1.xsl @@ -52,11 +52,11 @@ out of the box. The table below summarize the compatibility status.

    With Ant 1.6.2 we had to decide between supporting Xalan-J 1/Xalan J 2.4.1- and Xalan 2.4.1+/XSLTC, since there was no way to support both couples at the same time.

    -

    With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not +

    With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not available anymore for quite some time.

    Parameters

    - +
    @@ -75,7 +75,7 @@ available anymore for quite some time.

    Attribute Description No. Default to current directory
    -

    Nested Elements

    +

    Nested Elements

    fileset

    junitreport collects individual xml files generated by the JUnit task using the nested <FileSet> @@ -83,7 +83,7 @@ element.

    report

    Generate a browsable report based on the document created by the merge.

    Parameters

    - +
    @@ -113,7 +113,7 @@ element.

    Attribute Description No. Default to current directory
    -

    Ant assumes the following concerning the frames and noframes formats :

    +

    Ant assumes the following concerning the frames and noframes formats:

    The frames format uses a stylesheet which is generating output only by redirecting.

    The @@ -126,7 +126,7 @@ file called junit-noframes.html.

    Since Ant 1.7the report tag supports nested param tags. These tags can pass XSL parameters to the stylesheet.

    Parameters

    - +
    @@ -156,7 +156,7 @@ These tags can pass XSL parameters to the stylesheet.
    Attribute Description

    The built-in stylesheets support the following parameters:

    - +
    @@ -212,5 +212,4 @@ generate the default framed report in the directory report/html.

    The XSL parameters key1 and key2 will be passed to the XSL transformation.

    - diff --git a/manual/Tasks/length.html b/manual/Tasks/length.html index 18c62c768..bf577ad8f 100644 --- a/manual/Tasks/length.html +++ b/manual/Tasks/length.html @@ -29,9 +29,9 @@

    Display or set a property containing length information for a string, a file, or one or more nested Resource Collections. - Can also be used as a condition. Since Apache Ant 1.6.3

    + Can also be used as a condition. Since Apache Ant 1.6.3

    Parameters

    -
    XSL-Parameter Description
    +
    @@ -111,7 +111,7 @@ <fileset dir="." includes="foo,bar"/> </length> -

    Writes the file paths of foo and bar and their length into +

    Writes the file paths of foo and bar and their length into the property length.

    @@ -121,7 +121,5 @@ the property length.

    Adds the length of foo and bar and stores the result in property length.

    - - diff --git a/manual/Tasks/loadfile.html b/manual/Tasks/loadfile.html index 59291ed3a..eb27f7b0c 100644 --- a/manual/Tasks/loadfile.html +++ b/manual/Tasks/loadfile.html @@ -23,7 +23,7 @@ -

    LoadFile

    +

    LoadFile

    Description

    Specialization of loadresource that @@ -31,12 +31,12 @@ works on files exclusively and provides a srcFile attribute for convenience. Unless an encoding is specified, the encoding of the current locale is used.

    -

    If the resource content is empty (maybe after processing a filterchain) +

    If the resource content is empty (maybe after processing a filterchain) the property is not set.

    Parameters

    -
    Attribute Description
    +
    @@ -64,9 +64,9 @@ the property is not set.

    - @@ -88,7 +88,6 @@ can print this. This is identical to <file file="message.txt"/> </loadresource> -

        <loadfile property="encoded-file"
           srcFile="loadfile.xml"
    @@ -125,9 +124,5 @@ merging lines to ensure this happens.
     Load an XML file into a property, expanding all properties declared
     in the file in the process.
     
    -
    -
    -
     
     
    -
    diff --git a/manual/Tasks/loadproperties.html b/manual/Tasks/loadproperties.html
    index 69fa23a6c..d21027ace 100644
    --- a/manual/Tasks/loadproperties.html
    +++ b/manual/Tasks/loadproperties.html
    @@ -23,7 +23,7 @@
     
     
     
    -

    LoadProperties

    +

    LoadProperties

    Description

    Load a file's contents as Apache Ant properties. This is equivalent @@ -40,7 +40,7 @@ the <property> task.

    Parameters

    -
    Attribute Description
    quietDo not display a diagnostic message (unless Apache Ant has been + Do not display a diagnostic message (unless Apache Ant has been invoked with the -verbose or -debug - switches) or modify the exit status to reflect an error. Setting this to + switches) or modify the exit status to reflect an error. Setting this to "true" implies setting failonerror to "false". Since Ant 1.7.0.
    +
    @@ -134,7 +134,5 @@ Ant properties. Load contents of http://example.org/url.properties.gz, uncompress it on the fly and load the contents as Ant properties. - - diff --git a/manual/Tasks/loadresource.html b/manual/Tasks/loadresource.html index f2b20c06d..0e4ad77c9 100644 --- a/manual/Tasks/loadresource.html +++ b/manual/Tasks/loadresource.html @@ -23,7 +23,7 @@ -

    LoadResource

    +

    LoadResource

    Since Apache Ant 1.7

    @@ -41,7 +41,7 @@ processing a filterchain) the property is not set. of an existing property.

    Parameters

    -
    Attribute Description
    +
    @@ -64,9 +64,9 @@ processing a filterchain) the property is not set. - @@ -87,7 +87,5 @@ Load the entry point of Ant's homepage into property "homepage"; an

    For more examples see the loadfile task.

    - - diff --git a/manual/Tasks/local.html b/manual/Tasks/local.html index c7ed8fc4b..9b4b9bda1 100644 --- a/manual/Tasks/local.html +++ b/manual/Tasks/local.html @@ -40,7 +40,7 @@ in the buildfile. Since Ant 1.8

    precedes its definition. See the examples section.

    Parameters

    -
    Attribute Description
    quietDo not display a diagnostic message (unless Ant has been + Do not display a diagnostic message (unless Ant has been invoked with the -verbose or -debug - switches) or modify the exit status to reflect an error. Setting this to + switches) or modify the exit status to reflect an error. Setting this to "true" implies setting failonerror to "false". No, default "false"
    +
    @@ -183,4 +183,3 @@ step2: - diff --git a/manual/Tasks/macrodef.html b/manual/Tasks/macrodef.html index 60b307204..a5741f138 100644 --- a/manual/Tasks/macrodef.html +++ b/manual/Tasks/macrodef.html @@ -17,14 +17,14 @@ - + MacroDef Task -

    MacroDef

    +

    MacroDef

    Description

    This defines a new task using a <sequential> @@ -42,7 +42,7 @@ since Apache Ant 1.6

    Parameters

    -
    Attribute Description
    +
    @@ -88,7 +88,7 @@

    This attribute is placed in the body of the templated - task using a notation similar to the ant property notation + task using a notation similar to the Ant property notation - @{attribute name}. (May be remembered as "put the substitution AT this location").

    @@ -102,7 +102,7 @@ same as @{MyAttribute}.

    Parameters

    -
    Attribute Description
    +
    @@ -124,7 +124,7 @@ @@ -133,7 +133,7 @@ @@ -148,7 +148,7 @@ The case of the element name is ignored.

    Parameters

    -
    Attribute Descriptiondescription This contains a description of the attribute. - since ant 1.6.1 + Since Ant 1.6.1 No
    Controls whether or not property references in the attribute are expanded twice or just once. See the FAQ for details. - since Ant 1.8.3 + Since Ant 1.8.3 No; default true
    +
    @@ -175,7 +175,7 @@ any nested elements of the macrodef instance will be placed in the element indicated by the name of this element. There can only be one element if an element is implicit. - The default value is false. since ant 1.6.2 + The default value is false. Since Ant 1.6.2 @@ -184,7 +184,7 @@ @@ -201,7 +201,7 @@ The case of the text name is ignored.

    Parameters

    -
    Attribute Description No
    This contains a description informing the user what the contents of the element are expected to be. - since ant 1.6.1 + Since Ant 1.6.1 No
    +
    @@ -380,6 +380,5 @@ - diff --git a/manual/Tasks/mail.html b/manual/Tasks/mail.html index b59633d62..f98b14139 100644 --- a/manual/Tasks/mail.html +++ b/manual/Tasks/mail.html @@ -24,7 +24,7 @@ -

    Mail

    +

    Mail

    Description

    A task to send SMTP email. @@ -49,13 +49,13 @@

    Note: This task may depend on external libraries - that are not included in the Ant distribution. + that are not included in the Ant distribution. See Library Dependencies for more information.

    Parameters

    -
    Attribute Description
    +
    @@ -149,18 +149,18 @@ - - - @@ -193,7 +193,7 @@ - @@ -216,10 +216,10 @@ can contain email addresses of the form :

    Parameters specified as nested elements

    -

    to / cc / bcc / from/ replyto

    +

    to / cc / bcc / from/ replyto

    Adds an email address element. It takes the following attributes:

    -
    Attribute Description
    user user name for SMTP authYes, if SMTP auth is required on your SMTP server

    +
    Yes, if SMTP auth is required on your SMTP server
    the email message will be then sent using Mime and requires JavaMail
    password password for SMTP authYes, if SMTP auth is required on your SMTP server

    +
    Yes, if SMTP auth is required on your SMTP server
    the email message will be then sent using Mime and requires JavaMail
    ssl"true", "on" or "yes" accepted here

    +
    "true", "on" or "yes" accepted here
    indicates whether you need TLS/SSL
    No
    enableStartTLS"true", "on" or "yes" accepted here

    +
    "true", "on" or "yes" accepted here
    whether the STARTTLS command used to switch to an encrypted connection for authentication should be supported. Requires JavaMail. Since Ant 1.8.0
    +
    @@ -242,7 +242,7 @@ can contain email addresses of the form :

    Specifies the message to include in the email body. It takes the following attributes:

    -
    Attribute Description
    +
    @@ -287,7 +287,7 @@ the <message> element.

    Since Ant 1.7, arbitrary mail headers can be added by specifying these attributes on one or more nested header elements:

    -
    Attribute Description
    +
    @@ -356,7 +356,5 @@ will be replaced with the buildname property's value.

    Sends an eMail from me@myisp.com to all@xyz.com with a subject of Test Build, the message body being coded in UTF-8 - - diff --git a/manual/Tasks/manifest.html b/manual/Tasks/manifest.html index 7a5b98bcd..c6340cf3d 100644 --- a/manual/Tasks/manifest.html +++ b/manual/Tasks/manifest.html @@ -24,16 +24,14 @@ -

    Manifest

    +

    Manifest

    Description

    Creates a manifest file.

    This task can be used to write a Manifest file, optionally replacing or updating an existing file.

    - - -

    Manifests are processed according to the +

    Manifests are processed according to the Jar file specification.. Specifically, a manifest element consists of a set of attributes and sections. These sections in turn may contain @@ -52,14 +50,14 @@ line.

    If you find that Ant generates manifests incompatible with your runtime, take - a manifest it has built, fix it up however you need and switch to using the <zip> + a manifest it has built, fix it up however you need and switch to using the zip task to create the JAR, feeding in the hand-crafted manifest.

    Parameters

    -
    Attribute Description
    +
    @@ -104,10 +102,10 @@ line.

    Attribute Description

    Nested elements

    -

    attribute

    +

    attribute

    One attribute for the manifest file. Those attributes that are not nested into a section will be added to the "Main" section.

    - +
    @@ -132,7 +130,7 @@ not nested into a section will be added to the "Main" section.

    A manifest section - you can nest attribute elements into sections.

    -
    Attribute Description
    +
    @@ -156,7 +154,7 @@ href="#attribute">attribute elements into sections.

    <attribute name="Specification-Version" value="${version}"/> <attribute name="Specification-Vendor" value="Example Organization"/> <attribute name="Implementation-Title" value="common"/> - <attribute name="Implementation-Version" value="${version} ${TODAY}"/> + <attribute name="Implementation-Version" value="${version} ${TODAY}"/> <attribute name="Implementation-Vendor" value="Example Corp."/> </section> <section name="common/class1.class"> @@ -168,7 +166,7 @@ href="#attribute">attribute elements into sections.

    Creates or replaces the file MANIFEST.MF. Note that the Built-By attribute will take the value of the Ant property ${user.name}. The same is true for the ${version} and ${TODAY} properties. This example -produces a MANIFEST.MF that contains +produces a MANIFEST.MF that contains package version identification for the package common.

    @@ -191,7 +189,5 @@ Sealed: false - - diff --git a/manual/Tasks/manifestclasspath.html b/manual/Tasks/manifestclasspath.html index 2c193b8a3..d43fcb7d2 100644 --- a/manual/Tasks/manifestclasspath.html +++ b/manual/Tasks/manifestclasspath.html @@ -24,7 +24,7 @@ -

    Manifestclasspath

    +

    Manifestclasspath

    Description

    Converts a Path into a property @@ -54,7 +54,7 @@ defined property is re-referenced.

    since Apache Ant 1.7

    Parameters

    -
    Attribute Description
    +
    @@ -105,13 +105,11 @@ This classpath must not be empty, and is required.

    Assuming a path of id "classpath" was already defined, convert this path relatively to the build/ directory that will contain acme.jar, which - can later be created with <jar> with a nested + can later be created with <jar> with a nested <manifest> element that lists an - <attribute name="Class-Path" value="${jar.classpath}" />. + <attribute name="Class-Path" value="${jar.classpath}"/>.

    - - diff --git a/manual/Tasks/mimemail.html b/manual/Tasks/mimemail.html index ba066a6b6..4c2a4aeec 100644 --- a/manual/Tasks/mimemail.html +++ b/manual/Tasks/mimemail.html @@ -24,7 +24,7 @@ -

    MimeMail

    +

    MimeMail

    Deprecated

    This task has been deprecated. Use the mail task instead.

    @@ -36,7 +36,7 @@ and Java Activation Framework are required for this task.

    Multiple files can be attached using FileSets.

    Parameters

    -
    Attribute Description
    +
    @@ -109,7 +109,5 @@ Activation Framework are required for this task.

    </mimemail> - - diff --git a/manual/Tasks/mkdir.html b/manual/Tasks/mkdir.html index 5d945c0f1..5de189960 100644 --- a/manual/Tasks/mkdir.html +++ b/manual/Tasks/mkdir.html @@ -24,12 +24,12 @@ -

    Mkdir

    +

    Mkdir

    Description

    Creates a directory. Also non-existent parent directories are created, when necessary. Does nothing if the directory already exist.

    Parameters

    -
    Attribute Description
    +
    @@ -47,6 +47,5 @@ necessary. Does nothing if the directory already exist.

    <mkdir dir="${dist}/lib"/>

    creates a directory ${dist}/lib.

    - diff --git a/manual/Tasks/move.html b/manual/Tasks/move.html index c4f931ad9..db49ba55a 100644 --- a/manual/Tasks/move.html +++ b/manual/Tasks/move.html @@ -24,7 +24,7 @@ -

    Move

    +

    Move

    Description

    Moves a file to a new file or directory, or collections of files to a new directory. By default, the @@ -47,7 +47,7 @@ set.

    there is a directory by the same name in todir, the action will fail.

    Parameters

    -
    Attribute Description
    +
    @@ -252,7 +252,5 @@ in a directory.

    </move> - - diff --git a/manual/Tasks/native2ascii.html b/manual/Tasks/native2ascii.html index 101771489..f187cd376 100644 --- a/manual/Tasks/native2ascii.html +++ b/manual/Tasks/native2ascii.html @@ -15,8 +15,10 @@ limitations under the License. --> - -Native2Ascii Task + + + Native2Ascii Task +

    Native2Ascii

    @@ -57,20 +59,22 @@ and <patternset> elements.

    -

    It is possible to use different converters. This can be selected - with the implementation attribute or a nested element. - Here are the choices of the attribute:

    +

    + It is possible to use different converters. This can be selected + with the implementation attribute or a nested + element. Here are the choices of the attribute: +

    • default - the default converter for the platform - kaffee when run on Kaffee, builtin otherwise.
    • sun (used to be the standard converter of the JDK < 9)
    • kaffe (the standard converter of Kaffe)
    • -
    • builtin - Ant's internal implementation. since ant +
    • builtin - Ant's internal implementation. Since Ant 1.9.8
    -
    Attribute Description
    +
    @@ -156,7 +160,7 @@ specified like Command-line Arguments but have an additional attribute that can be used to enable arguments only if a given converter implementation will be used.

    -
    Attribute Description
    +
    @@ -245,6 +249,6 @@ only if a given converter implementation will be used.

    in which case your native2ascii adapter can support attributes and nested elements of its own.

    - + diff --git a/manual/Tasks/netrexxc.html b/manual/Tasks/netrexxc.html index efdfa4dcd..bf1104c01 100644 --- a/manual/Tasks/netrexxc.html +++ b/manual/Tasks/netrexxc.html @@ -24,7 +24,7 @@ -

    NetRexxC

    +

    NetRexxC

    Description

    Compiles a NetRexx source tree within the running (Apache Ant) VM.

    @@ -63,7 +63,7 @@ included in the Apache Ant distribution. See +
    Attribute Description
    @@ -335,7 +335,5 @@ for more information.

    - - diff --git a/manual/Tasks/nice.html b/manual/Tasks/nice.html index 03c0eaaaa..c3e1156fc 100644 --- a/manual/Tasks/nice.html +++ b/manual/Tasks/nice.html @@ -24,12 +24,12 @@ -

    Nice

    +

    Nice

    Description

    Provide "nice-ness" to the current thread and/or query the current value.

    Parameters

    -
    Attribute Description
    +
    @@ -64,7 +64,5 @@ priority in the user property "currentpriority". This can be used to set the priority back to its original value later.

    - - diff --git a/manual/Tasks/pack.html b/manual/Tasks/pack.html index b673333df..92c615720 100644 --- a/manual/Tasks/pack.html +++ b/manual/Tasks/pack.html @@ -24,7 +24,7 @@ -

    GZip/BZip2

    +

    GZip/BZip2/XZ

    Description

    Packs a resource using the GZip, BZip2 or XZ algorithm. The output file is only generated if it doesn't exist or the source @@ -36,7 +36,7 @@ See Library Dependencies for more information.

    Parameters

    -
    Attribute Description
    +
    @@ -80,6 +80,5 @@ resource collection

    downloads http://example.org/archive.tar and compresses it to archive.tar.gz in the project's basedir on the fly.

    - diff --git a/manual/Tasks/parallel.html b/manual/Tasks/parallel.html index 362daf373..ce032c14b 100644 --- a/manual/Tasks/parallel.html +++ b/manual/Tasks/parallel.html @@ -28,12 +28,12 @@

    Description

    Executes nested tasks in parallel with no guarantees of thread safety. - Every task will run in its own thread, with the likelihood of + Every task will run in its own thread, with the likelihood of concurrency problems scaling with the number of CPUs on the host system.

    -

    Warning: While the Apache Ant core is believed to be thread safe, no such +

    Warning: While the Apache Ant core is believed to be thread safe, no such guarantees are made about tasks, which are not tested for thread safety during - Ant's test process. + Ant's test process. Third party tasks may or may not be thread safe, and some of Ant's core tasks, such as <javac> are definitely not re-entrant. This is because they use libraries that were never designed to be used in a multithreaded environment. @@ -44,16 +44,16 @@ same time. Anyone trying to run large Ant task sequences in parallel, such as javadoc and javac at the same time, is implicitly taking on the task of identifying and fixing all concurrency bugs the tasks that they run. - +

    Accordingly, while this task has uses, it should be considered an advanced task which should be used in certain batch-processing or testing situations, - rather than an easy trick to speed up build times on a multiway CPU. + rather than an easy trick to speed up build times on a multiway CPU.

    Parameters

    -
    Attribute Description
    +
    @@ -130,13 +130,13 @@ processors (there is no affinity to a particular processor however). This will override the value in threadCount. If threadsPerProcessor is specified on any older JVM, then the value in threadCount will be used as is.

    -

    When using threadCount and threadsPerProcessor - care should be taken to ensure that the build does not deadlock. +

    When using threadCount and threadsPerProcessor + care should be taken to ensure that the build does not deadlock. This can be caused by tasks such as waitfor - taking up all available threads before the tasks that would unlock the + taking up all available threads before the tasks that would unlock the waitfor would occur. This is not a replacement for Java Language level thread -semantics and is best used for "embarassingly parallel" tasks.

    +semantics and is best used for "embarrassingly parallel" tasks.

    Parameters specified as nested elements

    @@ -169,7 +169,7 @@ terminated from Ant. By using <daemons> such servers do not h </parallel>

    This example represents a typical pattern for testing a server application. -In one thread the server is started (the <wlrun> task). +In one thread the server is started (the <wlrun> task). The other thread consists of a three tasks which are performed in sequence. The <sleep> task is used to give the server time to come up. Another task which is capable of validating @@ -191,8 +191,8 @@ resource utilization during the build. In this instance, some servlets are being compiled in one thead and a set of JSPs is being precompiled in another. Developers need to be careful that the two tasks are independent, both in terms of their dependencies and in terms of their potential interactions in -Ant's external environment. Here we set fork="true" for the -<javac> task, so that it runs in a new process; +Ant's external environment. Here we set fork="true" for the +<javac> task, so that it runs in a new process; if the <wljspc> task used the javac compiler in-VM (it may), concurrency problems may arise.

    @@ -206,7 +206,7 @@ if the <wljspc> task used the javac compiler in-VM </java> </sequential> </macrodef> - + <parallel threadCount="4"> <dbpurge file="db/one" /> <dbpurge file="db/two" /> @@ -223,13 +223,11 @@ if the <wljspc> task used the javac compiler in-VM

    This example represents a typical need for use of the threadCount and threadsPerProcessor attributes. Spinning up all 40 of those tasks could cripple 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 candidate for use of threadCount (and possibly threadsPerProcessor) because each task is independent (every new JVM is forked) and has no dependencies on the other tasks.

    - - diff --git a/manual/Tasks/patch.html b/manual/Tasks/patch.html index 96a5ee9a4..611c0e8fe 100644 --- a/manual/Tasks/patch.html +++ b/manual/Tasks/patch.html @@ -24,63 +24,62 @@ -

    Patch

    +

    Patch

    Description

    -

    Applies a diff file to originals. ; requires "patch" to be - on the execution path.

    +

    Applies a diff file to originals. Requires "patch" to be on the execution path.

    Parameters

    -
    Attribute Description
    +
    - + - + - - + - + - + - - + - + - - + - + @@ -102,10 +101,8 @@ the diff output looked like

     --- a/mod1.0/A	Mon Jun  5 17:28:41 2000
     +++ a/mod1.1/A	Mon Jun  5 17:28:49 2000
    -
    + the leading a/ will be stripped. - - diff --git a/manual/Tasks/pathconvert.html b/manual/Tasks/pathconvert.html index 41f56f471..d1485ec8f 100644 --- a/manual/Tasks/pathconvert.html +++ b/manual/Tasks/pathconvert.html @@ -24,7 +24,7 @@ -

    Pathconvert

    +

    Pathconvert

    Description

    Converts nested ResourceCollections, or a reference to just one, into a path @@ -38,11 +38,11 @@ of files in a FileList into a path. drive letters to Unix paths, and vice-versa.

    More complex transformations can be achieved using a nested <mapper> -(since Apache Ant 1.6.2). +(since Apache Ant 1.6.2).

    Parameters

    -
    Attribute Description Required
    patchfilepatchfile the file that includes the diff output Yes
    originalfileoriginalfile the file to patchNo, tries to guess it from the diff + No, tries to guess it from the diff file
    destfiledestfile the file to send the output to instead of patching the file(s) in place. since Apache Ant 1.6 No.
    backupsbackups Keep backups of the unpatched files No
    quietquiet Work silently unless an error occurs No
    reverseAssume patch was created with old and new files + reverseAssume patch was created with old and new files swapped. No
    ignorewhitespaceignorewhitespace Ignore whitespace differences. No
    stripStrip the smallest prefix containing num leading + stripStrip the smallest prefix containing num leading slashes from filenames. No
    dirdir The directory in which to run the patch command. No, default is the project's basedir.
    +
    @@ -51,7 +51,7 @@ drive letters to Unix paths, and vice-versa.

    - +
    Attribute Description
    targetos - The target architecture. Must be one of 'unix', 'windows', + The target architecture. Must be one of 'unix', 'windows', 'netware', 'tandem' or 'os/2'. This is a shorthand mechanism for specifying both pathsep and dirsep @@ -98,14 +98,14 @@ drive letters to Unix paths, and vice-versa.

    preserveduplicatesWhether to preserve duplicate resources. Since Ant 1.8Whether to preserve duplicate resources. Since Ant 1.8 No; default "false".

    Parameters specified as nested elements

    map

    Specifies the mapping of path prefixes between Unix and Windows.

    - +
    @@ -115,7 +115,7 @@ drive letters to Unix paths, and vice-versa.

    Attribute Description from The prefix to match. Note that this value is case-insensitive when - the build is running on a Windows platform and case-sensitive + the build is running on a Windows platform and case-sensitive when running on a Unix platform. Since Ant 1.7.0, on Windows this value is also insensitive to the slash style used for directories, one can use '/' or '\'. @@ -136,8 +136,8 @@ drive letters to Unix paths, and vice-versa.

    Note: The map elements are applied in the order specified, and only the first matching map element is applied. So, the ordering of your map elements can be important, if any from values are -prefixes of other from values. -

    +prefixes of other from values. +

    Resource Collections

    If the refid attribute is not specified, then one or more nested Resource @@ -145,7 +145,7 @@ Collections must be supplied.

    mapper

    A single nested <mapper> element can be specified -to perform any of various filename transformations (since Ant 1.6.2). +to perform any of various filename transformations (since Ant 1.6.2).

    Examples

    @@ -161,15 +161,15 @@ has the value <pathelement location="${wl.home}/mssqlserver4/classes"/> <pathelement location="c:\winnt\System32"/> </path> - + <pathconvert targetos="unix" property="wl.path.unix" refid="wl.path"> <map from="${wl.home}" to="${wl.home.unix}"/> <map from="c:" to=""/> </pathconvert> -

    will generate the path shown below -and store it in the property named wl.path.unix. -

    +

    +will generate the path shown below and store it in the property named wl.path.unix. +

     /weblogic/lib/weblogicaux.jar:/weblogic/classes:/weblogic/mssqlserver4/classes:/WINNT/SYSTEM32
     
    @@ -197,7 +197,7 @@ will convert the list of files to the following Unix path: <fileset dir="${src.dir}" id="src.files"> <include name="**/*.java"/> </fileset> - + <pathconvert pathsep="," property="javafiles" refid="src.files"/>

    This example takes the set of files determined by the fileset (all files ending @@ -220,5 +220,3 @@ list of files.

    - - diff --git a/manual/Tasks/presetdef.html b/manual/Tasks/presetdef.html index c7f381c0a..d975bf953 100644 --- a/manual/Tasks/presetdef.html +++ b/manual/Tasks/presetdef.html @@ -15,21 +15,16 @@ limitations under the License. --> - + - + -PreSetDef Task - + PreSetDef Task - + - -

    PreSetDef

    + +

    PreSetDef

    Description

    The preset definition generates a new definition @@ -45,7 +40,7 @@ when the preset definition is defined.

    Parameters

    - +
    @@ -70,7 +65,7 @@ This nested element can be any other type or task. The attributes and elements that need to be preset are placed here.

    - +

    Examples

    The following fragment defines a javac task with the debug, deprecation srcdir and destdir @@ -177,8 +172,6 @@ properties to be available in child builds run with </macrodef> <showmessage-presetdef messageval="${message}"/> -
    - + - diff --git a/manual/Tasks/projecthelper.html b/manual/Tasks/projecthelper.html index ea78eb2e0..986bf76f6 100644 --- a/manual/Tasks/projecthelper.html +++ b/manual/Tasks/projecthelper.html @@ -35,7 +35,7 @@ the default one (ProjectHelper2)

    See the description of Apache Ant's Project Helper for more information.

    -

    Since Ant 1.8.2

    +

    Since Ant 1.8.2

    Parameters specified as nested elements

    @@ -56,4 +56,3 @@ You may specify many configured org.apache.tools.ant.ProjectHelper - diff --git a/manual/Tasks/property.html b/manual/Tasks/property.html index 7dc90a754..8ff6543e8 100644 --- a/manual/Tasks/property.html +++ b/manual/Tasks/property.html @@ -24,7 +24,7 @@ -

    Property

    +

    Property

    Description

    Sets a property (by name and value), or set of properties (from file or @@ -60,11 +60,11 @@ This also holds for properties loaded from a property file.

    href="../properties.html#built-in-props">here.

    Since Apache Ant 1.8.0 it is possible to load properties defined in xml according to Suns DTD, -if Java5+ is present. For this the name of the file, resource or url has +if Java 5+ is present. For this the name of the file, resource or url has to end with .xml.

    Parameters

    -
    Attribute Description
    +
    @@ -177,7 +177,7 @@ SYSTEM).

    Any OS except OpenVMS

    -

    Starting with Ant 1.8.2 if Ant detects it is running of a Java 1.5 +

    Starting with Ant 1.8.2 if Ant detects it is running of a Java 5 VM (or better) Ant will use System.getenv rather than its own OS dependent native implementation. For some OSes this causes minor differences when compared to older versions of Ant. @@ -288,58 +288,56 @@ deploy.port=8080 deploy.url=http://${deploy.server}:${deploy.port}/ - - -

    Notes about environment variables

    +

    Notes about environment variables

    - Ant runs on Java 1.2 therefore it cannot use Java5 features for accessing environment + Ant runs on Java 1.2 therefore it cannot use Java 5 features for accessing environment variables. So it starts a command in a new process which prints the environment variables, - analyzes the output and creates the properties.
    + analyzes the output and creates the properties.
    There are commands for the following operating systems implemented in Execute.java (method getProcEnvCommand()): +

    Attribute Description
    - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    OS command
    os/2 cmd /c set os/2cmd /c set
    windows windows
    * win9x command.com /c set * win9xcommand.com /c set
    * other cmd /c set * othercmd /c set
    z/os /bin/env OR /usr/bin/env OR env (depending on read rights) z/os/bin/env OR /usr/bin/env OR env (depending on read rights)
    unix /bin/env OR /usr/bin/env OR env (depending on read rights) unix/bin/env OR /usr/bin/env OR env (depending on read rights)
    netware env netwareenv
    os/400 env os/400env
    openvms show logical openvmsshow logical
    -

    diff --git a/manual/Tasks/propertyfile.html b/manual/Tasks/propertyfile.html index e4030f89d..871413145 100644 --- a/manual/Tasks/propertyfile.html +++ b/manual/Tasks/propertyfile.html @@ -24,9 +24,8 @@

    PropertyFile

    - -
    -

    Introduction

    +
    +

    Introduction

    Apache Ant provides an optional task for editing property files. This is very useful when wanting to make unattended modifications to configuration files for application servers and @@ -40,10 +39,10 @@ file are preserved.

    In general, linefeeds of the updated file will be the same as the first linefeed found when reading it.

    -
    -

    PropertyFile Task

    +
    +

    PropertyFile Task

    Parameters

    - +
    @@ -73,10 +72,10 @@ previous behaviour of the task, in which the layout and any comments in the properties file were lost by the task.

    Parameters specified as nested elements

    -

    Entry

    +

    Entry

    Use nested <entry> elements to specify actual modifications to the property file itself.

    -
    Attribute Description
    +
    @@ -156,7 +155,6 @@ operation occurs after these rules are considered.

  • If value and default are both specified and the property did not exist in the property file, the property is set to default.
  • -

     

    Examples

    @@ -186,7 +184,7 @@ formated.int=0014 formated.date=243 13\:47

    -The slashes conform to the expectations of the Properties class. The file will be stored in a manner so that each character is examined and escaped if necessary. +The slashes conform to the expectations of the Properties class. The file will be stored in a manner so that each character is examined and escaped if necessary.

    @@ -228,7 +226,7 @@ Concatenation of strings :

    Each time called, a "." will be appended to "progress"

    -

    Pumps the project version to the next minor version (increase minor and set path=0): +

    Pumps the project version to the next minor version (increase minor and set path=0):

    <target name="nextMinorVersion">
        <property
          name="header"
    @@ -242,8 +240,6 @@ Concatenation of strings :

    </target>
    After running this target the version changed e.g. from 3.2.2 to 3.3.0. -

    - diff --git a/manual/Tasks/propertyhelper.html b/manual/Tasks/propertyhelper.html index 6c73b0be7..5b4cf343f 100644 --- a/manual/Tasks/propertyhelper.html +++ b/manual/Tasks/propertyhelper.html @@ -51,7 +51,7 @@ subinterface in order to do anything meaningful. is also provided:

    Parameters
    -
    Attribute Description
    +
    @@ -105,4 +105,3 @@ is also provided:

    - diff --git a/manual/Tasks/pvcstask.html b/manual/Tasks/pvcstask.html index a95b32ece..726f5d986 100644 --- a/manual/Tasks/pvcstask.html +++ b/manual/Tasks/pvcstask.html @@ -14,18 +14,15 @@ See the License for the specific language governing permissions and limitations under the License. --> - - PVCS task -

    -Apache Ant Pvcs Task User Manual

    +

    Apache Ant Pvcs Task User Manual

    Note: Before using this task, the user running Ant must have access to the @@ -47,160 +44,158 @@ Version 1.1 - 2001/06/27
    Version 1.0 - 2001/01/31

    Initial release.


    -

    -Table of Contents

    +

    Table of Contents

    -
    +
    -

    Introduction

    +

    Introduction

    The pvcs task allows the user of Ant to extract the latest edition of the source code from a PVCS repository. PVCS is a version control system developed by Merant.
    This version has been tested against PVCS version 6.5 and 6.6 under Windows and Solaris. -
    -

    Pvcs Task

    +
    +

    Pvcs Task

    Description

    The pvcs task is set to point at a PVCS repository and optionally a project within that repository, and can from that specification get the latest version of the files contained by the repository. -

    -Parameters

    +

    Parameters

    -
    Attribute Description
    +
    - + - + - + - + - - + - + - - + - + - + - + - + - - + - + - - + - + - + - + - + - - + - + - - + - - + - + - - + - + - - + - + - - + - + - - - + + + - - - + + +
    AttributeAttributeDescriptionDescriptionRequiredRequired
    repositoryrepositoryThe location of the repository (see your PVCS +The location of the repository (see your PVCS manuals)YesYes
    pvcsprojectpvcsprojectThe project within the PVCS repository to extract +The project within the PVCS repository to extract files from ("/" is root project and that is default if this attribute isn't specified)NoNo
    labellabelOnly files marked with this label are extracted.Only files marked with this label are extracted.NoNo
    promotiongrouppromotiongroupOnly files within this promotion group are extracted. Using +Only files within this promotion group are extracted. Using both the label and the promotiongroup tag will cause the files in the promotion group and with that label to be extracted. NoNo
    configconfigpath of a non default .cfg file. +path of a non default .cfg file. Can be given absolute or relative to Ant's base directory. NoNo
    forceforceIf set to yes all files that exists and are writable are overwritten. Default no causes the files that are writable to be ignored. This stops the PVCS command get to stop asking questions!If set to yes all files that exists and are writable are overwritten. Default no causes the files that are writable to be ignored. This stops the PVCS command get to stop asking questions!NoNo
    workspaceworkspaceBy specifying a workspace, the files are extracted to that location. A PVCS workspace is a +By specifying a workspace, the files are extracted to that location. A PVCS workspace is a name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace using the PVCS GUI clients. If this isn't specified the default workspace for the current user is used.NoNo
    pvcsbinpvcsbinOn some systems the PVCS executables pcli +On some systems the PVCS executables pcli and get are not found in the PATH. In such cases this attribute should be set to the bin directory of the PVCS installation containing the executables mentioned before. If this attribute isn't specified the tag expects the executables to be found using the PATH environment variable.NoNo
    ignorereturncodeIf set to true the return value from executing + ignorereturncodeIf set to true the return value from executing the pvcs commands are ignored.NoNo
    updateonlyIf set to true files are gotten only if + updateonlyIf set to true files are gotten only if newer than existing local files.NoNo
    filenameformatThe format of your folder names in a + filenameformatThe format of your folder names in a format suitable for java.text.MessageFormat. Defaults to {0}-arc({1}). Repositories where the archive extension is not -arc should set this.NoNo
    linestartUsed to parse the output of the pcli + linestartUsed to parse the output of the pcli command. It defaults to "P:. The parser already knows about / and \\, this property is useful in cases where the repository is accessed on a Windows platform via a drive letter mapping.NoNo
    revisionRetrieve the specified revision.NorevisionRetrieve the specified revision.No
    useridUse the specified userid.NouseridUse the specified userid.No
    -

    Nested Elements

    +

    Nested Elements

    -

    pvcsproject element

    +

    pvcsproject element

    pvcs supports a nested <pvcsproject> element, that represents a project within the PVCS repository to extract files from. By nesting multiple @@ -210,21 +205,21 @@ specified.

    Parameters

    - +
    - + - + - + - + - + - +
    AttributeAttributeDescriptionDescriptionRequiredRequired
    namenameThe name of the pvcs projectThe name of the pvcs projectYesYes
    @@ -236,7 +231,7 @@ The following set-up extracts the latest version of the files in the pvcs reposi <!-- =================================================================== --> <target name="getlatest"> <pvcs repository="/mnt/pvcs" pvcsproject="/myprj"/> - </target> + </target>

    Now run:

    ant getlatest @@ -267,7 +262,7 @@ repository from two projects using nested <pvcsproject> eleme <pvcsproject name="/myprj"/> <pvcsproject name="/myprj2"/> </pvcs> - </target> + </target>

    Now run:

    ant getlatest2 @@ -289,7 +284,7 @@ repository from two projects using nested <pvcsproject> eleme Total time: 22 seconds -
    +

    PVCS is a registered trademark of MERANT.

    diff --git a/manual/Tasks/recorder.html b/manual/Tasks/recorder.html index dfbfc0d5a..5066887cb 100644 --- a/manual/Tasks/recorder.html +++ b/manual/Tasks/recorder.html @@ -24,7 +24,7 @@ -

    Record

    +

    Record

    Description

    A recorder is a listener to the current build process that records the output to a file.

    @@ -42,7 +42,7 @@ events (buildFinished, targetFinished and taskFinished), and is closed on a buildFinished event.

    Parameters

    - +
    @@ -115,7 +115,7 @@ recorders: one to file "records-simple.log" at logging level inf

    Notes

    There is some functionality that I would like to be able to add in the future. They include things like the following:

    -
    Attribute Description
    +
    @@ -164,9 +164,5 @@ future. They include things like the following:

    Attribute Description
    - - - - diff --git a/manual/Tasks/rename.html b/manual/Tasks/rename.html index 330fbe3a8..d2442fd07 100644 --- a/manual/Tasks/rename.html +++ b/manual/Tasks/rename.html @@ -24,13 +24,13 @@ -

    Rename

    +

    Rename

    Deprecated

    This task has been deprecated. Use the Move task instead.

    Description

    Renames a given file.

    Parameters

    - +
    @@ -53,12 +53,10 @@
    Attribute Description

    Examples

    -
      <rename src="foo.jar" dest="${name}-${version}.jar"/>
    +
      <rename src="foo.jar" dest="${name}-${version}.jar"/>

    Renames the file foo.jar to ${name}-${version}.jar (assuming name and version being predefined properties). If a file named ${name}-${version}.jar already exists, it will be removed prior to renaming foo.jar.

    - - diff --git a/manual/Tasks/renameextensions.html b/manual/Tasks/renameextensions.html index ed3bfbba0..d54d1fad1 100644 --- a/manual/Tasks/renameextensions.html +++ b/manual/Tasks/renameextensions.html @@ -24,7 +24,7 @@ -

    RenameExtensions

    +

    RenameExtensions

    Deprecated

    This task has been deprecated. Use the move task with a glob mapper instead.

    @@ -43,7 +43,7 @@ supports most attributes of <fileset> <include>, <exclude> and <patternset> elements.

    Parameters

    - +
    @@ -116,8 +116,5 @@ supports most attributes of <fileset>

    - - - diff --git a/manual/Tasks/replace.html b/manual/Tasks/replace.html index 36204d0cb..ef8f1831e 100644 --- a/manual/Tasks/replace.html +++ b/manual/Tasks/replace.html @@ -24,19 +24,19 @@ -

    Replace

    +

    Replace

    Description

    -

    Replace is a directory based task for replacing the occurrence of a given string with another string +

    Replace is a directory based task for replacing the occurrence of a given string with another string in selected file.

    If you want to replace a text that crosses line boundaries, you must use a nested <replacetoken> element.

    The output file is only written if it differs from the existing file. This prevents spurious rebuilds based on unchanged files which -have been regenerated by this task.

    +have been regenerated by this task.

    Parameters

    -
    Attribute Description
    +
    @@ -49,7 +49,7 @@ have been regenerated by this task.

    - @@ -72,8 +72,8 @@ have been regenerated by this task.

    - @@ -150,7 +150,7 @@ nested <include>, <exclude> and cross line boundaries, you can use nested elements to specify them.

    The elements support attributes:

    -
    Attribute Description
    dirThe base directory to use when replacing a token in + The base directory to use when replacing a token in multiple files.
    summaryIndicates whether a summary of the replace operation - should be produced, detailing how many token occurrences + Indicates whether a summary of the replace operation + should be produced, detailing how many token occurrences and files were processed No, by default no summary is produced
    +
    @@ -186,7 +186,7 @@ token]]></replacevalue>

    replacefilter

    In addition to allowing for multiple replacements, optional nested <replacefilter> elements allow replacement values to be extracted from a property file. The name of this file is specified using the <replace> attribute propertyFile.

    -
    Attribute Description
    +
    @@ -214,20 +214,20 @@ token]]></replacevalue>

    Examples

    -<replace 
    +<replace
         file="configure.sh"
         value="defaultvalue"
         propertyFile="src/name.properties">
    -  <replacefilter 
    +  <replacefilter
         token="@token1@"/>
    -  <replacefilter 
    -    token="@token2@" 
    +  <replacefilter
    +    token="@token2@"
         value="value2"/>
    -  <replacefilter 
    -    token="@token3@" 
    +  <replacefilter
    +    token="@token3@"
         property="property.key"/>
       <replacefilter>
    -    <replacetoken>@token4@</replacetoken> 
    +    <replacetoken>@token4@</replacetoken>
         <replacevalue>value4</replacevalue>
       </replacefilter>
     </replace>
    @@ -239,4 +239,3 @@ token]]></replacevalue>
     
     
     
    -
    diff --git a/manual/Tasks/replaceregexp.html b/manual/Tasks/replaceregexp.html
    index eed4c84c4..f0b612b57 100644
    --- a/manual/Tasks/replaceregexp.html
    +++ b/manual/Tasks/replaceregexp.html
    @@ -23,7 +23,7 @@
     
     
     
    -

    ReplaceRegExp

    +

    ReplaceRegExp

    Description

    ReplaceRegExp is a directory based task for replacing the occurrence of a given regular expression with a substitution pattern @@ -31,16 +31,16 @@ in a selected file or set of files.

    The output file is only written if it differs from the existing file. This prevents spurious rebuilds based on unchanged files which -have been regenerated by this task.

    +have been regenerated by this task.

    Similar to regexp type mappers this task needs a supporting regular expression library and an implementation of org.apache.tools.ant.util.regexp.Regexp. -See details in the documentation of the Regexp Type.

    +See details in the documentation of the Regexp Type.

    Parameters

    -
    Attribute Description
    +
    @@ -151,21 +151,20 @@ value, in all files ending in .properties in the current directory< </replaceregexp>

    replaces all whitespaces (blanks, tabs, etc) by one blank remaining the -line separator. So with input +line separator. So with input

     <html>    <body>
    -<<TAB>><h1>    T E S T   </h1>  <<TAB>>    
    +<<TAB>><h1>    T E S T   </h1>  <<TAB>>
     <<TAB>> </body></html>
     
    -would converted to +

    would converted to

     <html> <body>
      <h1> T E S T </h1> </body></html>
     
    -


    @@ -174,12 +173,12 @@ would converted to </replaceregexp>

    replaces all \n markers (beware the quoting of the backslash) by a line break. -So with input +So with input

     one\ntwo\nthree
     
    -would converted to +

    would converted to

     one
    @@ -187,7 +186,7 @@ two
     three
     
    -Beware that inserting line breaks could break file syntax. For example in xml: +

    Beware that inserting line breaks could break file syntax. For example in xml:

     <root>
    @@ -196,10 +195,6 @@ Beware that inserting line breaks could break file syntax. For example in xml:
     </root>
     
    -

    - - - diff --git a/manual/Tasks/resourcecount.html b/manual/Tasks/resourcecount.html index a34506b13..c463631ef 100644 --- a/manual/Tasks/resourcecount.html +++ b/manual/Tasks/resourcecount.html @@ -31,7 +31,7 @@ Resource Collection. Can also be used as a condition. Since Apache Ant 1.7

    Parameters

    -
    Attribute Description
    +
    @@ -101,7 +101,5 @@ in the property named count.foo.

    Stores the number of lines of the current buildfile in the property file.lines. Requires Ant 1.7.1+ as <concat> has to be resource.

    - - diff --git a/manual/Tasks/retry.html b/manual/Tasks/retry.html index af68d40a6..360019fa1 100644 --- a/manual/Tasks/retry.html +++ b/manual/Tasks/retry.html @@ -29,18 +29,18 @@ its retrycount has been exceeded. If this happens a BuildException is t Since Apache Ant 1.7.1

    Parameters

    -
    Attribute Description
    - +
    + - + - + @@ -52,7 +52,7 @@ its retrycount has been exceeded. If this happens a BuildException is t

    Example

     <retry retrycount="3">
    -  <get src="http://www.unreliable-server.com/unreliable.tar.gz" 
    +  <get src="http://www.unreliable-server.com/unreliable.tar.gz"
            dest="/home/retry/unreliable.tar.gz" />
     </retry>
     
    diff --git a/manual/Tasks/rexec.html b/manual/Tasks/rexec.html index 02f6fe23a..2aed66af0 100644 --- a/manual/Tasks/rexec.html +++ b/manual/Tasks/rexec.html @@ -24,7 +24,7 @@ -

    RExec

    +

    RExec

    Description

    Task to automate a remote rexec session. Just like the Telnet task, it uses nested <read> to indicate strings to wait for, and @@ -39,7 +39,7 @@ attribute. If you use the command attribute, you must use the username and password attributes as well.

    Parameters

    -
    Attribute Description Required
    retrycount number of times to attempt to execute the nested task Yes
    retrydelay number of milliseconds to wait between retry attempts task. Since Apache Ant 1.8.3
    +
    @@ -76,16 +76,16 @@ username and password attributes as well.

    Attribute Values No
    -

    Nested Elements

    +

    Nested Elements

    The input to send to the server, and responses to wait for, are -described as nested elements. +described as nested elements.

    read

    declare (as a text child of this element) a string to wait for. The element supports the timeout attribute, which overrides any timeout specified for the task as a whole. It also has a string -attribute, which is an alternative to specifying the string as +attribute, which is an alternative to specifying the string as a text element.

    It is not necessary to declare a closing <read> element like for the Telnet task. The connection is not broken until the command has completed and @@ -94,7 +94,7 @@ the input stream (output of the command) is terminated.

    write

    describes the text to send to the server. The echo boolean -attribute controls whether the string is echoed to the local log; +attribute controls whether the string is echoed to the local log; this is "true" by default

    Example

    @@ -109,8 +109,5 @@ The task can be used with other ports as well: <rexec port="80" userid="bob" password="badpass" server="localhost" command="ls"/> - - - diff --git a/manual/Tasks/rmic.html b/manual/Tasks/rmic.html index fa927bf8d..9c59c0c87 100644 --- a/manual/Tasks/rmic.html +++ b/manual/Tasks/rmic.html @@ -24,7 +24,7 @@ -

    Rmic

    +

    Rmic

    Description

    Runs the rmic compiler for a certain class.

    Rmic can be run on a single class (as specified with the classname @@ -47,10 +47,9 @@ supports most attributes of <fileset> (dir becomes base) as well as the nested <include>, <exclude> and <patternset> elements.

    -

    It is possible to use different compilers. This can be selected +

    It is possible to use different compilers. This can be selected with the "build.rmic" property, the compiler -attribute. or a nested element. -Here are the choices:

    +attribute, or a nested element. Here are the choices:

    • default -the default compiler (kaffe, sun or forking) for the platform.
    • sun (the standard compiler of the JDK < JDK 9)
    • @@ -62,12 +61,11 @@ attribute. or a nested element.
    • xnew - the sun compiler forked into a separate process, with the -Xnew option (since Ant 1.7). This is the most reliable way to use -Xnew. -

      JDK9 has removed support for -Xnew and starting with Ant - 1.9.8 this option will be rejected by ant when running on JDK9.
    • -
    • "" (empty string). This has the same behaviour as not setting the compiler attribute. +
      JDK 9 has removed support for -Xnew and starting with Ant + 1.9.8 this option will be rejected by Ant when running on JDK 9.
    • +
    • "" (empty string). This has the same behaviour as not setting the compiler attribute. First the value of build.rmic is used if defined, and if not, the default - for the platform is chosen. If build.rmic is set to this, you get the default. - + for the platform is chosen. If build.rmic is set to this, you get the default.

    The miniRMI @@ -75,7 +73,7 @@ project contains a compiler implementation for this task as well, please consult miniRMI's documentation to learn how to use it.

    Parameters

    - +
    @@ -113,9 +111,9 @@ please consult miniRMI's documentation to learn how to use it.

    @@ -162,7 +160,7 @@ please consult miniRMI's documentation to learn how to use it.

    - @@ -192,13 +190,13 @@ please consult miniRMI's documentation to learn how to use it.

    - + - + @@ -237,7 +235,7 @@ please consult miniRMI's documentation to learn how to use it.

    Attribute Description Specify the JDK version for the generated stub code. Specify "1.1" to pass the "-v1.1" option to rmic, "1.2" for -v12, compat for -vcompat.
    - Since Ant1.7, if you do not specify a version, and do not ask + Since Ant 1.7, if you do not specify a version, and do not ask for iiop or idl files, "compat" is selected. - +
    No, default="compat"
    verifycheck that classes implement Remote before handing them + check that classes implement Remote before handing them to rmic (default is false) No
    No
    includeAntRuntimeincludeAntRuntime whether to include the Ant run-time libraries; defaults to yes. No
    includeJavaRuntimeincludeJavaRuntime whether to include the default run-time libraries from the executing VM; defaults to no. No
    -

    *1: +

    *1:

    • Maintaining compatibility, base, when specified by itself, serves as both the parent directory for any source files @@ -249,7 +247,6 @@ please consult miniRMI's documentation to learn how to use it.

      must be specified and exist, or a runtime error will occur.
    -

    Parameters specified as nested elements

    classpath and extdirs

    @@ -265,7 +262,7 @@ are specified like Command-line Arguments but have an additional attribute that can be used to enable arguments only if a given compiler implementation will be used.

    - +
    @@ -354,4 +351,3 @@ files below ${build}/classes whose classname starts with - diff --git a/manual/Tasks/rpm.html b/manual/Tasks/rpm.html index 691d391d5..c430f62ea 100644 --- a/manual/Tasks/rpm.html +++ b/manual/Tasks/rpm.html @@ -24,7 +24,7 @@ -

    Rpm

    +

    Rpm

    Description

    A basic task for invoking the rpm executable to build a RedHat Package Manager Linux installation @@ -32,7 +32,7 @@

    Parameters

    -
    Attribute Description
    +
    @@ -73,7 +73,7 @@ - @@ -104,7 +104,7 @@ - @@ -120,4 +120,3 @@ - diff --git a/manual/Tasks/schemavalidate.html b/manual/Tasks/schemavalidate.html index 1aac2ef50..a29a41486 100644 --- a/manual/Tasks/schemavalidate.html +++ b/manual/Tasks/schemavalidate.html @@ -23,7 +23,7 @@ -

    SchemaValidate

    +

    SchemaValidate

    Description

    This schemavalidate task validates XML files described by an XML Schema. @@ -42,7 +42,8 @@ Note that nested catalogs are still used for lookup of the URLs given as the sources of schema documents, so you can still delegate lookup to a catalog, you just need to list all schema URIs and their URL equivalents. -

    This task supports the use of nested +

    This task supports the use of nested

    +
    • <xmlcatalog> elements
    • <schema> elements, that bind a namespace URI to a URL or a local filename. @@ -51,16 +52,16 @@ just need to list all schema URIs and their URL equivalents. These can be any number of http://xml.org/sax/features/ or other features that your parser may support.
    • -
    • <property> elements, containing string properties -

      +
    • <property> elements, containing string properties
    • +

    The task only supports SAX2 or later parsers: it is an error to specify a SAX1 -parser. - +parser. +

    Parameters

    -
    Attribute Description
    removeSourceFlag (optional, default=false) + Flag (optional, default=false) to remove the sources after the build. See the the --rmsource option of rpmbuild. No
    failOnErrorStop the buildprocess if the RPM build command exits with + Stop the buildprocess if the RPM build command exits with a non-zero returncode. Defaults to false No
    +
    @@ -73,14 +74,14 @@ parser. - @@ -102,7 +103,7 @@ parser. - + @@ -121,7 +122,7 @@ parser. @@ -133,15 +134,14 @@ parser.
    Attribute Description
    classpathrefwhere to find the parser class. + where to find the parser class. Optionally can use an embedded <classpath> element. No
    disableDTD - Flag to disable DTD support. DTD support is needed to + Flag to disable DTD support. DTD support is needed to validate XSD files themselves, amongst others. No - default false No - default true
    lenient @@ -113,7 +114,7 @@ parser.
    noNamespaceFile - filename of a no-namespace XSD file to provide the + filename of a no-namespace XSD file to provide the schema for no-namespace XML content. No
    noNamespaceURL - URL of a no-namespace XSD file to provide the + URL of a no-namespace XSD file to provide the schema for no-namespace XML content. No
    -

    Nested Elements

    - +

    Nested Elements

    schema

    Identify the name and location of a schema that may be used in validating the document(s).

    - +
    @@ -168,7 +168,7 @@ the document(s).

    <dtd> is used to specify different locations for DTD resolution.

    -
    Attribute Description
    +
    @@ -197,7 +197,7 @@ Features usable with the xerces parser are defined here : SAX features are defined here: http://xml.org/sax/features/

    -
    Attribute Description
    +
    @@ -214,7 +214,6 @@ SAX features are defined here:
    Attribute DescriptionYes
    -

    property

    The <property> element is used to set properties. @@ -222,7 +221,7 @@ These properties are defined here for the xerces XML parser implementation : XML Parser properties Properties can be used to set the schema used to validate the XML file.

    - +
    @@ -239,8 +238,6 @@ Properties can be used to set the schema used to validate the XML file.
    Attribute DescriptionYes
    -

    -

    Examples

    @@ -250,7 +247,7 @@ Properties can be used to set the schema used to validate the XML file.
         </schemavalidate>
     
    Validate a document against an XML schema. The document does not declare -any schema itself, which is why the noNamespaceFile is needed. +any schema itself, which is why the noNamespaceFile is needed.
         <presetdef name="validate-soap">
           <schemavalidate>
    @@ -266,18 +263,16 @@ any schema itself, which is why the noNamespaceFile is needed.
         </presetdef>
     
    Declare a new preset task, <validate-soap>, that validates -XSD and WSDL documents against the relevant specifications. -To validate XSD documents, you also need XMLSchema.dtd and datatypes.dtd in +XSD and WSDL documents against the relevant specifications. +To validate XSD documents, you also need XMLSchema.dtd and datatypes.dtd in the same directory as XMLSchema.xsd, or pointed to via the catalog. All these files can be fetched from -the W3C. +the W3C.
         <validate-soap file="xml/test.xsd"/>
     
    Use the preset task defined above to validate an XML Schema document.
    - - diff --git a/manual/Tasks/scp.html b/manual/Tasks/scp.html index 47a3cee8c..173b1b8e8 100644 --- a/manual/Tasks/scp.html +++ b/manual/Tasks/scp.html @@ -24,7 +24,7 @@ -

    SCP

    +

    SCP

    Description

    since Apache Ant 1.6

    @@ -41,7 +41,7 @@ for more information. This task has been tested with jsch-0.1.2 and later.

    See also the sshexec task

    Parameters

    - +
    @@ -81,7 +81,7 @@ for more information. This task has been tested with jsch-0.1.2 and later.

    authentication or specify the password attribute. The way remote path is recognized is whether it contains @ character or not. This will not work if your localPath contains @ character. - + @@ -90,33 +90,33 @@ for more information. This task has been tested with jsch-0.1.2 and later.

    reason this was added was that when you give todir attribute it is treated as remote if it contains @ character. This character can exist also in local paths. since Ant 1.6.2 - + - + - + - + - + @@ -124,14 +124,14 @@ for more information. This task has been tested with jsch-0.1.2 and later.

    Note If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists. - + - @@ -248,10 +248,9 @@ password attribute

    authentication.

       <scp file="myfile.txt"
    -       todir="user@somehost:/home/chuck" 
    +       todir="user@somehost:/home/chuck"
            keyfile="${user.home}/.ssh/id_dsa"
    -       passphrase="my extremely secret passphrase"
    -  />
    +       passphrase="my extremely secret passphrase"/>
     

    Copy a single remote file to a local directory

    @@ -299,17 +298,16 @@ substitution and include the password on the command line. For example:
         <scp todir="${username}:${password}@host:/dir" ...>
     
    -Invoking ant with the following command line: +Invoking Ant with the following command line:
         ant -Dusername=me -Dpassword=mypassword target1 target2
     
    - +

    Is slightly better, but the username/password is exposed to all users on an Unix system (via the ps command). The best approach is to use the <input> task and/or retrieve the password from a (secured) .properties file. - -

    +

    Unix Note: File permissions are not retained when files are downloaded; they end up with the default UMASK permissions @@ -319,8 +317,5 @@ preserving copy function, use <exec executable="scp" ... > instead.

    - - - diff --git a/manual/Tasks/script.html b/manual/Tasks/script.html index d11112417..ff8478d9e 100644 --- a/manual/Tasks/script.html +++ b/manual/Tasks/script.html @@ -17,14 +17,14 @@ - +Script Task -

    Script

    +

    Script

    Description

    Execute a script in a Apache BSF @@ -38,7 +38,7 @@

    The task may use the BSF scripting manager or the JSR 223 manager that - is included in JDK6 and higher. This is controlled by the manager + is included in JDK 6 and higher. This is controlled by the manager attribute. The JSR 223 scripting manager is indicated by "javax".

    All items (tasks, targets, etc) of the running project are @@ -67,7 +67,7 @@ Location to a useful value. In particular all targets should have different location values.

    Parameters

    -
    Attribute DescriptionYesYes
    localTodirAlternative to todir attribute.Alternative to todir attribute.
    localTofile Changes the file name to the given name while receiving it, only useful if receiving a single file. since Ant 1.6.2Alternative to todir attribute.Alternative to todir attribute.
    remoteTodir This is an alternative to the todir attribute. But this must always point to a remote directory. since Ant 1.6.2Alternative to todir attribute.Alternative to todir attribute.
    remoteTofile Changes the file name to the given name while sending it, only useful if sending a single file. since Ant 1.6.2Alternative to todir attribute.Alternative to todir attribute.
    port The port to connect to on the remote host.No, defaults to 22.No, defaults to 22.
    trust No, defaults to No.No, defaults to No.
    knownhosts This sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported.No, defaults to + No, defaults to ${user.home}/.ssh/known_hosts.
    +
    @@ -82,18 +82,18 @@ different location values.

    @@ -137,13 +137,14 @@ different location values.

    classpath

    Since Ant 1.7

    - Script's classpath attribute is a + Script's classpath attribute is a path-like structure and can also be set via a nested <classpath> element. +

    If a classpath is set, it will be used as the current thread context classloader, and - as the classloader given to the BSF manager. + as the classloader given to the BSF manager. This means that it can be used to specify the classpath containing the language implementation for BSF or for JSR 223 managers. @@ -159,7 +160,6 @@ different location values.

    that have engines in the BSF jar file. This includes the javascript, jython, netrexx and jacl languages.

    -

    Examples

    The following snippet shows use of five different languages:
    diff --git a/manual/Tasks/scriptdef.html b/manual/Tasks/scriptdef.html
    index f593e6163..a102891ea 100644
    --- a/manual/Tasks/scriptdef.html
    +++ b/manual/Tasks/scriptdef.html
    @@ -24,11 +24,11 @@
     
     
     
    -

    Scriptdef

    +

    Scriptdef

    Description

    Scriptdef can be used to define an Apache Ant task using a scripting language. Ant scripting languages supported by -Apache BSF +Apache BSF or JSR 223 may be @@ -66,13 +66,13 @@ to use "someattribute" to retrieve the attribute's value from the

    The name "self" (since Ant 1.6.3) is a pre-defined reference to the script def task instance. It can be used for logging, or for integration with the rest of - ant. the self.text attribute contains + Ant. the self.text attribute contains any nested text passed to the script

    -

    If an attribute or element is not passed in, -then attributes.get() or elements.get() will -return null. It is up to the script to perform any checks and validation. -self.fail(String message)can be used to raise a +

    If an attribute or element is not passed in, +then attributes.get() or elements.get() will +return null. It is up to the script to perform any checks and validation. +self.fail(String message)can be used to raise a BuildException.

    @@ -84,7 +84,7 @@ more information on writing scripts, please refer to the

    Parameters

    -
    Attribute Description
    manager - Since: Ant 1.7. + Since: Ant 1.7. The script engine manager to use. This can have one of three values ("auto", "bsf" or "javax"). The default value is "auto". -
    +
    • "bsf" use the BSF scripting manager to run the language.
    • "javax" use the javax.scripting manager - to run the language. (This will only work for JDK6 and higher).
    • + to run the language. (This will only work for JDK 6 and higher).
    • "auto" use the BSF engine if it exists, otherwise use the javax.scripting manager.
    • -
    +
    No
    +
    @@ -125,7 +125,7 @@ more information on writing scripts, please refer to the @@ -152,7 +152,7 @@ more information on writing scripts, please refer to the @@ -162,7 +162,7 @@ more information on writing scripts, please refer to the

    Nested elements

    attribute

    -
    Attribute DescriptionIf true, the script is compiled before the first evaluation for faster multiple executions, on the condition that the manager is "javax" and the target engine implements javax.script.Compilable. - Note that the bsf manager may automatically compiles the script. + Note that the bsf manager may automatically compiles the script. since Ant 1.10.2. No - defaults to false
    loaderRef 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 definitions to reuse the same class loader.
    +
    @@ -176,7 +176,7 @@ more information on writing scripts, please refer to the
    Attribute Description

    element

    - +
    @@ -206,8 +206,8 @@ more information on writing scripts, please refer to the - + @@ -289,10 +289,10 @@ statement (scriptdef <scripttest2>; line 10)

    Script errors are only detected when a script task is actually executed.

    - The next example does uses nested text in Jython. It also declares - the script in a new xml namespace, which must be used to refer to - the task. Declaring scripts in a new namespace guarantees that Ant will - not create a task of the same (namespace,localname) name pair. + The next example does uses nested text in Jython. It also declares + the script in a new xml namespace, which must be used to refer to + the task. Declaring scripts in a new namespace guarantees that Ant will + not create a task of the same (namespace,localname) name pair.

    @@ -335,12 +335,9 @@ The next example shows the use of <classpath> and
     

    Testing Scripts

    -The easiest way to test scripts is to use the +The easiest way to test scripts is to use the AntUnit ant library. -This will run all targets in a script that begin with "test" (and their dependencies).

    - - - +This will run all targets in a script that begin with "test" (and their dependencies).

    diff --git a/manual/Tasks/sequential.html b/manual/Tasks/sequential.html index d3deda64b..3551d6020 100644 --- a/manual/Tasks/sequential.html +++ b/manual/Tasks/sequential.html @@ -26,13 +26,13 @@

    Sequential

    Description

    -

    Sequential is a container task - it can contain other Apache Ant tasks. The nested -tasks are simply executed in sequence. Sequential's primary use is to support -the sequential execution of a subset of tasks within the +

    Sequential is a container task - it can contain other Apache Ant tasks. The nested +tasks are simply executed in sequence. Sequential's primary use is to support +the sequential execution of a subset of tasks within the parallel task

    -

    The sequential task has no attributes and does not support any nested -elements apart from Ant tasks. Any valid Ant task may be embedded within the +

    The sequential task has no attributes and does not support any nested +elements apart from Ant tasks. Any valid Ant task may be embedded within the sequential task.

    Example

    @@ -47,9 +47,7 @@ sequential task.

    </parallel>

    This example shows how the sequential task is used to execute three tasks in -sequence, while another task is being executed in a separate thread.

    - +sequence, while another task is being executed in a separate thread.

    - diff --git a/manual/Tasks/serverdeploy.html b/manual/Tasks/serverdeploy.html index 87d0777db..bfe738eff 100644 --- a/manual/Tasks/serverdeploy.html +++ b/manual/Tasks/serverdeploy.html @@ -25,7 +25,7 @@ -

    Apache Ant ServerDeploy User Manual

    +

    Apache Ant ServerDeploy User Manual

    by

    -

    -
    -

    At present the tasks support:
    +


    +

    At present the tasks support:

    +

    Over time we expect further optional tasks to support additional J2EE Servers.

    -
    +
    -
    Attribute Description
    any resource or resource collectionSince Ant1.7.1, this task can load scripts - from any resource supplied as a nested element. when Since Ant 1.7.1, this task can load scripts + from any resource supplied as a nested element. No
    +
    @@ -56,8 +56,7 @@ Over time we expect further optional tasks to support additional J2EE Servers.
    TaskApplication Servers
    serverdeployNested Elements
    genericGeneric task
    - -

    ServerDeploy element

    +

    ServerDeploy element

    Description:

    @@ -69,7 +68,7 @@ attributes are required, depending on the tool.

    Parameters:

    - +
    @@ -98,7 +97,7 @@ attributes are required, depending on the tool.

    Vendor-specific nested elements

    Parameters used for all tools:

    -
    Attribute Description
    +
    @@ -129,8 +128,7 @@ attributes are required, depending on the tool.

    Also supported are nested vendor-specific elements.

    - -

    Generic element

    +

    Generic element

    This element is provided for generic Java-based deployment tools. The generic task accepts (but does not require) nested arg and jvmarg elements. @@ -138,8 +136,7 @@ A JVM will be spawned with the provided attributes. It is recommended that a vendor-specific element be used over the generic one if at all possible.

    The following attributes are supported by the generic element.

    -

    -

    Attribute Description
    +
    @@ -152,7 +149,6 @@ possible.
    Attribute DescriptionYes
    -

    Nested Elements

    The generic element supports nested <arg> and <jvmarg> elements.

    @@ -176,8 +172,7 @@ using a Java based deploy tool:

    </serverdeploy> -
    -

    WebLogic element

    +

    WebLogic element

    The WebLogic element contains additional attributes to run the weblogic.deploy deployment tool. @@ -190,7 +185,7 @@ the application attribute must be set. If the usernamepassword attribute is required for all actions.

    - +
    @@ -247,17 +242,16 @@ WebLogic server:

    </serverdeploy> - -

    JOnAS (Java Open Application Server) element

    +

    JOnAS (Java Open Application Server) element

    The JOnAS element contains additional attributes to run the JonasAdmin deployment tool.

    Valid actions for the tool are deploy, undeploy, list and update. -

    You can't use user and password property with this +

    You can't use user and password property with this task.

    -

    Attribute Description
    +
    @@ -272,7 +266,7 @@ task. @@ -329,7 +323,5 @@ JOnAS server and a WebLogic server:

    </serverdeploy> - - diff --git a/manual/Tasks/setpermissions.html b/manual/Tasks/setpermissions.html index 22a6fb815..427c54534 100644 --- a/manual/Tasks/setpermissions.html +++ b/manual/Tasks/setpermissions.html @@ -24,7 +24,7 @@ -

    SetPermissions

    +

    SetPermissions

    Since Ant 1.10.0.

    Description

    Changes the file permissions using Java's NIO support for @@ -35,7 +35,7 @@

    If no permissions are specified either via the mode or the permissions attribute, then all permissions will be removed from the nested resources.

    -

    The task accepts aribitrary resources as part of the nested +

    The task accepts arbitrary resources as part of the nested resource collections, but not all resources support setting permissions. This task won't do anything for resources that don't support setting permissions - for example URLs.

    @@ -45,7 +45,7 @@ permissions to apply to either type of resource.

    Parameters

    -
    Attribute Descriptionorb Choose your ORB : RMI, JEREMIE, DAVID, ... If omitted, it defaults to the one present in classpath. The corresponding JOnAS JAR is - automatically added to the classpath. If your orb is DAVID (RMI/IIOP) you must + automatically added to the classpath. If your orb is DAVID (RMI/IIOP) you must specify davidhost and davidport properties. No
    +
    @@ -61,7 +61,7 @@ - diff --git a/manual/Tasks/setproxy.html b/manual/Tasks/setproxy.html index b6da936e4..a191dda52 100644 --- a/manual/Tasks/setproxy.html +++ b/manual/Tasks/setproxy.html @@ -36,7 +36,7 @@ Sets Java's web proxy properties, so that tasks and code run in the same JVM can
    <setproxy socksproxyhost="socksy"/>
    use socks via socksy:1080
    <setproxy socksproxyhost=""/>
    stop using the socks server.

    -You can set a username and password for http with the proxyHost and proxyPassword attributes. On Java1.4 and above these can also be used against SOCKS5 servers. +You can set a username and password for http with the proxyHost and proxyPassword attributes. On Java 1.4 and above these can also be used against SOCKS5 servers.

    Parameters

    diff --git a/manual/Tasks/signjar.html b/manual/Tasks/signjar.html index 0ff24df58..c17f94eba 100644 --- a/manual/Tasks/signjar.html +++ b/manual/Tasks/signjar.html @@ -24,7 +24,7 @@ -

    SignJar

    +

    SignJar

    Description

    Signing a jar allows users to authenticate the publisher.

    Signs JAR files with the jarsigner command line tool. @@ -47,7 +47,7 @@ and lazy is false, the JAR is signed.

    Parameters

    -
    Attribute Description
    modeThe permissions to set as tradional Unix + The permissions to set as traditional Unix three-digit octal number. No
    +
    @@ -138,13 +138,13 @@ block + JAR files in Java 5+ + timestamped JAR files in Java 5+ @@ -191,7 +191,7 @@ block
    Attribute Description
    tsaurl URL for a timestamp authority for timestamped - JAR files in Java1.5+ No
    tsacert alias in the keystore for a timestamp authority for - timestamped JAR files in Java1.5+ No

    Parameters as nested elements

    - +
    @@ -204,7 +204,7 @@ block - + @@ -215,7 +215,7 @@ block + environment variables
    Attribute Description
    filesetfileset of JAR files to sign. fileset of JAR files to sign. No
    sysproperty JVM system properties, with the syntax of Ant - environment variables No, and only one can be supplied
    @@ -287,18 +287,17 @@ SHA256withRSA. With trusted timestamping, users can verify that signing occurred before a certificate's expiration or revocation. Without this timestamp, users can only verify the signature as of their current date.

    -Timestamped JAR files were introduced in Java1.5 and supported in Ant since +Timestamped JAR files were introduced in Java 5 and supported in Ant since Ant 1.7. Since Ant 1.9.5, Ant can use unauthenticated proxies for this signing process.

    -

    Common public timestamp authorities include +

    Common public timestamp authorities include

    • http://timestamp.verisign.com
    • http://tsa.starfieldtech.com
    • https://timestamp.geotrust.com/tsa
    • Others (see your certificate authority)
    • -

    + - diff --git a/manual/Tasks/sleep.html b/manual/Tasks/sleep.html index 80827b515..d6e4d1005 100644 --- a/manual/Tasks/sleep.html +++ b/manual/Tasks/sleep.html @@ -23,63 +23,63 @@ -

    Sleep

    +

    Sleep

    Description

    -

    A task for sleeping a short period of time, useful when a build or deployment - process requires an interval between tasks.

    +

    +A task for sleeping a short period of time, useful when a build or deployment +process requires an interval between tasks. +

    Parameters

    - - +
    + - + - + - + - + - + -
    Attribute Description Required
    hours hours to to add to the sleep time No
    minutes minutes to add to the sleep time No
    seconds seconds to add to the sleep time No
    milliseconds milliseconds to add to the sleep time No
    failonerrorflag controlling whether to break the build on an error. + flag controlling whether to break the build on an error. No
    -

    The sleep time is the sum of specified values, hours, minutes seconds and milliseconds. - A negative value can be supplied to any of them provided the total sleep time +

    The sleep time is the sum of specified values, hours, minutes seconds and milliseconds. + A negative value can be supplied to any of them provided the total sleep time is positive

    -

    Note that sleep times are always hints to be interpred by the OS how it feels - - small times may either be ignored or rounded up to a minimum timeslice. Note - also that the system clocks often have a fairly low granularity too, which complicates +

    Note that sleep times are always hints to be interpreted by the OS how it feels + - small times may either be ignored or rounded up to a minimum timeslice. Note + also that the system clocks often have a fairly low granularity too, which complicates measuring how long a sleep actually took.

    Examples

       <sleep milliseconds="10"/>
    -Sleep for about 10 mS. +Sleep for about 10 mS.
       <sleep seconds="2"/>
    -Sleep for about 2 seconds. +Sleep for about 2 seconds.
       <sleep hours="1" minutes="-59" seconds="-58"/>
    -

    Sleep for one hour less 59:58, or two seconds again

    +

    Sleep for one hour less 59:58, or two seconds again

       <sleep/>
    -Sleep for no time at all. This may yield the CPU time to another thread or process. - +Sleep for no time at all. This may yield the CPU time to another thread or process. - diff --git a/manual/Tasks/sos.html b/manual/Tasks/sos.html index c068263b2..990829024 100644 --- a/manual/Tasks/sos.html +++ b/manual/Tasks/sos.html @@ -14,14 +14,10 @@ See the License for the specific language governing permissions and limitations under the License. --> - - - -SOS Tasks - + SOS Tasks @@ -32,21 +28,19 @@ +

    Version 1.1 2002/01/23 -
    -
    - -


    +

    +

    Contents


    -

    Introduction

    +

    Introduction

    These tasks provide an interface to the Microsoft Visual SourceSafe SCM via @@ -63,9 +57,9 @@ to be used by automated build systems. These tasks have been tested with SourceOffSite version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks have been tested with Linux, Solaris & Windows2000.

    -

    The Tasks

    +

    The Tasks

    - +
    @@ -88,20 +82,17 @@ have been tested with Linux, Solaris & Windows2000.

    sosget
    -
    - -
    +

    Task Descriptions

    -

    SOSGet
    -

    +

    SOSGet

    Description

    Task to perform GET commands with SOS

    Parameters

    - +
    @@ -200,22 +191,23 @@ have been tested with Linux, Solaris & Windows2000.

    sosserverpath="192.168.10.6:8888" vssserverpath="d:\vss\srcsafe.ini"/> +

    Connects to a SourceOffsite server on 192.168.10.6:8888 with build,build as the username & password. The SourceSafe database resides on the same box as the SOS server & the VSS database is at "d:\vss\srcsafe.ini" Does a recursive GetProject on $/SourceRoot/project1, using tmp as the working -directory.
    -
    +directory. +

    -
    -

    SOSLabel

    +
    +

    SOSLabel

    Description

    Task to perform Label commands with SOS

    Parameters

    -
    Attribute
    +
    @@ -279,22 +271,21 @@ directory.
    sosserverpath="192.168.10.6:8888" vssserverpath="d:\vss\srcsafe.ini"/> - +

    Connects to a SourceOffsite server on 192.168.10.6:8888 with build,build as the username & password. The SourceSafe database resides on the same box as the SOS server & the VSS database is at "d:\vss\srcsafe.ini". Labels the $/SourceRoot/project1 -project with "test label".
    -
    - -



    +project with "test label". +

    -

    SOSCheckIn

    +
    +

    SOSCheckIn

    Description

    Task to perform CheckIn commands with SOS

    Parameters

    -
    Attribute Values
    +
    @@ -386,23 +377,24 @@ project with "test label".
    vssserverpath="\\server2\vss\srcsafe.ini"/> +

    Connects to a SourceOffsite server on server1:8888 with build,build as the username & password. The SourceSafe database resides on a different box (server2) & the VSS database is on a share called "vss". Checks-in only the "foobar.txt" file adding a comment of "comment abc". Extra status messages will be -displayed on screen.
    -
    +displayed on screen. +

    -
    -

    SOSCheckOut

    +
    +

    SOSCheckOut

    Description

    Task to perform CheckOut commands with SOS

    Parameters

    -
    Attribute
    +
    @@ -489,15 +481,15 @@ displayed on screen.
    sosserverpath="192.168.10.6:8888" vssserverpath="\\server2\vss\srcsafe.ini"/> - +

    Connects to a SourceOffsite server on server1:8888 with build,build as the username & password. The SourceSafe database resides on a different box (server2) & the VSS database is on a share called "vss". Checks-out "project1", Only the "project1" directory will be locked as the recursive option was not set. Extra status messages will be displayed on screen. The -soscmd(.exe) file to be used resides in /usr/local/bin.
    -
    +soscmd(.exe) file to be used resides in /usr/local/bin. +

    diff --git a/manual/Tasks/sound.html b/manual/Tasks/sound.html index 1095f80cf..96821f776 100644 --- a/manual/Tasks/sound.html +++ b/manual/Tasks/sound.html @@ -24,7 +24,7 @@ -

    Sound

    +

    Sound

    Description

    Plays a sound-file at the end of the build, according to whether the build failed or succeeded. You can specify either a specific @@ -32,14 +32,14 @@ sound-file to play, or, if a directory is specified, the <sound> task will randomly select a file to play. Note: At this point, the random selection is based on all the files in the directory, not just those ending in appropriate suffixes -for sound-files, so be sure you only have sound-files in the +for sound-files, so be sure you only have sound-files in the directory you specify.

    More precisely <sound> registers a hook that is triggered when the build finishes. Therefore you have to place this task as top level or inside a target which is always executed.

    Unless you are running on Java 1.3 or later, you need the Java Media Framework -on the classpath (javax.sound). +on the classpath (javax.sound).

    @@ -51,9 +51,9 @@ on the classpath (javax.sound).

    Nested Element Parameters

    -The following attributes may be used on the <success> +The following attributes may be used on the <success> and <fail> elements:

    -
    Attribute
    +
    @@ -116,8 +116,5 @@ more than once. randomly selects a sound-file to play when the build succeeds or fails. - - - diff --git a/manual/Tasks/splash.html b/manual/Tasks/splash.html index e158bd294..cf8bcad7a 100644 --- a/manual/Tasks/splash.html +++ b/manual/Tasks/splash.html @@ -24,7 +24,7 @@ -

    Splash

    +

    Splash

    by Les Hughes (leslie.hughes@rubus.com)

    Description

    This task creates a splash screen. The splash screen is displayed @@ -32,7 +32,7 @@ for the duration of the build and includes a handy progress bar as well. Use in conjunction with the sound task to provide interest whilst waiting for your builds to complete...

    Parameters

    -
    Attribute Description
    +
    @@ -45,7 +45,7 @@ whilst waiting for your builds to complete...

    - +
    Attribute Description No antlogo.gif from the classpath
    showduration Initial period to pause the build to show the @@ -76,11 +76,11 @@ whilst waiting for your builds to complete...

    The following properties can be used to configure the proxy settings to retrieve an image from behind a firewall. However, the settings apply not just to this -task, but to all following tasks. Therefore they are now deprecated in +task, but to all following tasks. Therefore they are now deprecated in preference to the <setproxy> task, that makes it clear to readers of the build exactly what is going on. - +
    useproxy Use a proxy to access imgurl. Note: Only tested @@ -147,8 +147,5 @@ the build exactly what is going on. </target> - - - diff --git a/manual/Tasks/sql.html b/manual/Tasks/sql.html index bade59024..d7873aeb8 100644 --- a/manual/Tasks/sql.html +++ b/manual/Tasks/sql.html @@ -22,39 +22,39 @@ -

    Sql

    +

    Sql

    Description

    -

    Executes a series of SQL statements via JDBC to a database. Statements can -either be read in from a text file using the src attribute or from +

    Executes a series of SQL statements via JDBC to a database. Statements can +either be read in from a text file using the src attribute or from between the enclosing SQL tags.

    -

    Multiple statements can be provided, separated by semicolons (or the -defined delimiter). Individual lines within the statements can be +

    Multiple statements can be provided, separated by semicolons (or the +defined delimiter). Individual lines within the statements can be commented using either --, // or REM at the start of the line.

    -

    The autocommit attribute specifies whether auto-commit should be -turned on or off whilst executing the statements. If auto-commit is turned -on each statement will be executed and committed. If it is turned off the +

    The autocommit attribute specifies whether auto-commit should be +turned on or off whilst executing the statements. If auto-commit is turned +on each statement will be executed and committed. If it is turned off the statements will all be executed as one transaction.

    -

    The onerror attribute specifies how to proceed when an error occurs -during the execution of one of the statements. +

    The onerror attribute specifies how to proceed when an error occurs +during the execution of one of the statements. The possible values are: continue execution, only show the error; stop execution, log the error but don't fail the task and abort execution and transaction and fail task.

    -Proxies. Some JDBC drivers (including the Oracle thin driver), +Proxies. Some JDBC drivers (including the Oracle thin driver), use the JVM's proxy settings to route their JDBC operations to the database. - Since Apache Ant1.7, Ant running on Java1.5 or later defaults to + Since Apache Ant 1.7, Ant running on Java 5 or later defaults to using - the proxy settings of the operating system. + the proxy settings of the operating system. Accordingly, the OS proxy settings need to be valid, or Ant's proxy support disabled with -noproxy option.

    Parameters

    - +
    @@ -93,7 +93,7 @@ and abort execution and transaction and fail task.

    @@ -292,12 +292,12 @@ and abort execution and transaction and fail task.

    Parameters specified as nested elements

    transaction

    -

    Use nested <transaction> +

    Use nested <transaction> elements to specify multiple blocks of commands to the executed executed in the same connection but different transactions. This is particularly useful when there are multiple files to execute on the same schema.

    -
    Attribute Description
    outputencoding The encoding of the files holding - results. since 1.9.4 + results. since 1.9.4 No - defaults to default JVM encoding
    +
    @@ -333,7 +333,7 @@ href="../using.html#path">PATH like structure and can also be set via a nest

    Use nested <connectionProperty> elements to specify additional JDBC properties that need to be set when connecting to the database.

    -
    Attribute Description
    +
    @@ -357,12 +357,11 @@ href="../using.html#path">PATH like structure and can also be set via a nest url="jdbc:database-url" userid="sa" password="pass" - src="data.sql" -/> + src="data.sql"/> -

    Connects to the database given in url as the sa user using the -org.database.jdbcDriver and executes the SQL statements contained within +

    Connects to the database given in url as the sa user using the +org.database.jdbcDriver and executes the SQL statements contained within the file data.sql

    <sql
    @@ -384,8 +383,7 @@ property internal_logon to the value SYSDBA.

    driver="org.database.jdbcDriver" url="jdbc:database-url" userid="sa" - password="pass" - > + password="pass"> insert into table some_table values(1,2,3,4); @@ -395,7 +393,7 @@ truncate table some_other_table;

    Connects to the database given in url as the sa - user using the org.database.jdbcDriver and executes the two SQL statements + user using the org.database.jdbcDriver and executes the two SQL statements inserting data into some_table and truncating some_other_table. Ant Properties in the nested text will not be expanded.

    @@ -408,8 +406,7 @@ or other special characters. For example:

    driver="org.database.jdbcDriver" url="jdbc:database-url" userid="sa" - password="pass" - ><![CDATA[ + password="pass"><![CDATA[ update some_table set column1 = column1 + 1 where column2 < 42; @@ -417,32 +414,30 @@ update some_table set column1 = column1 + 1 where column2 < 42; The following command turns property expansion in nested text on (it is off purely for backwards -compatibility), then creates a new user in the HSQLDB database using Ant properties. +compatibility), then creates a new user in the HSQLDB database using Ant properties.
    <sql
         driver="org.hsqldb.jdbcDriver";
         url="jdbc:hsqldb:file:${database.dir}"
         userid="sa"
         password=""
    -    expandProperties="true"
    -    >
    +    expandProperties="true">
       <transaction>
         CREATE USER ${newuser} PASSWORD ${newpassword}
       </transaction>
     </sql>
     
    - -

    The following connects to the database given in url as the sa user using -the org.database.jdbcDriver and executes the SQL statements contained within -the files data1.sql, data2.sql and data3.sql and then executes the truncate +

    The following connects to the database given in url as the sa user using +the org.database.jdbcDriver and executes the SQL statements contained within +the files data1.sql, data2.sql and data3.sql and then executes the truncate operation on some_other_table.

    <sql
         driver="org.database.jdbcDriver"
         url="jdbc:database-url"
         userid="sa"
    -    password="pass" >
    +    password="pass">
       <transaction  src="data1.sql"/>
       <transaction  src="data2.sql"/>
       <transaction  src="data3.sql"/>
    @@ -473,9 +468,9 @@ run before data2.sql.

    </sql>
    -

    The following connects to the database given in url as the sa user using the -org.database.jdbcDriver and executes the SQL statements contained within the -file data.sql, with output piped to outputfile.txt, searching /some/jdbc.jar +

    The following connects to the database given in url as the sa user using the +org.database.jdbcDriver and executes the SQL statements contained within the +file data.sql, with output piped to outputfile.txt, searching /some/jdbc.jar as well as the system classpath for the driver class.

    <sql
    @@ -485,15 +480,14 @@ as well as the system classpath for the driver class.

    password="pass" src="data.sql" print="yes" - output="outputfile.txt" - > + output="outputfile.txt"> <classpath> <pathelement location="/some/jdbc.jar"/> </classpath> </sql>
    -

    The following will only execute if the RDBMS is "oracle" and the version +

    The following will only execute if the RDBMS is "oracle" and the version starts with "8.1."

    <sql
    @@ -503,8 +497,7 @@ starts with "8.1."

    password="pass" src="data.sql" rdbms="oracle" - version="8.1." - > + version="8.1."> insert into table some_table values(1,2,3,4); @@ -513,6 +506,5 @@ truncate table some_other_table; </sql>
    - diff --git a/manual/Tasks/sshexec.html b/manual/Tasks/sshexec.html index d085abdd1..5efa5bd53 100644 --- a/manual/Tasks/sshexec.html +++ b/manual/Tasks/sshexec.html @@ -24,7 +24,7 @@ -

    SSHEXEC

    +

    SSHEXEC

    Description

    since Apache Ant 1.6

    @@ -42,7 +42,7 @@ and won't work with versions of jsch earlier than

    See also the scp task

    Parameters

    -
    Attribute Description
    +
    @@ -61,18 +61,18 @@ and won't work with versions of jsch earlier than - + - + - + @@ -81,14 +81,14 @@ and won't work with versions of jsch earlier than Note If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists. - + - @@ -152,7 +152,7 @@ and won't work with versions of jsch earlier than - @@ -191,8 +191,8 @@ and won't work with versions of jsch earlier than - @@ -283,21 +283,20 @@ and won't work with versions of jsch earlier than commandResource="to_run"/> -

    Security Note: Hard coding passwords and/or usernames in sshexec task can be a serious security hole. Consider using variable -substitution and include the password on the command line. For example:
    +substitution and include the password on the command line. For example:

       <sshexec host="somehost"
     	username="${username}"
     	password="${password}"
     	command="touch somefile"/>
     
    -Invoking ant with the following command line: +Invoking Ant with the following command line:
         ant -Dusername=me -Dpassword=mypassword target1 target2
     
    - +

    Is slightly better, but the username/password is exposed to all users on an Unix system (via the ps command). The best approach is to use the diff --git a/manual/Tasks/sshsession.html b/manual/Tasks/sshsession.html index e9696d1f9..4758719a5 100644 --- a/manual/Tasks/sshsession.html +++ b/manual/Tasks/sshsession.html @@ -24,7 +24,7 @@ -

    SSHSESSION

    +

    SSHSESSION

    Description

    since Apache Ant 1.8.0

    @@ -46,7 +46,7 @@ than 0.1.28.

    and scp tasks

    Parameters

    -
    Attribute Description
    command The command to run on the remote host.Either this or commandResource must be setEither this or commandResource must be set
    commandResource The resource (file) that contains the commands to run on the remote host. Since Ant 1.7.1Either this or command must be setEither this or command must be set
    port The port to connect to on the remote host.No, defaults to 22.No, defaults to 22.
    trustNo, defaults to No.No, defaults to No.
    knownhosts This sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported.No, defaults to + No, defaults to ${user.home}/.ssh/known_hosts.
    outputpropertyThe name of a property in which the output of the + The name of a property in which the output of the command should be stored. If you use the commandResource attribute, each command's output will be prefixed by the command itself.
    verboseDetermines whether sshexec outputs verbosely to the user.
    - Similar output is generated as the ssh commandline tool wit the -v option. +
    Determines whether sshexec outputs verbosely to the user.
    + Similar output is generated as the ssh commandline tool wit the -v option. since Ant 1.8.0
    No, defaults to false
    +
    @@ -65,7 +65,7 @@ and scp tasks

    - + @@ -75,7 +75,7 @@ and scp tasks

    local port forwarding.
    If nested localtunnel elements are also provided, both sets of tunnels will be established. - + @@ -84,23 +84,23 @@ and scp tasks

    remote port forwarding.
    If nested remotetunnel elements are also provided, both sets of tunnels will be established. - + - + - + - @@ -138,13 +138,13 @@ and scp tasks

    Parameters specified as nested elements

    -

    localtunnel

    +

    localtunnel

    Optionally, any number of localtunnel elements can be used to define local port forwarding over the SSH connection. If the localtunnels parameter was also specified, both sets of tunnels will be established.

    -
    Attribute Description
    port The port to connect to on the remote host.No, defaults to 22.No, defaults to 22.
    NoNo
    remotetunnelsNoNo
    trustThis trusts all unknown hosts if set to yes/true.
    Note If you set this to false (the default), the host you connect to must be listed in your knownhosts file, this also implies that the file exists.
    No, defaults to No.No, defaults to No.
    knownhosts This sets the known hosts file to use to validate the identity of the remote host. This must be a SSH2 format file. SSH1 format is not supported.No, defaults to + No, defaults to ${user.home}/.ssh/known_hosts.
    +
    @@ -169,13 +169,13 @@ be established.

    Attribute Description
    -

    remotetunnel

    +

    remotetunnel

    Optionally, any number of remotetunnel elements can be used to define remote port forwarding over the SSH connection. If the remotetunnels parameter was also specified, both sets of tunnels will be established.

    - +
    @@ -200,7 +200,7 @@ be established.

    Attribute Description
    -

    sequential

    +

    sequential

    The sequential element is a required parameter. It is a container for nested Tasks which are to be executed once the SSH connection is established and all local and/or remote tunnels established.

    @@ -213,14 +213,12 @@ command locally, which can use the tunnel.

    <sshsession host="somehost" username="dude" password="yo" - localtunnels="2401:localhost:2401" - > + localtunnels="2401:localhost:2401"> <sequential> - <cvs command="update ${cvs.parms} ${module}" + <cvs command="update ${cvs.parms} ${module}" cvsRoot="${cvs.root}" dest="${local.root}" - failonerror="true" - /> + failonerror="true"/> </sequential> </sshsession> @@ -229,15 +227,13 @@ command locally, which can use the tunnel.

       <sshsession host="somehost"
         username="dude"
    -    password="yo"
    -  >
    +    password="yo">
         <localtunnel lport="2401" rhost="localhost" rport="2401"/>
         <sequential>
    -      <cvs  command="update ${cvs.parms} ${module}"
    +      <cvs command="update ${cvs.parms} ${module}"
             cvsRoot="${cvs.root}"
             dest="${local.root}"
    -        failonerror="true"
    -    />
    +        failonerror="true"/>
         </sequential>
       </sshsession>
     
    @@ -261,7 +257,7 @@ accessible, then run a get task using that tunnel.

    Security Note: Hard coding passwords or passphrases and/or usernames in sshsession task can be a serious security hole. Consider using variable substitution and include the -password on the command line. For example:
    +password on the command line. For example:

       <sshsession host="somehost"
       username="${username}"
    @@ -273,11 +269,11 @@ password on the command line. For example:
    </sshsession>
    -Invoking ant with the following command line: +Invoking Ant with the following command line:
         ant -Dusername=me -Dpassword=mypassword target1 target2
     
    - +

    Is slightly better, but the username/password is exposed to all users on an Unix system (via the ps command). The best approach is to use the diff --git a/manual/Tasks/style.html b/manual/Tasks/style.html index 81e7e6bd6..496e621b9 100644 --- a/manual/Tasks/style.html +++ b/manual/Tasks/style.html @@ -24,7 +24,7 @@ -

    XSLT

    +

    XSLT

    The name style is a deprecated name for the same task.

    Description

    Process a set of documents via XSLT.

    @@ -86,7 +86,7 @@ element which is used to perform Entity and URI resolution.

    classloader (reference to an Ant PATH-like structure).

    Parameters

    - +
    @@ -117,11 +117,11 @@ element which is used to perform Entity and URI resolution.

    - @@ -237,7 +236,7 @@ element which is used to perform Entity and URI resolution.

    @@ -245,7 +244,7 @@ element which is used to perform Entity and URI resolution.

    @@ -286,7 +285,7 @@ collection should be applied to. Use a nested mapper and the task's destdir attribute to specify the output files.

    -

    classpath

    +

    classpath

    The classpath to load the processor from can be specified via a nested <classpath>, as well - that is, a path-like structure.

    @@ -299,7 +298,7 @@ element is used to perform Entity and URI resolution.

    Param is used to pass a parameter to the XSL stylesheet.

    Parameters

    -
    Attribute Description name of the stylesheet to use - given either relative to the project's basedir or as an absolute path.

    - Alternatively, a nested element which ant can interpret as a resource + Alternatively, a nested element which Ant can interpret as a resource can be used to indicate where to find the stylesheet
    deprecated variation :
    If the stylesheet cannot be found, and if you have specified the - attribute basedir for the task, ant will assume that the style + attribute basedir for the task, Ant will assume that the style attribute is relative to the basedir of the task.
    No, if the location of @@ -147,14 +147,13 @@ element which is used to perform Entity and URI resolution.

    processorname of the XSLT processor to use. Permissible value is :
    • "trax" for a TraX compliant processor (ie JAXP interface implementation such as Xalan 2 or Saxon)
    Defaults to trax.
    - Support for xalan1 has been removed in ant 1.7. + Support for Xalan 1 has been removed in Ant 1.7.
    No
    Specifies a xsl parameter for accessing the directory of the current processed file. For files in the current directory a value of '.' will be passed to the transformation. - If not set, the directory is not passed to the transformation. + If not set, the directory is not passed to the transformation. Since Ant 1.7. No
    suppressWarnings Whether processor warnings shall be suppressed. This option requires support by the processor, it is supported by - the trax processor bundled with Ant. + the trax processor bundled with Ant. Since Ant 1.8.0. No, default is false.
    +
    @@ -352,7 +351,7 @@ element is used to perform Entity and URI resolution.

    Attribute Description
    -

    +

    The XPATH_* types says that the expression is not just a primitive-type value but an XPath expression. This expression will be evaluated on an empty XML document and the result will be passed to the XSLT transformer as a parameter of given type. In these expressions the declared Ant properties can be used as XPath variables e.g. $someProperty. @@ -370,7 +369,7 @@ as specified in the XSLT specifications.

    Parameters

    - +
    @@ -389,11 +388,11 @@ XSLT specifications.
    Attribute Description
    -

    factory ('trax' processors only)

    +

    factory ('trax' processors only)

    Used to specify factory settings.

    Parameters

    - +
    @@ -433,7 +432,7 @@ And in Saxon 7.x:

    Parameters

    -
    Attribute Description
    +
    @@ -491,7 +490,7 @@ support is http://javax.xml.XMLConstants/feature/secure-processing.

    Parameters

    -
    Attribute Description
    +
    @@ -580,9 +579,9 @@ with syspropertysets.

    element <xsl:param name="date"/>, the variable $date will subsequently have the value 07-01-2000.

    - +

    Various data types and XPath expressions:

    - +
    <property name="antProperty1" value="ANT_PROPERTY_1"/>
     <property name="antProperty2" value="ANT_PROPERTY_2"/>
     <property name="antProperty3" value="3"/>
    @@ -594,38 +593,38 @@ with syspropertysets.

    --> <xslt in="in.xml" out="out.xml" style="template.xsl"> - + <!-- Simple String parameter: --> <param name="p0" expression="some nice string" type="STRING"/> - + <!-- A value substituted by Ant --> <param name="p1" expression="some string with ${antProperty1} constructed by Ant" type="STRING"/> - + <!-- XPath resulting in: and this is done in XPath: ANT_PROPERTY_2 --> <param name="p2" expression="concat('and this is done in XPath: ', $antProperty2)" type="XPATH_STRING"/> - + <!-- Some XPath math, result: 42 --> <param name="p3" expression="64 * 64 div 128 + 10" type="XPATH_NUMBER"/> - + <!-- Some numeric parameter: --> <param name="p4" expression="123.45" type="DOUBLE"/> - + <!-- XPath expression, result: true boolean --> <param name="p5" expression="$antProperty1 = 'ANT_PROPERTY_1'" type="XPATH_BOOLEAN"/> - + <!-- First one is an XPath variable, second one is a text substituted by Ant, result: true boolean --> <param name="p6" expression="$antProperty2 = '${antProperty2}'" type="XPATH_BOOLEAN"/> - + <!-- Some XPath math with a variable, result: 64 --> <param name="p7" expression="$antProperty3 * 4 * 5 + 4" type="XPATH_NUMBER"/> - - <!-- + + <!-- XPath expression with substituted function name and a variable: substring-before($antProperty2, '_') result: ANT --> <param name="p8" expression="${antProperty4}($antProperty2, '_')" type="XPATH_STRING"/> - + <!-- Without type attribute: --> <param name="p9" expression="default type is String"/> </xslt>
    @@ -700,6 +699,5 @@ with syspropertysets.

    - diff --git a/manual/Tasks/subant.html b/manual/Tasks/subant.html index 8cc4c2950..c5bc9526e 100644 --- a/manual/Tasks/subant.html +++ b/manual/Tasks/subant.html @@ -28,7 +28,7 @@

    Calls a given target for all defined sub-builds. This is an extension - of ant for bulk project execution. + of Ant for bulk project execution. This task must not be used outside of a target if it invokes the same build file it is diff --git a/manual/Tasks/symlink.html b/manual/Tasks/symlink.html index 6c98f5eaf..2ed74fc2f 100644 --- a/manual/Tasks/symlink.html +++ b/manual/Tasks/symlink.html @@ -24,17 +24,20 @@ -

    Symlink

    +

    Description

    -

    Manages symbolic links on platforms where Java supports symbolic links. +

    +Manages symbolic links on platforms where Java supports symbolic links. Can be used to make an individual link, delete a link, create multiple links from properties files, or create properties files describing links in the specified directories. Existing files are not overwritten by default. - -

    FileSets are used to select a -set of links to record, or a set of property files to create links from.

    +

    +

    +FileSets are used to select a +set of links to record, or a set of property files to create links from. +

    Parameters

    -
    Attribute Description
    +
    @@ -72,7 +75,7 @@ set of links to record, or a set of property files to create links from.

    - @@ -96,12 +99,12 @@ set of links to record, or a set of property files to create links from.

    Examples

    -

    Make a link named "foo" to a resource named "bar.foo" in subdir:

    +

    Make a link named "foo" to a resource named "bar.foo" in subdir:

       <symlink link="${dir.top}/foo" resource="${dir.top}/subdir/bar.foo"/>
       
    -

    Record all links in subdir and it's descendants in files named +

    Record all links in subdir and it's descendants in files named "dir.links"

       <symlink action="record" linkfilename="dir.links">
    @@ -109,14 +112,14 @@ set of links to record, or a set of property files to create links from. 

    </symlink>
    -

    Recreate the links recorded in the previous example:

    +

    Recreate the links recorded in the previous example:

       <symlink action="recreate">
          <fileset dir="${dir.top}" includes="subdir/**/dir.links"/>
       </symlink>
       
    -

    Delete a link named "foo": +

    Delete a link named "foo":

      <symlink action="delete" link="${dir.top}/foo"/>
      
    @@ -127,12 +130,10 @@ set of links to record, or a set of property files to create links from.

    IOException where Apache Ant can't find /some/working/directory${ANT_HOME}/bin/antRun or something similar. The workaround is to change your ANT_HOME environment variable to an absolute path, which will remove the /some/working/directory portion - of the above path and allow ant to find the correct commandline execution script. + of the above path and allow Ant to find the correct commandline execution script.

    NOTE: Starting Ant version 1.10.2, this task relies on the symbolic link support introduced in Java 7 through the java.nio.file.Files APIs

    - - diff --git a/manual/Tasks/sync.html b/manual/Tasks/sync.html index 1d34aeef5..b1d4d1d62 100644 --- a/manual/Tasks/sync.html +++ b/manual/Tasks/sync.html @@ -24,7 +24,7 @@ -

    Sync

    +

    Sync

    Since Apache Ant 1.6

    Description

    @@ -37,7 +37,7 @@ file in your sources and a file of that name is present in the target dir, it will get removed from the target.

    Parameters

    -
    Attribute Description
    overwriteOverwrite existing files or not. If overwrite is set to true, then + Overwrite existing files or not. If overwrite is set to true, then any existing file, specified by the link attribute, will be overwritten irrespective of whether or not the existing file is a symbolic link. No; defaults to false.
    +
    @@ -47,7 +47,7 @@ dir, it will get removed from the target.

    - +
    Attribute Descriptiontodir the target directory to sync with the resource collections Yes
    overwrite Overwrite existing files even if the destination @@ -116,7 +116,7 @@ support the dir attribute and the usedefaultexcludes attribute defaults to false.

    Additional Parameters
    - +
    @@ -132,7 +132,7 @@ defaults to false.

    "wins". - +
    Attribute Description No, defaults to the value of the task's includeemptydirs attribute

    Examples

    @@ -159,8 +159,5 @@ present in generated-site.

    present in generated-site but keeps all files in any CVS sub-directory.

    - - - diff --git a/manual/Tasks/tar.html b/manual/Tasks/tar.html index 7d08c0191..ae972e7e7 100644 --- a/manual/Tasks/tar.html +++ b/manual/Tasks/tar.html @@ -24,7 +24,7 @@ -

    Tar

    +

    Tar

    Description

    Creates a tar archive.

    The basedir attribute is the reference directory from where to tar.

    @@ -78,14 +78,14 @@ that it produces a warning for each file path encountered that does not match the limit. It uses gnu rather than posix for backwards compatibility reasons.

    -

    To achivieve best interoperability you should use +

    To achieve best interoperability you should use either fail or posix for the longfile attribute.

    This task can perform compression by setting the compression attribute to "gzip" or "bzip2".

    Parameters

    - +
    @@ -141,7 +141,7 @@ or "bzip2".

    - @@ -165,7 +165,7 @@ extended FileSets which, in addition to the standard elements, support one additional attributes -
    Attribute Description
    compressioncompression method. Allowable values are + compression method. Allowable values are "none", "gzip", "xz" and "bzip2". Default is "none". No
    +
    @@ -196,8 +196,7 @@ it.

     <tar destfile="${dist}/manual.tar"
          basedir="htdocs/manual"
    -     excludes="mydocs/**, **/todo.html"
    -/>
    + excludes="mydocs/**, **/todo.html"/>

    tars all files in the htdocs/manual directory into a file called manual.tar in the ${dist} directory. Files in the directory mydocs, or files with the name todo.html are excluded.

    @@ -242,11 +241,9 @@ or files with the name todo.html are excluded.

    where some files need to be marked as executable (mode 755) and the rest are use the default mode (read-write by owner). The first fileset selects just the executable files. The second fileset must exclude -the executable files and include all others.

    +the executable files and include all others.

    - - -

    Note: The tar task does not ensure that a file is only selected +

    Note: The tar task does not ensure that a file is only selected by one resource collection. If the same file is selected by more than one collection, it will be included in the tar file twice, with the same path.

    @@ -269,7 +266,7 @@ will be retained in the resulting tar archive.

    Note: - Please note the tar task creates a tar file, it does not append + Please note the tar task creates a tar file, it does not append to an existing tar file. The existing tar file is replaced instead. As with most tasks in Ant, the task only takes action if the output file (the tar file in this case) is older than the input files, or @@ -278,4 +275,3 @@ will be retained in the resulting tar archive.

    - diff --git a/manual/Tasks/taskdef.html b/manual/Tasks/taskdef.html index 4f6f5d2b9..a83def4b0 100644 --- a/manual/Tasks/taskdef.html +++ b/manual/Tasks/taskdef.html @@ -24,12 +24,12 @@ -

    Taskdef

    +

    Taskdef

    Description

    Adds a task definition to the current project, such that this new task can be used in the current project.

    This task is a form of Typedef with the - attributes "adapter" and "adaptto" set to the values + attributes "adapter" and "adaptto" set to the values "org.apache.tools.ant.TaskAdapter" and "org.apache.tools.ant.Task" respectively. Anything said in the manual page of typedef applies to taskdef as well.

    @@ -38,7 +38,5 @@

    makes a task called myjavadoc available to Apache Ant. The class com.mydomain.JavadocTask implements the task.

    - - diff --git a/manual/Tasks/telnet.html b/manual/Tasks/telnet.html index 0ac65b378..c65886476 100644 --- a/manual/Tasks/telnet.html +++ b/manual/Tasks/telnet.html @@ -24,19 +24,19 @@ -

    Telnet

    +

    Telnet

    Description

    -Task to automate a remote telnet session. The task uses +Task to automate a remote telnet session. The task uses nested <read> to indicate strings to wait for, and -<write> tags to specify text to send. +<write> tags to specify text to send. -

    If you do specify a userid and password, the system will +

    If you do specify a userid and password, the system will assume a common unix prompt to wait on. This behavior can be easily over-ridden.

    Note: This task depends on external libraries not included in the Apache Ant distribution. See Library Dependencies for more information.

    Parameters

    -
    Attribute Description
    +
    @@ -73,16 +73,16 @@ See Library Dependencies for m
    Attribute ValuesNo
    -

    Nested Elements

    +

    Nested Elements

    The commands to send to the server, and responses to wait for, are -described as nested elements. +described as nested elements.

    read

    declare (as a text child of this element) a string to wait for. The element supports the timeout attribute, which overrides any timeout specified for the task as a whole. It also has a string -attribute, which is an alternative to specifying the string as +attribute, which is an alternative to specifying the string as a text element.

    Always declare an opening and closing @@ -93,7 +93,7 @@ the final command has completed.

    write

    describes the text to send to the server. The echo boolean -attribute controls whether the string is echoed to the local log; +attribute controls whether the string is echoed to the local log; this is "true" by default

    Examples

    @@ -122,8 +122,8 @@ This task can be rewritten as: </telnet> -A timeout can be specified at the <telnet> level or at the <read> level. -This will connect, issue a sleep command that is suppressed from displaying and wait +A timeout can be specified at the <telnet> level or at the <read> level. +This will connect, issue a sleep command that is suppressed from displaying and wait 10 seconds before quitting.
     <telnet userid="bob" password="badpass" server="localhost" timeout="20">
    @@ -143,13 +143,11 @@ The task can be used with other ports as well:
     </telnet>
     

    -To use this task against the WinNT telnet service, you need to configure the service to use -classic authentication rather than NTLM negotiated authentication. -This can be done in the Telnet Server Admin app: +To use this task against the WinNT telnet service, you need to configure the service to use +classic authentication rather than NTLM negotiated authentication. +This can be done in the Telnet Server Admin app: select "display/change registry settings", then "NTLM", then set the value of NTLM to 1.

    - - diff --git a/manual/Tasks/tempfile.html b/manual/Tasks/tempfile.html index d4d9d52da..e1c930a03 100644 --- a/manual/Tasks/tempfile.html +++ b/manual/Tasks/tempfile.html @@ -112,7 +112,7 @@ deleteonexit
    - Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default false. Since Apache Ant 1.7 + Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default false. Since Apache Ant 1.7 boolean @@ -123,7 +123,7 @@ createfile - Whether the temp file should be created by this task; default false.Since Ant 1.8 + Whether the temp file should be created by this task; default false. Since Ant 1.8 boolean diff --git a/manual/Tasks/touch.html b/manual/Tasks/touch.html index 8adee3805..0acd73449 100644 --- a/manual/Tasks/touch.html +++ b/manual/Tasks/touch.html @@ -24,7 +24,7 @@ -

    Touch

    +

    Touch

    Description

    Changes the modification time of a resource and possibly creates it @@ -41,13 +41,13 @@ resource collections (which also includes directories). Prior to Apache Ant milliseconds. If you need more control you have to fall back to the <exec> task and native commands.

    -

    Starting with Ant 1.8.2 Ant will log a warning message if it fails +

    Since Ant 1.8.2, a warning message is logged upon failure to change the file modification time. This will happen if you try to change the modification time of a file you do not own on many Unix systems, for example.

    Parameters

    - +
    @@ -68,9 +68,9 @@ resource collections (which also includes directories). Prior to Apache Ant - + @@ -78,19 +78,19 @@ resource collections (which also includes directories). Prior to Apache Ant the current locale. Defaults to "MM/dd/YYYY hh:mm a" or "MM/dd/yyyy hh:mm:ss a" using the US locale. - Since Ant 1.6.3 + Since Ant 1.6.3 + directories when touching new files. Since Ant 1.6.3 + Since Ant 1.6.3
    Attribute Description
    datetimeSpecifies the new modification time of the file. The - special value "now" indicates the current time - (now supported since Ant 1.8).Specifies the new modification time of the file. + since Ant 1.8, the + special value "now" indicates the current time.
    pattern No
    mkdirs Whether to create nonexistent parent - directories when touching new files. Since Ant 1.6.3 No, default false.
    verbose Whether to log the creation of new files. - Since Ant 1.6.3 No, default true.
    @@ -111,14 +111,14 @@ not to filesets nested into a path or any other resource collection.

    mapper

    -

    Since Ant 1.6.3, a nested +

    Since Ant 1.6.3, a nested mapper can be specified. Files specified via nested filesets, filelists, or the file attribute are mapped using the specified mapper. For each file mapped, the resulting files are touched. If no time has been specified and the original file exists its timestamp will be used. - If no time has been specified and the original file does not exist the - current time is used. Since Ant 1.8 the task settings (millis, + If no time has been specified and the original file does not exist the + current time is used. Since Ant 1.8 the task settings (millis, and datetime) have priority over the timestamp of the original file.

    Examples

    @@ -132,8 +132,8 @@ hour times).

      <touch datetime="09/10/1974 4:30 pm">
         <fileset dir="src_dir"/>
       </touch>
    -

    changes the modification time to Oct, 09 1974 4:30 pm of all files and directories - found in src_dir.

    +

    changes the modification time to Oct, 09 1974 4:30 pm of all files and directories + found in src_dir.

      <touch file="myfile" datetime="06/28/2000 2:02:17 pm"/>

    creates myfile if it doesn't exist and changes the modification time to Jun, 28 2000 2:02:17 pm (14:02:17 for those used to 24 @@ -154,6 +154,5 @@ modification time to that of foo.

    src directory if it doesn't exist and changes the modification time of those files to the current time.

    - diff --git a/manual/Tasks/translate.html b/manual/Tasks/translate.html index 10e812a90..ee5c2e49e 100644 --- a/manual/Tasks/translate.html +++ b/manual/Tasks/translate.html @@ -24,7 +24,7 @@ -

    Translate

    +

    Translate

    Description

    Identifies keys in files delimited by special tokens and translates them with values read from resource bundles. @@ -76,7 +76,7 @@ Line endings of source files are preserved in the translated files. translate.

    Parameters

    - +
    @@ -160,8 +160,7 @@ translate.

    Examples

    Translate source file encoded in english into its japanese -equivalent using a resource bundle encoded in japanese. -

    +equivalent using a resource bundle encoded in japanese.

       <translate toDir="$(dest.dir}/ja"
             starttoken="#"
    diff --git a/manual/Tasks/truncate.html b/manual/Tasks/truncate.html
    index b7df3f7e6..0644e0413 100644
    --- a/manual/Tasks/truncate.html
    +++ b/manual/Tasks/truncate.html
    @@ -24,18 +24,18 @@
     
     
     
    -

    Truncate

    +

    Truncate

    Description

    Set the length of one or more files, as the intermittently available truncate Unix utility/function. In addition to working with a single file, this Task can also work on resources and resource collections. -Since Apache Ant 1.7.1. +Since Apache Ant 1.7.1.

    Parameters

    -
    Attribute Description
    +
    diff --git a/manual/Tasks/tstamp.html b/manual/Tasks/tstamp.html index f35d55873..8a290ba0d 100644 --- a/manual/Tasks/tstamp.html +++ b/manual/Tasks/tstamp.html @@ -24,7 +24,7 @@ -

    Tstamp

    +

    Tstamp

    Description

    Sets the DSTAMP, TSTAMP, and TODAY @@ -49,7 +49,7 @@ value in ISO-8601 format (1972-04-17T08:07:00Z). If you specify a v in an invalid format an INFO message will be logged and the value will be ignored.

    Parameters

    -
    Attribute Description
    +
    @@ -63,13 +63,14 @@ in an invalid format an INFO message will be logged and the value will be ignore
    Attribute Description

    Nested Elements

    +

    The Tstamp task supports a <format> nested element that allows a property to be set to the current date and time in a given format. The date/time patterns are as defined in the Java SimpleDateFormat class. The format element also allows offsets to be applied to the time to generate different time values. -

    - +

    +
    @@ -162,8 +163,5 @@ is suitable for use with the <touch> task. The standard prope Sets three properties with the standard formats, prefixed with "start.": start.DSTAMP, start.TSTAMP, and start.TODAY.

    - - - diff --git a/manual/Tasks/typedef.html b/manual/Tasks/typedef.html index bdd58a7f7..3d4155d29 100644 --- a/manual/Tasks/typedef.html +++ b/manual/Tasks/typedef.html @@ -24,7 +24,7 @@ -

    Typedef

    +

    Typedef

    Description

    Adds a task or a data type definition to the current project @@ -56,7 +56,7 @@

         typename=fully.qualified.java.classname
       
    - +

    The xml format is described in the Antlib section. @@ -84,7 +84,7 @@ attribute to work.

    Parameters

    -
    Attribute Description
    +
    @@ -126,12 +126,13 @@ to Antlib. The default is "properties" unless the file/resource name ends with ".xml", in which case the format attribute will have the value "xml". - since Apache Ant 1.6 + Since Ant 1.6 - + @@ -147,7 +148,7 @@ + so they can call each other. Since Ant 1.5 @@ -155,11 +156,11 @@ @@ -171,7 +172,7 @@ to wrap the defined class unless the defined class implements/extends the class defined by the attribute "adaptto". If "adaptto" is not set, the defined class will always be wrapped. - since Ant 1.6 + Since Ant 1.6 @@ -181,7 +182,7 @@ adapter attribute. If the defined class does not implement/extend the interface/class specified by this attribute, the adaptor class will be used - to wrap the class. since Ant 1.6 + to wrap the class. Since Ant 1.6 @@ -189,24 +190,23 @@
    Attribute Description No
    classpath the classpath to + classpaththe classpath to use when looking up classname. No
    the name of the loader that is used to load the class, constructed from the specified classpath. Use this to allow multiple tasks/types to be loaded with the same loader, - so they can call each other. since Ant 1.5 No
    The action to take if there was a failure in defining the type. The values are fail: cause a build exception; report: output a warning, but continue; ignore: do nothing. - since Ant 1.6 - An additional value is failall: cause all behavior of fail, + Since Ant 1.6, + an additional value is failall: cause all behavior of fail, as well as a build exception for the resource or file attribute - if the resource or file is not found. since Ant 1.7 - The default is fail. + if the resource or file is not found. Since Ant 1.7, + the default is fail. No
    No
    No
    uri The uri that this definition should live in. - since Ant 1.6 + Since Ant 1.6 No

    Parameters specified as nested elements

    classpath

    -

    Typedef's classpath attribute is a +

    Typedef's classpath attribute is a path-like structure and can also be set via a nested classpath element.

    Examples

    The following fragment defines define a type called urlset.
    -    <typedef name="urlset" classname="com.mydomain.URLSet"/> 
    + <typedef name="urlset" classname="com.mydomain.URLSet"/> The data type is now available to Ant. The - class com.mydomain.URLSet implements this type.

    - + class com.mydomain.URLSet implements this type.

    Assuming a class org.acme.ant.RunnableAdapter that @@ -234,15 +234,12 @@ <typedef name="filter1" classname="org.acme.filters.Filter1" classpathref="lib.path" - loaderref="lib.path.loader" - /> + loaderref="lib.path.loader"/> <typedef name="filter2" classname="org.acme.filters.Filter2" - loaderref="lib.path.loader" - /> + loaderref="lib.path.loader"/> - - +

    If you want to load an antlib into a special xml-namespace, the uri attribute is important: @@ -253,7 +250,7 @@ resource="net/sf/antcontrib/antlib.xml" classpath="path/to/ant-contrib.jar"/> - +

    Here the namespace declaration xmlns:antcontrib="antlib:net.sf.antcontrib" allows tasks and types of the AntContrib Antlib to be used with the @@ -263,7 +260,5 @@ prefix at any element to make it usable for the element it is declared on as well as all its child elements.

    - - diff --git a/manual/Tasks/unpack.html b/manual/Tasks/unpack.html index f7def5de8..6537d3152 100644 --- a/manual/Tasks/unpack.html +++ b/manual/Tasks/unpack.html @@ -24,7 +24,7 @@ -

    GUnzip/BUnzip2/UnXZ

    +

    GUnzip/BUnzip2/UnXZ

    Description

    Expands a resource packed using GZip, BZip2 or XZ.

    @@ -41,7 +41,7 @@ See Library Dependencies for more information.

    Parameters

    - +
    @@ -75,7 +75,7 @@ resource collection

    expands test.tar.bz2 to test.tar

    -<uncz src="test.tar.xz"/>
    +<unxz src="test.tar.xz"/>
     

    expands test.tar.xz to test.tar

    @@ -120,7 +120,5 @@ files on the fly, allowing a file to be mapped to multiple
     destinations, preserving the last modified time or a configurable file
     system timestamp granularity.

    - - diff --git a/manual/Tasks/untar.html b/manual/Tasks/untar.html index bfaf28f11..c087c5d04 100644 --- a/manual/Tasks/untar.html +++ b/manual/Tasks/untar.html @@ -24,12 +24,11 @@ -

    Untar

    +

    Untar

    Description

    Untars a tarfile.

    -This document has moved here +This document has moved here - diff --git a/manual/Tasks/unzip.html b/manual/Tasks/unzip.html index d62f20b54..8d7e68829 100644 --- a/manual/Tasks/unzip.html +++ b/manual/Tasks/unzip.html @@ -24,11 +24,11 @@ -

    Unjar/Untar/Unwar/Unzip

    +

    Unjar/Untar/Unwar/Unzip

    Description

    Unzips a zip-, war-, or jar file.

    PatternSets are used to select files to extract -from the archive. If no patternset is used, all files are extracted. +from the archive. If no patternset is used, all files are extracted.

    Resource @@ -66,7 +66,7 @@ archive.

    Parameters

    -
    Attribute Description
    +
    diff --git a/manual/Tasks/uptodate.html b/manual/Tasks/uptodate.html index c724f2065..62cf7e506 100644 --- a/manual/Tasks/uptodate.html +++ b/manual/Tasks/uptodate.html @@ -24,7 +24,7 @@ -

    Uptodate

    +

    Uptodate

    Description

    Sets a property if a target file or set of target files is more up-to-date than a source file or set of source files. A single source file is specified @@ -45,7 +45,7 @@ a <mapper> element, the default behavior is to use a

    Normally, this task is used to set properties that are useful to avoid target execution depending on the relative age of the specified files.

    Parameters

    -
    Attribute Description
    +
    @@ -77,7 +77,7 @@ target execution depending on the relative age of the specified files.

    Attribute Description

    Parameters specified as nested elements

    -

    srcfiles

    +

    srcfiles

    The nested <srcfiles> element is a fileset and allows you to specify a set of files to check against the target file(s).

    @@ -90,13 +90,13 @@ attribute or nested <srcfiles> elements, but not both. files. If you need logic that applies to directories as well, use a nested srcresource and a dirset (for example).

    -

    srcresources

    +

    srcresources

    The nested <srcresources> element is a union and allows you to specify a collection of resources to check against the target file(s). Since Apache Ant 1.7

    -

    mapper

    +

    mapper

    The nested <mapper> element allows you to specify a set of target files to check for being up-to-date with respect to a set of source files.

    @@ -120,7 +120,7 @@ any of the DTD files in the ${src}/xml directory.

    <srcfiles dir= "${src}/xml" includes="**/*.dtd"/> <mapper type="merge" to="${deploy}\xmlClasses.jar"/> </uptodate> -as well. +

    as well. The xmlBuild.notRequired property can then be used in a <target> tag's unless attribute to @@ -130,6 +130,7 @@ conditionally run that target. For example, running the following target:

    ... </target> +

    will first run the chkXmlBuild target, which contains the <uptodate> task that determines whether xmlBuild.notRequired gets set. The property named in @@ -138,7 +139,7 @@ If it did get set (ie., the jar file is up-to-date), then the xmlBuild target won't be run.

    -

    The following example shows a single source file being checked +

    The following example shows a single source file being checked against a single target file:

      <uptodate property="isUpToDate"
                 srcfile="/usr/local/bin/testit"
    @@ -147,7 +148,6 @@ against a single target file:

    sets the property isUpToDate to true if /usr/local/bin/testit is not newer than ${build}/.flagfile.

    -

    The following shows usage of a relative mapper.

    @@ -170,8 +170,5 @@ if /usr/local/bin/testit is not newer than </uptodate>
    - - - diff --git a/manual/Tasks/verifyjar.html b/manual/Tasks/verifyjar.html index 4be278811..58a751be5 100644 --- a/manual/Tasks/verifyjar.html +++ b/manual/Tasks/verifyjar.html @@ -24,16 +24,15 @@ -

    VerifyJar

    +

    VerifyJar

    Description

    Verifies JAR files with the jarsigner command line tool. It will take a named file in the jar attribute. Nested paths are also supported

    -

    Parameters

    - +
    @@ -100,10 +99,10 @@ supported jarsigner command. since Ant 1.8.0. - +
    Attribute Description No

    Parameters as nested elements

    - +
    @@ -116,13 +115,13 @@ supported - + + environment variables
    Attribute Description
    filesetfileset of JAR files to verify. fileset of JAR files to verify. No
    sysproperty JVM system properties, with the syntax of Ant - environment variables No, and only one can be supplied
    @@ -138,8 +137,5 @@ alias="apache-group" storepass="secret"/> keystore and private key via "secret" password.

    - - - diff --git a/manual/Tasks/vss.html b/manual/Tasks/vss.html index 2c0ed68c1..2552ade15 100644 --- a/manual/Tasks/vss.html +++ b/manual/Tasks/vss.html @@ -41,7 +41,7 @@
  • The Tasks

  • -

    Introduction

    +

    Introduction

    These tasks provide an interface to the Microsoft Visual SourceSafe SCM. The org.apache.tools.ant.taskdefs.optional.vss package consists of a simple framework to support @@ -53,9 +53,9 @@ 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 command line -you may need to alter your path, or set the ssdir property. -

    The Tasks

    +

    The Tasks

    - +
    @@ -95,13 +95,13 @@ property. -

    VssGet

    +

    VssGet

    Description

    Task to perform GET commands to Microsoft Visual SourceSafe.

    If you specify two or more attributes from version, date and label only one will be used in the order version, date, label.

    Parameters

    -
    vssget Retrieves a copy of the specified VSS file(s).
    +
    @@ -118,7 +118,7 @@ label only one will be used in the order version, date, label.

    + login without a password. @@ -178,7 +178,7 @@ label only one will be used in the order version, date, label.

    - @@ -190,8 +190,8 @@ label only one will be used in the order version, date, label.

    - +
    Attribute Values username[,password] - The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password) - Ant/VSS will hang if you leave the password out and VSS does not accept - login without a password. No
    writablefilesBehavior when local files are writable. Valid options are: replace, + Behavior when local files are writable. Valid options are: replace, skip and fail; Defaults to fail
    skip implies failonerror=false
    No
    filetimestampSet the behavior for timestamps of local files. Valid options are current, - modified, or updated. Defaults to current.Set the behavior for timestamps of local files. Valid options are current, + modified, or updated. Defaults to current. No
    @@ -215,13 +215,13 @@ which are labeled Release1 and write them to the local directory -

    VssLabel

    +

    VssLabel

    Description

    Task to perform LABEL commands to Microsoft Visual SourceSafe.

    Assigns a label to the specified version or current version of a file or project.

    Parameters

    - +
    @@ -238,7 +238,7 @@ project.

    + login without a password. @@ -307,11 +307,11 @@ the build) will fail. -

    VssHistory

    +

    VssHistory

    Description

    Task to perform HISTORY commands to Microsoft Visual SourceSafe.

    Parameters

    -
    Attribute Values username[,password] - The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password) - Ant/VSS will hang if you leave the password out and VSS does not accept - login without a password. No
    +
    @@ -328,7 +328,7 @@ Task to perform HISTORY commands to Microsoft Visual SourceSafe. + login without a password. @@ -404,7 +404,7 @@ Task to perform HISTORY commands to Microsoft Visual SourceSafe.

    Specifying the time-frame

    There are different ways to specify what time-frame you wish to evaluate:

      -
    • Changes between two dates: Specify both fromDate and toDate
    • +
    • Changes between two dates: Specify both fromDate and toDate
    • Changes before a date: Specify toDate
    • Changes after a date: Specify fromDate
    • Changes X Days before a date: Specify toDate and (negative!) numDays
    • @@ -448,11 +448,11 @@ Task to perform HISTORY commands to Microsoft Visual SourceSafe. -

      VssCheckin

      +

      VssCheckin

      Description

      Task to perform CHECKIN commands to Microsoft Visual SourceSafe.

      Parameters

      -
    Attribute Valuesusername[,password] - The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password) - Ant/VSS will hang if you leave the password out and VSS does not accept - login without a password. No
    +
    @@ -469,7 +469,7 @@ Task to perform CHECKIN commands to Microsoft Visual SourceSafe. + login without a password. @@ -529,13 +529,13 @@ the local directory D:\build.

    -

    VssCheckout

    +

    VssCheckout

    Description

    Task to perform CHECKOUT commands to Microsoft Visual SourceSafe.

    If you specify two or more attributes from version, date and label only one will be used in the order version, date, label.

    Parameters

    -
    Attribute Valuesusername[,password] - The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password) - Ant/VSS will hang if you leave the password out and VSS does not accept - login without a password. No
    +
    @@ -552,7 +552,7 @@ label only one will be used in the order version, date, label.

    + login without a password. @@ -596,7 +596,7 @@ label only one will be used in the order version, date, label.

    - @@ -608,13 +608,13 @@ label only one will be used in the order version, date, label.

    - + - +
    Attribute Values username[,password] - The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password) - Ant/VSS will hang if you leave the password out and VSS does not accept - login without a password. No
    writablefilesBehavior when local files are writable. Valid options are: replace, + Behavior when local files are writable. Valid options are: replace, skip and fail; Defaults to fail
    skip implies failonerror=false
    No
    filetimestampSet the behavior for timestamps of local files. Valid options are current, - modified, or updated. Defaults to current.Set the behavior for timestamps of local files. Valid options are current, + modified, or updated. Defaults to current. No
    getlocalcopySet the behavior to retrieve local copies of the files. Defaults to true.Set the behavior to retrieve local copies of the files. Defaults to true. No
    @@ -634,11 +634,11 @@ label only one will be used in the order version, date, label.

    -

    VssAdd

    +

    VssAdd

    Description

    Task to perform ADD commands to Microsoft Visual SourceSafe.

    Parameters

    - +
    @@ -654,7 +654,7 @@ Task to perform ADD commands to Microsoft Visual SourceSafe. + login without a password. @@ -708,12 +708,12 @@ directory (see vsscp).

    -

    VssCp

    +

    VssCp

    Description

    Task to perform CP (Change Project) commands to Microsoft Visual SourceSafe.

    This task is typically used before a VssAdd in order to set the target project

    Parameters

    -
    Attribute Valuesusername[,password] - The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password) - Ant/VSS will hang if you leave the password out and VSS does not accept - login without a password. No
    +
    @@ -730,7 +730,7 @@ directory (see vsscp).

    + login without a password. @@ -762,12 +762,12 @@ directory (see vsscp).

    -

    VssCreate

    -

    Description

    +

    VssCreate

    +

    Description

    Task to perform CREATE commands to Microsoft Visual Source Safe.

    Creates a new project in VSS.

    Parameters

    -
    Attribute Values username[,password] - The username and password needed to get access to VSS. Note that you may need to specify both (if you have a password) - Ant/VSS will hang if you leave the password out and VSS does not accept - login without a password. No
    +
    @@ -816,8 +816,6 @@ directory (see vsscp).

    Creates the VSS-Project $/existingProject/newProject.

    -
    - diff --git a/manual/Tasks/waitfor.html b/manual/Tasks/waitfor.html index 54ff8edf6..30dc465a5 100644 --- a/manual/Tasks/waitfor.html +++ b/manual/Tasks/waitfor.html @@ -37,7 +37,7 @@ if multiple conditions are specified, then the task will wait until all conditio property of that name will be created if the condition didn't come true within the specified time.

    Parameters

    -
    Attribute Values
    +
    @@ -94,8 +94,8 @@ true within the specified time.

    Attribute Description No
    -

    Nested Elements

    +

    Nested Elements

    The available conditions that satisfy the <waitfor> task are the same as those for the <condition> task. See @@ -127,7 +127,5 @@ true within the specified time.

    on port 1521 and for the http://webserver/mypage.html web page to become available.

    - - diff --git a/manual/Tasks/war.html b/manual/Tasks/war.html index 2c920068e..4b17527fc 100644 --- a/manual/Tasks/war.html +++ b/manual/Tasks/war.html @@ -24,7 +24,7 @@ -

    War

    +

    War

    Description

    An extension of the Jar task with special treatment for files that should end up in the @@ -46,7 +46,7 @@ attributes of zipfilesets in a Zip or Jar task.)

    it is not optional by default. The task will fail if the file is not included, unless the needxmlfile attribute is set to false. The task - will warn if more than one web.xml file is added to the JAR + will warn if more than one web.xml file is added to the JAR through the filesets.

    @@ -58,7 +58,7 @@ to avoid this behavior you must set the duplicate attribute to a value other than its default, "add".

    Parameters

    - +
    @@ -180,7 +180,7 @@ to a value other than its default, "add".

    - + @@ -358,7 +358,5 @@ Winzip has an option allowing all uppercase names (which is off by default!). I Menu "Options" -> "Configuration", "View" property/tab page, then "General" group box has an option called "Allow all uppercase file names".

    - - diff --git a/manual/Tasks/whichresource.html b/manual/Tasks/whichresource.html index 5b2b54eab..e4fc24390 100644 --- a/manual/Tasks/whichresource.html +++ b/manual/Tasks/whichresource.html @@ -14,19 +14,16 @@ See the License for the specific language governing permissions and limitations under the License. --> - + - - Whichresource Task - - + + Whichresource Task - -

    Whichresource

    +

    Whichresource

    Description

    Find a class or resource on the supplied classpath, or the @@ -38,7 +35,7 @@ <whichresource resource="/log4j.properties" property="log4j.url" >

    Parameters

    -
    Attribute Description
    duplicatebehavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". No
    +
    @@ -116,5 +113,5 @@ </whichresource> <echo>${ant-contrib.antlib.location}</echo> - + diff --git a/manual/Tasks/wljspc.html b/manual/Tasks/wljspc.html index 566349470..5918012fd 100644 --- a/manual/Tasks/wljspc.html +++ b/manual/Tasks/wljspc.html @@ -15,15 +15,17 @@ limitations under the License. --> - -WLJSPC Task + + + WLJSPC Task +

    wljspc

    Description

    Class to precompile JSP's using weblogic's jsp compiler (weblogic.jspc)

    Tested only on Weblogic 4.5.1 - NT4.0 and Solaris 5.7,5.8

    Parameters

    -
    Attribute Description
    +
    @@ -38,13 +40,13 @@ Tested only on Weblogic 4.5.1 - NT4.0 and Solaris 5.7,5.8
    - + - + @@ -67,13 +69,10 @@ The task checks timestamps on the JSP's and the generated classes, and compiles< only those files that have changed.

    It follows the weblogic naming convention of putting classes in
    - _dirName/_fileName.class for dirname/fileName.jsp
    +_dirName/_fileName.class for dirname/fileName.jsp

    -


    -Example
    -

    -

    +

    Example

     <target name="jspcompile" depends="compile">
       <wljspc src="c:\\weblogic\\myserver\\public_html" dest="c:\\weblogic\\myserver\\serverclasses" package="myapp.jsp">
    @@ -85,8 +84,6 @@ Example
    </target>
    -

    -

    Limitations

    • This works only on weblogic 4.5.1
    • diff --git a/manual/Tasks/xmlproperty.html b/manual/Tasks/xmlproperty.html index 293cf2455..00f969096 100644 --- a/manual/Tasks/xmlproperty.html +++ b/manual/Tasks/xmlproperty.html @@ -22,7 +22,7 @@ -

      XmlProperty

      +

      XmlProperty

      Description

      Loads property values from a well-formed xml file. There are no other restrictions @@ -45,9 +45,7 @@ does no processing of the input. In particular, unlike the Property task, property references (i.e., ${foo}) are not resolved.

      - -

      Semantic Attributes

      - +

      Semantic Attributes

      Input processing can be enabled by using the semanticAttributes attribute. If this attribute is set to true (its default is false), the following processing occurs as the input XML file @@ -75,6 +73,7 @@ is loaded:

      For example, with semantic attribute processing enabled, this XML property file: +

         <root>
           <properties>
      @@ -89,10 +88,8 @@ is roughly equivalent to the following fragments in a build.xml file:
         <property name="root.properties.quux" value="${root.properties.foo}"/>
       
      -

      -

      Parameters

      -
    Attribute
    dest root of destination directory, what you have set as WorkingDir in the weblogic propertiesroot of destination directory, what you have set as WorkingDir in the weblogic properties Yes
    package start package name under which your JSP's would be compiledstart package name under which your JSP's would be compiled Yes
    +
    @@ -144,7 +141,7 @@ is roughly equivalent to the following fragments in a build.xml file: - + @@ -153,7 +150,7 @@ is roughly equivalent to the following fragments in a build.xml file:
    Attribute DescriptionrootDirectory The directory to use for resolving file references. Ignored if semanticAttributes is not set to true.No, default is ${basedir}.No, default is ${basedir}.
    delimiter
    -

    Nested Elements

    +

    Nested Elements

    xmlcatalog

    The <xmlcatalog> element is used to perform entity resolution.

    @@ -163,9 +160,7 @@ resource collection

    The specified resource will be used as input.

    - -

    Examples

    -
    +

    Examples

    Non-semantic Attributes

    @@ -283,7 +278,5 @@ is equivalent to the following entries in a build file: </path> - - diff --git a/manual/Tasks/xmlvalidate.html b/manual/Tasks/xmlvalidate.html index c362bbe38..5981f2933 100644 --- a/manual/Tasks/xmlvalidate.html +++ b/manual/Tasks/xmlvalidate.html @@ -23,7 +23,7 @@ -

    XMLValidate

    +

    XMLValidate

    Description

    This task checks that XML files are valid (or only well formed). The @@ -31,24 +31,26 @@ task uses the SAX2 parser implementation provided by JAXP by default (probably the one that is used by Apache Ant itself), but one can specify any SAX1/2 parser if needed.

    -

    This task supports the use of nested +

    This task supports the use of nested

    +
    • <xmlcatalog> elements
    • <dtd> elements which are used to resolve DTDs and entities
    • <attribute> elements which are used to set features on the parser. These can be any number of http://xml.org/sax/features/ or other features that your parser may support.
    • -
    • <property> elements, containing string properties -

      +
    • <property> elements, containing string properties
    • +
    -

    Warning : JAXP creates by default a non namespace aware parser. +

    Warning: By default, JAXP creates a non namespace aware parser. The "http://xml.org/sax/features/namespaces" feature is set -by default to false by the JAXP implementation used by ant. To validate +by default to false by the JAXP implementation used by Ant. To validate a document containing namespaces, -set the namespaces feature to true explicitly by nesting the following element: +set the namespaces feature to true explicitly by nesting the following element:

       <attribute name="http://xml.org/sax/features/namespaces" value="true"/>
     
    +

    If you are using for instance a xsi:noNamespaceSchemaLocation attribute in your XML files, you will need this namespace support feature.

    @@ -57,7 +59,7 @@ may not apply.

    Parameters

    - +
    @@ -98,12 +100,12 @@ may not apply.

    Attribute Description
    -

    Nested Elements

    +

    Nested Elements

    dtd

    <dtd> is used to specify different locations for DTD resolution.

    - +
    @@ -130,9 +132,9 @@ Features usable with the xerces parser are defined here : Setting features
    SAX features are defined here: - http://xml.org/sax/features/
    +http://xml.org/sax/features/

    -
    Attribute Description
    +
    @@ -149,7 +151,6 @@ SAX features are defined here:
    Attribute DescriptionYes
    -

    property

    The <property> element is used to set properties. @@ -157,7 +158,7 @@ These properties are defined here for the xerces XML parser implementation : XML Parser properties Properties can be used to set the schema used to validate the XML file.

    - +
    @@ -174,8 +175,6 @@ Properties can be used to set the schema used to validate the XML file.
    Attribute DescriptionYes
    -

    -

    Examples

    @@ -199,8 +198,8 @@ halt the build.
     </xmlvalidate>
     
    -Validate a struts configuration, using a local copy of the DTD. -
     
    +Validate a struts configuration, using a local copy of the DTD.
    +
     <xmlvalidate failonerror="no">
       <fileset dir="${project.dir}" includes="**/*.xml"/>
       <xmlcatalog refid="mycatalog"/>
    @@ -253,11 +252,8 @@ and makes it easy to add a list of schema files/URLs to act as sources.
       value="${xsd.file}"/>
     </xmlvalidate>
     
    -
    +

    Validate the file xml/endpiece-noSchema.xml against the schema xml/doc.xsd. -
    - - +

    - diff --git a/manual/Tasks/zip.html b/manual/Tasks/zip.html index 4d66851aa..4b0949fd9 100644 --- a/manual/Tasks/zip.html +++ b/manual/Tasks/zip.html @@ -24,7 +24,7 @@ -

    Zip

    +

    Zip

    Description

    Creates a zipfile.

    The basedir attribute is the reference directory from where to zip.

    @@ -37,7 +37,7 @@ the files you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default exclusions or not. See the section on directory based tasks, on how the -inclusion/exclusion of files works, and how to write patterns.

    +inclusion/exclusion of files works, and how to write patterns.

    This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes basedir) as well as the nested @@ -49,9 +49,9 @@ if basedir is set. You may use any mixture of the implicit file set (with basedir set, and optional attributes like includes and optional subelements like <include>); explicit nested <fileset> elements so long as at least one fileset total is specified. The ZIP file will -only reflect the relative paths of files within each fileset. The Zip task and its derivatives know a special form of a fileset named zipfileset that has additional attributes (described below).

    -

    The Zip task also supports the merging of multiple zip files into the zip file. -This is possible through either the src attribute of any nested filesets +only reflect the relative paths of files within each fileset. The Zip task and its derivatives know a special form of a fileset named zipfileset that has additional attributes (described below).

    +

    The Zip task also supports the merging of multiple zip files into the zip file. +This is possible through either the src attribute of any nested filesets or by using the special nested fileset zipgroupfileset.

    The update parameter controls what happens if the ZIP @@ -77,7 +77,7 @@ and set it to UTF8 to create zip files that can safely be read by Java. For a more complete discussion, see below

    -

    Starting with Ant 1.5.2, <zip> can store Unix permissions +

    Since Ant 1.5.2, <zip> can store Unix permissions inside the archive (see description of the filemode and dirmode attributes for <zipfileset>). Unfortunately there is no portable way to store these permissions. @@ -108,7 +108,7 @@ you use Windows' functions to extract an Ant generated ZIP archive.

    Parameters

    - +
    @@ -141,7 +141,7 @@ archive.

    @@ -202,7 +202,7 @@ archive.

    - + @@ -239,7 +239,7 @@ archive.

    that the permissions haven't been stored at all rather than real permissions and will instead apply its own default values.
    Set this attribute to true if you really want to preserve the - original permission field.since Ant 1.8.0 + original permission field. Since Ant 1.8.0 @@ -248,8 +248,8 @@ archive.

    + Since Ant 1.8.0.
    + See also the discussion below @@ -259,8 +259,8 @@ archive.


    Possible values are "never", "always" and "not-encodeable" which will only add Unicode extra fields if the file name cannot be encoded using the specified encoding. - Since Ant 1.8.0. -
    See also the discussion below + Since Ant 1.8.0.
    + See also the discussion below @@ -268,21 +268,21 @@ archive.

    + Since Ant 1.8.0.
    + See also the discussion below + Since Ant 1.9.1.
    + See also the discussion below
    Attribute Description For entries coming from existing archives (like nested zipfilesets or while updating the archive), keep the compression as it has been originally instead of using the - compress attribute. Defaults false. Since Ant + compress attribute. Defaults to false. Since Ant 1.6 No
    duplicatebehavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". No
    No, default is false
    Whether to set the language encoding flag if the encoding is UTF-8. This setting doesn't have any effect if the encoding is not UTF-8. - Since Ant 1.8.0. -
    See also the discussion below
    No, default is true
    No, default is "never"
    Whether to use UTF-8 and the language encoding flag instead of the specified encoding if a file name cannot be encoded using the specified encoding. - Since Ant 1.8.0. -
    See also the discussion below
    No, default is false
    zip64Mode When to use Zip64 extensions for entries. The possible values are "never", "always" and "as-needed". - Since Ant 1.9.1. -
    See also the discussion below
    No, default is "as-needed"
    -

    Encoding of File Names

    +

    Encoding of File Names

    Traditionally the ZIP archive format uses CodePage 437 as encoding for file name, which is not sufficient for many international @@ -294,30 +294,30 @@ archive.

    Ant has been offering the encoding attribute of the zip and unzip task as a way to explicitly specify the encoding to use (or expect) - since Ant 1.4. It defaults to the platform's default encoding for + since Ant 1.4. It defaults to the platform's default encoding for zip and UTF-8 for jar and other jar-like tasks (war, ear, ...) as well as the unzip family of tasks.

    More recent versions of the ZIP specification introduce something called the "language encoding flag" which can be used to - signal that a file name has been encoded using UTF-8. Starting with - Ant 1.8.0 all zip-/jar- and similar archives written by Ant will set + signal that a file name has been encoded using UTF-8. Since + Ant 1.8.0, all zip-/jar- and similar archives written by Ant will set this flag, if the encoding has been set to UTF-8. Our - interoperabilty tests with existing archivers didn't show any ill + interoperability tests with existing archivers didn't show any ill effects (in fact, most archivers ignore the flag to date), but you can turn off the "language encoding flag" by setting the attribute useLanguageEncodingFlag to false on the zip-task if you should encounter problems.

    -

    The unzip (and similar tasks) -task will recognize the language +

    The unzip task (and similar tasks) will recognize the language encoding flag and ignore the encoding set on the task if it has been found.

    The InfoZIP developers have introduced new ZIP extra fields that can be used to add an additional UTF-8 encoded file name to the - entry's metadata. Most archivers ignore these extra fields. The - zip family of tasks support an - option createUnicodeExtraFields since Ant 1.8.0 which + entry's metadata. Most archivers ignore these extra fields. + Since Ant 1.8.0, the zip family of tasks support an + option createUnicodeExtraFields, which makes Ant write these extra fields either for all entries ("always") or only those whose name cannot be encoded using the specified encoding (not-encodeable), it defaults to "never" since the extra @@ -337,7 +337,7 @@ archive.

    The optimal setting of flags depends on the archivers you expect as consumers/producers of the ZIP archives. Below are some test - results which may be superseeded with later versions of each + results which may be superseded with later versions of each tool.

      @@ -345,7 +345,7 @@ archive.

      jars from your CLASSPATH reads and writes UTF-8 names, it doesn't set or recognize any flags or unicode extra fields. -
    • Starting with Java7 java.util.zip writes UTF-8 by +
    • Starting with Java 7 java.util.zip writes UTF-8 by default and uses the language encoding flag. It is possible to specify a different encoding when reading/writing ZIPs via new constructors. The package now recognizes the language encoding @@ -381,7 +381,7 @@ archive.

      If you are creating jars, then java.util.zip is your main consumer. We recommend you set the encoding to UTF-8 and keep the language encoding flag enabled. The flag won't help or hurt - java.util.zip prior to Java7 but archivers that support it will show + java.util.zip prior to Java 7 but archivers that support it will show the correct file names.

      For maximum interop it is probably best to set the encoding to @@ -398,7 +398,7 @@ archive.

      so the tools that support them will extract the file names correctly.

      -

      Zip64 extensions

      +

      Zip64 extensions

      Zip64 extensions provide a way to create archives bigger than 4GB or holding more than 65535 entries - or add individual entries @@ -438,9 +438,9 @@ archive.

      understand Zip64 extra fields or fail to parse archives with extra fields in local file headers that are not present in the central directory, one such implementation is the java.util.zip package of - Java5, that's why the jar tasks default + Java 5, that's why the jar tasks default to never. Archives created with as-needed can be - read without problems with Java6 and later.

      + read without problems with Java 6 and later.

      Parameters specified as nested elements

      @@ -450,15 +450,14 @@ Collections are used to select groups of files to archive.

      Prior to Ant 1.7 only <fileset> and <zipfileset> have been supported as nested elements.

      - -

      zipgroupfileset

      -

      A <zipgroupfileset> allows for multiple zip files to be -merged into the archive. Each file found in this fileset is added to the archive +

      zipgroupfileset

      +

      A <zipgroupfileset> allows for multiple zip files to be +merged into the archive. Each file found in this fileset is added to the archive the same way that zipfileset src files are added.

      <zipgroupfileset> is a fileset and supports all - of its attributes and nested elements. + of its attributes and nested elements.

      Examples

        <zip destfile="${dist}/manual.zip"
      @@ -501,7 +500,7 @@ it had been located at htdocs/manual/ChangeLog.txt.

      </zip>

      zips all files in the htdocs/manual directory into the docs/user-guide directory in the archive, adds the file ChangeLog27.txt in the -current directory as docs/ChangeLog.txt, and includes all the html files in examples.zip +current directory as docs/ChangeLog.txt, and includes all the html files in examples.zip under docs/examples. The archive might end up containing the files:

          docs/user-guide/html/index.html
           docs/ChangeLog.txt
      @@ -544,8 +543,5 @@ The next example
       permissions have been stored as part of the TAR file, they will be
       retained in the resulting ZIP archive.

      - - -