diff --git a/docs/ant_in_anger.html b/docs/ant_in_anger.html index da6bef7f1..596b8db77 100644 --- a/docs/ant_in_anger.html +++ b/docs/ant_in_anger.html @@ -12,7 +12,7 @@

-Steve Loughran (steve_l@iseran.com) +Steve Loughran

@@ -38,7 +38,7 @@ done. Firstly, here are some assumptions about the projects which this document covers -
-

Copyright © 2000 Apache Software Foundation. All rights -Reserved.

+ +

About the Author

+ + +Steve Loughran is a research scientist at a corporate R&D lab, +currently on a sabbatical building production web services against +implausible deadlines for the fun of it. Because of those implausible +deadlines, email questions related to this document are generally, and +regretfully unwelcome, unless they are corrections to the content, +advanced discourse on how to evolve software engineering processes to +meet the next generation of challenges, or from someone he knows. Even +then, a timely response is unlikely. Please use the mailing lists +instead. +
+

Copyright © 2000, 2001 Apache Software Foundation. All rights +Reserved.

+ \ No newline at end of file diff --git a/docs/manual/CoreTasks/antcall.html b/docs/manual/CoreTasks/antcall.html index 2c4c94663..e612a76e0 100644 --- a/docs/manual/CoreTasks/antcall.html +++ b/docs/manual/CoreTasks/antcall.html @@ -24,10 +24,10 @@ setting of inheritAll. This allows you to parameterize your subprojects.

When a target is invoked by antcall, all of its dependent targets will also be called within the context of any new parameters. For example. if -the target "doSomethingElse" depended on the target "init", then the antcall of -"doSomethingElse" will call "init" during the call. Of course, any properties defined in the -antcall task or inherited from the calling target will be fixed and not overridable -in the init task -or indeed in the "doSomethingElse" task. +the target "doSomethingElse" depended on the target "init", then the +antcall of "doSomethingElse" will call "init" during the call. +Of course, any properties defined in the antcall task or inherited from the calling target +will be fixed and not overridable in the init task -or indeed in the "doSomethingElse" task.

Parameters

diff --git a/docs/manual/CoreTasks/available.html b/docs/manual/CoreTasks/available.html index 6652f4791..818291873 100644 --- a/docs/manual/CoreTasks/available.html +++ b/docs/manual/CoreTasks/available.html @@ -51,6 +51,11 @@ execution depending on system parameters.

+ + + + + @@ -58,7 +63,9 @@ execution depending on system parameters.

- + @@ -68,6 +75,10 @@ execution depending on system parameters.

Available's classpath attribute is a path-like structure and can also be set via a nested <classpath> element.

+

filepath

+

Available's filepath attribute is a path-like structure and can also be set via a nested +<filepath> element.

Examples

  <available classname="org.whatever.Myclass" property="Myclass.present"/>

sets the Myclass.present property to the value "true" diff --git a/docs/manual/CoreTasks/chmod.html b/docs/manual/CoreTasks/chmod.html index 918cd2d69..fefd8f63a 100644 --- a/docs/manual/CoreTasks/chmod.html +++ b/docs/manual/CoreTasks/chmod.html @@ -44,7 +44,7 @@ directly. More FileSets can be specified using nested

+ included. diff --git a/docs/manual/CoreTasks/copy.html b/docs/manual/CoreTasks/copy.html index 65a2a8d2b..7c06147f0 100644 --- a/docs/manual/CoreTasks/copy.html +++ b/docs/manual/CoreTasks/copy.html @@ -53,8 +53,9 @@ To use a fileset, the todir attribute must be set.

- + @@ -73,11 +74,22 @@ To use a fileset, the todir attribute must be set.

The classpath to use when looking up classname or resource. No
filepathThe path to use when looking up file.No
classpathref The classpath to use, given as a reference to a path defined elsewhere.
typeThe type of file to look for, either a directory (type="dir") or a file (type="file"). If not set, the property will be set if the name specified in the file attribute exists as either a file or a directory.The type of file to look for, either a directory (type="dir") or a file + (type="file"). If not set, the property will be set if the name specified in the file + attribute exists as either a file or a directory. No
includes comma separated list of patterns of files that must be - included. All files are included when omitted. No
filteringIndicates whether token filtering should take place during - the copy. Defaults to "no".Indicates whether token filtering using the global build file + filters should take place during the copy. Defaults to "no". + Nested filtersets will be used even if this value is "no" No

Parameters specified as nested elements

+ +

fileset

+

FileSets are used to select files to copy. + To use a fileset, the todir attribute must be set.

+

mapper

-

You can define file name transformations by using a nested mapper element. The default mapper used by -<copy> is the identity.

+

You can define file name transformations by using a nested mapper element. The default mapper used by + <copy> is the identity.

+ +

filterset

+

Filtersets are used to replace tokens in files that are copied. + To use a filterset just add the nested filterset elements.

+ +

Examples

Copy a single file

@@ -113,6 +125,19 @@ href="../CoreTypes/mapper.html#identity-mapper">identity.

     <mapper type="glob" from="*" to="*.bak"/>
   </copy>
+ + +

Copy a set of files to a replacing @TITLE@ with Foo Bar in all files.

+
+  <copy todir="../backup/dir" >
+    <fileset dir="src_dir" />
+    <filterset>
+      <filter token="TITLE" value="Foo Bar" />
+    </filterset>
+  </copy>
+
+ +

Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.

diff --git a/docs/manual/CoreTasks/delete.html b/docs/manual/CoreTasks/delete.html index 96de2d750..b8ece05b2 100644 --- a/docs/manual/CoreTasks/delete.html +++ b/docs/manual/CoreTasks/delete.html @@ -112,7 +112,7 @@ and any sub-directories.

<fileset dir="build" /> </delete> -

deletes all files and subdirectories of build, but not +

deletes all files and subdirectories of build, including build itself.

Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.

diff --git a/docs/manual/CoreTasks/dependset.html b/docs/manual/CoreTasks/dependset.html index d2088c8a8..61a78ae3f 100644 --- a/docs/manual/CoreTasks/dependset.html +++ b/docs/manual/CoreTasks/dependset.html @@ -110,12 +110,12 @@ filelists, and if any are older, they are all deleted.

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. a common DTD (imported by the main DTD)
  3. a subordinate XSLT stylesheet (imported by the main stylesheet), or
  4. the buildfile
    5. - +

If any of the source files in the above example does not exist, all diff --git a/docs/manual/CoreTasks/ear.html b/docs/manual/CoreTasks/ear.html index d40412743..9d8db6415 100644 --- a/docs/manual/CoreTasks/ear.html +++ b/docs/manual/CoreTasks/ear.html @@ -91,6 +91,12 @@ attributes of zipfilesets in a Zip or Jar task.)

the manifest file to use. No + + update + indicates whether to update or overwrite + the destination file if it already exists. + No + whenempty Behavior to use if no files match. @@ -106,8 +112,8 @@ fileset includes a file named MANIFEST.MF, the file is ignored and you will get a warning.

Example

-    <ear earfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml">
-      <fileset dir="${build.dir}" includes="*.jar,*.war"/>
+    <ear earfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml">
+      <fileset dir="${build.dir}" includes="*.jar,*.war"/>
     </ear>
diff --git a/docs/manual/CoreTasks/fixcrlf.html b/docs/manual/CoreTasks/fixcrlf.html index 98a630922..131340ab7 100644 --- a/docs/manual/CoreTasks/fixcrlf.html +++ b/docs/manual/CoreTasks/fixcrlf.html @@ -102,9 +102,9 @@ supports all attributes of <fileset>
  • crlf: convert all EOLs to the pair CRLF
    • Default is based on the platform on which you are running - this task. For Unix platforms, the default is "lf". + this task. For Unix platforms, the default is "lf". For DOS based systems (including Windows), the default is - "crlf". For Mac OS, the default is "cr". + "crlf". For Mac OS, the default is "cr".

    This is the preferred method for specifying EOL. The "cr" attribute (see below) is @@ -138,9 +138,9 @@ supports all attributes of <fileset> Default is based on the platform on which you are running - this task. For Unix platforms, the default is "remove". + this task. For Unix platforms, the default is "remove". For DOS based systems (including Windows), the default is - "add". + "add".

    N.B.: One special case is recognized. The three characters CR-CR-LF are regarded as a single EOL. @@ -164,7 +164,6 @@ supports all attributes of <fileset> No - tab Specifies how tab characters are to be handled. Valid values for this property are: diff --git a/docs/manual/CoreTasks/jar.html b/docs/manual/CoreTasks/jar.html index 74d0ca222..d44209310 100644 --- a/docs/manual/CoreTasks/jar.html +++ b/docs/manual/CoreTasks/jar.html @@ -33,6 +33,11 @@ in the jar task. See the Zip task for more details and examples.

    If the manifest is omitted, a simple one will be supplied by Ant. You should not include META-INF/MANIFEST.MF in your set of files.

    +

    The update parameter controls what happens if the +JAR file already exists. When set to yes, the JAR file is +updated with the files specified. When set to no (the +default) the JAR file is overwritten. An example use of this is +provided in the Zip task documentation.

    The whenempty parameter controls what happens when no files match. If create (the default), the JAR is created anyway with only a manifest. If skip, the JAR is not created and a warning is issued. @@ -113,6 +118,12 @@ include an empty one for you.)

    the manifest file to use. No + + update + indicates whether to update or overwrite + the destination file if it already exists. + No + whenempty Behavior to use if no files match. diff --git a/docs/manual/CoreTasks/javac.html b/docs/manual/CoreTasks/javac.html index 9387ed6b5..18d020841 100644 --- a/docs/manual/CoreTasks/javac.html +++ b/docs/manual/CoreTasks/javac.html @@ -9,7 +9,7 @@

    Javac

    Description

    -

    Compiles a source tree within the running (Ant) VM.

    +

    Compiles a Java source tree.

    The source and destination directory will be recursively scanned for Java source files to compile. Only Java files that have no corresponding class file or where the class file is older than the java file will be compiled.

    @@ -29,7 +29,7 @@ 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.

    It is possible to use different compilers. This can be selected with the -"build.compiler" property. There are four choices:

    +"build.compiler" property. Here are the choices:-

    • classic (the standard compiler of JDK 1.1/1.2) - javac1.1 and javac1.2 can be used as aliases
      • @@ -47,7 +47,7 @@ inclusion/exclusion of files works, and how to write patterns.

    • extJavac (run either modern or classic in a JVM of its own)

    For JDK 1.1/1.2, classic is the default. For JDK 1.3/1.4, modern is the default. -If you wish to use a different compiler interface than one of the four +If you wish to use a different compiler interface than those supplied, write a class that implements the CompilerAdapter interface (package org.apache.tools.ant.taskdefs.compilers). Supply the full classname in the "build.compiler" property. @@ -137,6 +137,12 @@ files/directories from the CLASSPATH it passes to the compiler.

    this option yet) No + + nowarn + indicates whether -nowarn switch should be passed + to the compiler; defaults to off. + No + debug indicates whether source should be compiled with debug @@ -189,6 +195,20 @@ files/directories from the CLASSPATH it passes to the compiler.

    defaults to no. No + + memoryInitialSize + the initial size of the memory for the underlying VM, if javac is run + externally, ignored otherwise; defaults to the standard VM memory setting. + (examples: 83886080, 81920k, or 80m) + No + + + memoryMaximumSize + the maximum size of the memory for the underlying VM, if javac is run + externally, ignored otherwise; defaults to the standard VM memory setting. + (examples: 83886080, 81920k, or 80m) + No + failonerror indicates whether the build will continue even if there are compilation errors; defaults to true. @@ -267,8 +287,62 @@ This problem may occur with all JDKs < 1.2.

    Note: If you wish to compile only source-files located in some packages below a common root you should not include these packages in the srcdir-attribute. Use include/exclude-attributes or elements to filter for these packages. If you include part of your package-structure inside the srcdir-attribute -(or nested src-elements) Ant will start to recompile your sources everytime you call it.

    +(or nested src-elements) Ant will start to recompile your sources every time you call it.

    + +

    Jikes Notes

    + +If the environment variable JIKES_HOME is set to the location +of the jikes compiler, then the standard Ant invocation scripts +automatically set build.compiler to "jikes". This enables one to use +jikes when available, without having to commit the build file to a +single choice of compiler. +

    + +Jikes also supports some extra options, which can be set be defining +properties prior to invoking the task. The ant developers are aware that +this is ugly and inflexible -expect a better solution in the future. All +the options are boolean, and must be set to "true" or "yes" to be +interpreted as anything other than false; by default +build.compiler.warnings is "true" while all others are "false" + + + + + + + + + + + + + + + + + + +
    + build.compiler.emacs + + Enable emacs compatible error messages +
    + build.compiler.warnings
    + This property has been deprecated, use the nowarn attribute + instead +     		+ don't disable warning messages +
    + build.compiler.pedantic + + enable pedantic warnings +
    + build.compiler.fulldepend + + enable full dependency checking,
    + "+F" in the jikes manual. +

    Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.

    diff --git a/docs/manual/CoreTasks/mail.html b/docs/manual/CoreTasks/mail.html index 61da405b5..43a8add67 100644 --- a/docs/manual/CoreTasks/mail.html +++ b/docs/manual/CoreTasks/mail.html @@ -9,7 +9,10 @@

    Mail

    Description

    -

    A task to send SMTP email.

    +

    A task to send SMTP email. Text and text files to include in the message +body may be specified. To send binary attachments the optional +MimeMail task should be used instead

    +

    Parameters

    diff --git a/docs/manual/CoreTasks/overview.html b/docs/manual/CoreTasks/overview.html index 7d5c113d9..58d5ae536 100644 --- a/docs/manual/CoreTasks/overview.html +++ b/docs/manual/CoreTasks/overview.html @@ -36,7 +36,7 @@ about all tasks currently known to Ant.

    - + @@ -55,6 +55,13 @@ file, a directory, a class in the classpath, or a JVM system resource.

    the argument for the chmod command.

    + + + + + @@ -94,6 +101,13 @@ file, a directory, a class in the classpath, or a JVM system resource.

    + + + + + - - - - - @@ -192,15 +196,21 @@ specified.

    + necessary.

    + a new directory.

    + + + + + @@ -215,13 +225,13 @@ a new directory.

    + resource) in the project.

    + output to a file.

    @@ -232,7 +242,7 @@ output to a file.

    + in selected file.

    @@ -240,6 +250,14 @@ in selected file.

    + + + + + @@ -271,13 +289,13 @@ in selected file.

    + used in the current project.

    + the same time.

    @@ -290,7 +308,7 @@ the same time.

    + new type can be used in the current project.

    @@ -316,7 +334,7 @@ new type can be used in the current project.

    + Source files.

    diff --git a/docs/manual/CoreTasks/parallel.html b/docs/manual/CoreTasks/parallel.html index d4d49b61c..183389c5c 100644 --- a/docs/manual/CoreTasks/parallel.html +++ b/docs/manual/CoreTasks/parallel.html @@ -22,7 +22,7 @@ harness is run in another thread.

    Care must be taken when using multithreading to ensure the tasks within the threads do not interact. For example, two javac compile tasks which write classes into the same destination directory may interact where one tries to -read a class for depenency information while the other task is writing the +read a class for dependency information while the other task is writing the class file. Be sure to avoid these types of interactions within a <parallel> task

    @@ -35,7 +35,7 @@ thread will be blocked waiting for all the child threads to complete.

    If any of the tasks within the <parallel> task fails, the remaining tasks in other threads will continue to run until all threads have completed. -In this sitiuation, the parallel task will also fail.

    +In this situation, the parallel task will also fail.

    The parallel task may be combined with the sequential task to define sequences of tasks to be executed on each thread @@ -55,7 +55,7 @@ within the parallel block

    This example represents a typical pattern for testing a server application. 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 capabale of validating +give the server time to come up. Another task which is capable of validating that the server is available could be used in place of the sleep task. The test harness is then run. Once the tests are complete, the server is stopped (using wlstop in this example), allowing both threads to complete. The diff --git a/docs/manual/CoreTasks/pathconvert.html b/docs/manual/CoreTasks/pathconvert.html new file mode 100644 index 000000000..20e45ca8e --- /dev/null +++ b/docs/manual/CoreTasks/pathconvert.html @@ -0,0 +1,195 @@ + + + + +Ant User Manual + + + + +

    Pathconvert

    +

    Description

    +

    Converts a nested path, path reference, or fileset reference to the form usable on a + specified platform + and stores the result in a given property. This operation is useful when script files + (batch files or shell scripts) must be generated my the build system and they contain + path information that must be properly formatted for the target architecture, not the + architecture on which the build is running, or when you need to create a list of files + separated by a given character, like a comma or a space. +

    +

    Prefix maps can be specified to map Windows drive letters to Unix paths and vice + versa.

    + +

    Parameters

    +
    ApplyApply/ExecOn

    Executes a system command. When the os attribute is specified, then the command is only executed when Ant is run on one of the specified operating systems.
    Condition

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

    Copy

    Copies a file or Fileset to a new file or directory.

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

    The dependset task compares a set of source files with a set of target + files. If any of the source files is more recent than any of + the target files, all of the target files are removed.

    Ear

    An extension of the Jar task with special @@ -112,16 +126,6 @@ the command is only executed when Ant is run on one of the specified operating systems.
    ExecOn

    Executes a system command. When the os attribute is specified, then -the command is only executed when Ant is run on one of the specified operating -systems.

    -

    The files and/or directories of a number of FileSets are passed as arguments to the system -command. At least one nested <fileset> is required.

    Fail

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

    Creates a directory. Also non-existent parent directories are created, when -necessary.
    Move

    Moves a file to a new file or directory, or sets of files to -a new directory.
    Parallel

    Parallel is a container task - it can contain other Ant tasks. Each nested + task within the parallel task will be executed in its own thread.

    Patch

    Applies a diff file to originals.
    Property

    Sets a property (by name and value), or set of properties (from file or -resource) in the project.
    Record

    A recorder is a listener to the current build process that records the -output to a file.
    Replace

    Replace is a directory based task for replacing the occurrence of a given string with another string -in selected file.

    Runs the rmic compiler for a certain class.
    Sequential

    Sequential is a container task - it can contain other 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

    SignJar

    Signs a jar or zip file with the javasign command line tool.
    Taskdef

    Adds a task definition to the current project, such that this new task can be -used in the current project.
    Touch

    Changes the modification time of a file and possibly creates it at -the same time.
    Typedef

    Adds a data type definition to the current project, such that this -new type can be used in the current project.
    Uptodate

    Sets a property if a target files are more up to date than a set of -Source files.
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    targetos + The target architecture. Must be one of 'unix' or 'windows'.
    This is a + shorthand mechanism for specifying both pathsep and dirsep + according to the specified target architecture. +     		+ Must specify one of targetos, pathsep,or dirsep. +
    dirsep + The character to use as the directory separator in the generated paths. + No, defaults to current JVM File.separator
    pathsep + The character to use as the path element separator in the generated paths. + No, defaults to current JVM File.pathSeparator
    propertyThe name of the property in which to place the converted pathYes
    refidWhat to convert, given as a + reference to a PATH or FILESET + defined elsewhereNo, if omitted a nested <path> element must be supplied.
    +

    Parameters specified as nested elements

    +

    map

    +

    Specifies the mapping of path prefixes between Unix and Windows.

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    fromThe prefix to match. Note that this value is case insensitive when + the build is running on a windows platform and case sensitive when running on a + Unix platform.Yes
    toThe replacement text to use when from is matched.Yes
    + +

    Each map element specifies a single replacement map to be applied to the elements of + the path being processed. If no map entries are specified, then no path prefix mapping + is performed. +

    +

    Note that the map elements are applied in the order specified and the 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. +

    +

    path

    +

    If a path reference is not supplied using the refid attribute, then a + nested path element must be supplied. See + Path-like Structures for details.

    + +

    Examples

    +

    In the examples below, assume that the property wl.home has the value +d:\weblogic on Windows and /weblogic on Unix.

    +

    Example 1

    +
    +    <path id="wl.path">
+      <pathelement location="${wl.home}/lib/weblogicaux.jar" />
+      <pathelement location="${wl.home}/classes" />
+      <pathelement location="${wl.home}/mssqlserver4/classes" />
+      <pathelement location="c:\winnt\System32" />
+    </path>
+    
+    <pathconvert targetos="unix" property="newpath" refid="wl.path"/>
+
    +

    Assuming wl.property has the value "d:\weblogic", will generate the path shown below + and store it in the property named newpath +

    +
    +/weblogic/lib/weblogicaux.jar:/weblogic/classes:/weblogic/mssqlserver4/classes:/WINNT/SYSTEM32
+
    +Note that the drive letters have been removed. This is the default behavior when no map +elements have been specified. + +

    Example 2

    +
    +    
+    <pathconvert targetos="unix" property="newpath" >
+      <path id="wl.path">
+        <pathelement location="${wl.home}/lib/weblogicaux.jar" />
+        <pathelement location="${wl.home}/classes" />
+        <pathelement location="${wl.home}/mssqlserver4/classes" />
+        <pathelement location="c:\winnt\System32" />
+      </path>
+    </pathconvert>
+
    +This generates the exact same path as the previous example. It demonstrates the use of +a nested path element. +

    Example 3

    +
    +    <pathconvert targetos="unix" property="newpath" refid="wl.path">
+      <map from="d:" to="/foo"/>
+      <map from="c:" to="/bar"/>
+    </pathconvert>
+
    +

    This example specifies two map entries that will convert path elements that start with +c: to /dos and d: to /. The resulting path is shown +below.

    +
    +/weblogic/lib/weblogicaux.jar:/weblogic/classes:/weblogic/mssqlserver4/classes:/dos/WINNT/SYSTEM32
+
    +

    Example 4

    +
    +    <pathconvert targetos="windows" property="newpath" >
+      <path id="wl.path">
+        <pathelement location="${wl.home}/lib/weblogicaux.jar" />
+        <pathelement location="${wl.home}/classes" />
+        <pathelement location="${wl.home}/mssqlserver4/classes" />
+        <pathelement location="/dos/winnt/System32" />
+      </path>
+      <map from="/dos" to="c:\"/>
+      <map from="/" to="d:\"/>
+    </pathconvert>
+
    +

    This example, similar to the one above but targetting windows, specifies two map +entries that will convert path elements that start with +/dos to c:\ and / to d:\. Note that the order of the +map elements was important here since / is a prefix of /dos. +The resulting path is shown below.

    +
    +d:\weblogic\lib\weblogicaux.jar;d:\weblogic\classes;d:\weblogic\mssqlserver4\classes;c:\WINNT\SYSTEM32
+
    +

    Example 5

    +
    +    <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 +in .java), joins them together separated by commas, and places the resulting +list into the property javafiles. The directory separator is not specified, so +it defaults to the appropriate character for the current platform. Such a list could +then be used in another task, like javadoc, that requires a comma separated +list of files. +

    +
    + + + + + \ No newline at end of file diff --git a/docs/manual/CoreTasks/property.html b/docs/manual/CoreTasks/property.html index 1d45a9df0..a3c53156c 100644 --- a/docs/manual/CoreTasks/property.html +++ b/docs/manual/CoreTasks/property.html @@ -36,6 +36,8 @@ instance.

    The value part of the properties being set, might contain references to other properties. These references are resolved at the time these properties are set. This also holds for properties loaded from a property file.

    +

    A list of predefined properties can be found here.

    Parameters

    @@ -46,12 +48,21 @@ This also holds for properties loaded from a property file.

    - + - + + + + + @@ -62,19 +73,13 @@ This also holds for properties loaded from a property file.

    + - - - - @@ -50,7 +50,7 @@ a buildFinished event. + this file. [Values = {yes|no}, Default=yes] @@ -58,38 +58,38 @@ a buildFinished event.
    name the name of the property to set.YesNo
    value the value of the property.YesOne of these, when using the + name attribute
    locationSets the property to the absolute filename of the + given file. If the value of this attribute is an absolute path, it + is left unchanged (with / and \ characters converted to the + current platforms conventions). Otherwise it is taken as a path + relative to the project's basedir and expanded.
    refid
    resource the resource name of the property file.One of these, when + not using the name attribute
    file the filename of the property file .
    locationSets the property to the absolute filename of the - given file. If the value of this attribute is an absolute path, it - is left unchanged (with / and \ characters converted to the - current platforms conventions). Otherwise it is taken as a path - relative to the project's basedir and expanded.
    environment the prefix to use when retrieving environment variables. Thus diff --git a/docs/manual/CoreTasks/recorder.html b/docs/manual/CoreTasks/recorder.html index 0c45ef235..15c9214e4 100644 --- a/docs/manual/CoreTasks/recorder.html +++ b/docs/manual/CoreTasks/recorder.html @@ -16,11 +16,11 @@ output to a file. associated with a file. The filename is used as a unique identifier for the recorders. The first call to the recorder task with an unused filename will create a recorder (using the parameters provided) and add it to the -listeners of the build. All subsiquent calls to the recorder task using +listeners of the build. All subsequent calls to the recorder task using this filename will modify that recorders state (recording or not) or other properties (like logging level). -

    Some technical issues: the file's print stream is flushed for "finished" +

    Some technical issues: the file's print stream is flushed for "finished" events (buildFinished, targetFinished and taskFinished), and is closed on a buildFinished event. @@ -41,8 +41,8 @@ a buildFinished event.

    		This tells the logger what to do: should it start recording or stop? The first time that the recorder task is called for this logfile, and if this attribute is not provided, then the default - for this attribute is "start". If this attribute is not provided on - subsiquest calls, then the state remains as previous. + for this attribute is "start". If this attribute is not provided on + subsequent calls, then the state remains as previous. [Values = {start|stop}, Default = no state change] no
    append Should the recorder append to a file, or create a new one? This is only applicable the first time this task is called for - this file. [Vaules = {yes|no}, Default=yes] no
    At what logging level should this recorder instance record to? This is not a once only parameter (like append is) -- you can increase or decrease the logging level as the build process - continues. [Vaules= {error|warn|info|verbose|debug}, Default = no change] + continues. [Values= {error|warn|info|verbose|debug}, Default = no change] no

    Examples

    -

    The following build.xml snippit is an example of how to use the recorder +

    The following build.xml snippet is an example of how to use the recorder to record just the <javac> task: 

         ...
     <compile >
-        <record name="log.txt" action="start" />
+        <record name="log.txt" action="start" />
         <javac ...
-        <record name="log.txt" action="stop" />
+        <record name="log.txt" action="stop" />
     <compile/>
     ...

    The following two calls to <record> set up two -recorders: one to file "records-simple.log" at logging level info -(the default) and one to file "ISO.log" using logging level of +recorders: one to file "records-simple.log" at logging level info +(the default) and one to file "ISO.log" using logging level of verbose. 

         ...
-    <record name="records-simple.log" />
-    <record name="ISO.log" loglevel="verbose" />
+    <record name="records-simple.log" />
+    <record name="ISO.log" loglevel="verbose" />
     ...

    Notes

    -

    There is some funtionality that I would like to be able to add in the +

    There is some functionality that I would like to be able to add in the future. They include things like the following: @@ -113,8 +113,8 @@ future. They include things like the following: - @@ -124,10 +124,10 @@ future. They include things like the following: - @@ -137,7 +137,7 @@ future. They include things like the following: - diff --git a/docs/manual/CoreTasks/sleep.html b/docs/manual/CoreTasks/sleep.html index 0835696a4..0d77e3f18 100644 --- a/docs/manual/CoreTasks/sleep.html +++ b/docs/manual/CoreTasks/sleep.html @@ -57,8 +57,8 @@ Sleep for about 10 mS. 
       <sleep seconds="2"/>
    Sleep for about 2 seconds. -
       <sleep minutes="-59" seconds="-58"/>
    -

    Sleep for -one hour less 59:58, or two seconds again

    +
       <sleep hours="1" minutes="-59" seconds="-58"/>
    +

    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.
    diff --git a/docs/manual/CoreTasks/sql.html b/docs/manual/CoreTasks/sql.html index 8e719a26f..889ca2513 100644 --- a/docs/manual/CoreTasks/sql.html +++ b/docs/manual/CoreTasks/sql.html @@ -7,13 +7,21 @@

    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 between the enclosing SQL tags.

    +

    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 semi-colons (or the defined delimiter). Individual lines within the statements can be commented using either --, // or REM at the start of the line.

    +

    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 statements will all be executed as one transaction.

    +

    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 and commit transaction; and abort execution and transaction and fail task.

    @@ -53,7 +61,7 @@ and abort execution and transaction and fail task.

    - + @@ -134,7 +142,9 @@ The /> -

    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

    +

    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
     driver="org.database.jdbcDriver"
@@ -151,7 +161,8 @@ 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 inserting data into some_table and truncating some_other_table

    + user using the org.database.jdbcDriver and executes the two SQL statements + inserting data into some_table and truncating some_other_table

    Note that you may want to enclose your statements in <![CDATA[ ... ]]> sections so you don't @@ -170,7 +181,10 @@ update some_table set column1 = column1 + 1 where column2 < 42; ]]></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 operation on some_other_table.

    +

    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"
@@ -186,7 +200,10 @@ update some_table set column1 = column1 + 1 where column2 < 42;
 </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 as well as the system classpath for the driver class.

    +

    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
     driver="org.database.jdbcDriver"
diff --git a/docs/manual/CoreTasks/style.html b/docs/manual/CoreTasks/style.html
index 606913097..d15444e1d 100644
--- a/docs/manual/CoreTasks/style.html
+++ b/docs/manual/CoreTasks/style.html
@@ -12,6 +12,8 @@
 
    Process a set of documents via XSLT.
    
 
    This is useful for building views of XML based documentation,
 or in generating code.
    
+
    Note: This task depends on external libraries not included in the Ant distribution.
+See Library Dependencies for more information.
    
 
    It is possible to refine the set of files that are being copied. This can be
 done with the includes, includesfile, excludes, excludesfile and defaultexcludes
 attributes. With the includes or includesfile attribute you specify the files you want to
@@ -87,7 +89,10 @@ inclusion/exclusion of files works, and how to write patterns.
    
       XSL:P processor, "xalan" for the Apache XML Xalan (version 1) 
       processor, or the name of an arbitrary XSLTLiaison class. Defaults to trax, 
       followed by xslp then xalan (in that order). The first one found in your 
-      class path is the one that is used.
+      class path is the one that is used.
+      DEPRECATED - XSL:P is deprecated and will be removed
+          in the next version. Use trax or xalan instead..      
+
    diff --git a/docs/manual/CoreTasks/tstamp.html b/docs/manual/CoreTasks/tstamp.html index bb98da671..894d98596 100644 --- a/docs/manual/CoreTasks/tstamp.html +++ b/docs/manual/CoreTasks/tstamp.html @@ -36,7 +36,7 @@ probably in an initialization target. 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. +SimpleDateFormat class. The format element also allows offsets to be applied to the time to generate different time values.

    includetargetA comma-separated list of targets to automaticly - record. If this value is "all", then all targets are recorded. + A comma-separated list of targets to automatically + record. If this value is "all", then all targets are recorded. [Default = all] no
    includetaskA comma-separated list of task to automaticly + A comma-separated list of task to automatically record or not. This could be difficult as it could conflict with the includetarget/excludetarget. (e.g.: - includetarget="compile" exlcudetask="javac", what should + includetarget="compile" exlcudetask="javac", what should happen?) no
    actionadd greater flexability to the action attribute. Things + add greater flexibility to the action attribute. Things like close to close the print stream. no
    delimiter String that separates SQL statementsNo, default ";"No, default ";"
    autocommit No
    @@ -82,7 +82,7 @@ The format element also allows offsets to be applied to the time to generate dif + + + + + diff --git a/docs/manual/CoreTasks/zip.html b/docs/manual/CoreTasks/zip.html index 57ed5975f..315c8624a 100644 --- a/docs/manual/CoreTasks/zip.html +++ b/docs/manual/CoreTasks/zip.html @@ -33,6 +33,11 @@ if basedir is set. You may use any mixture of the implicit file set 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 update parameter controls what happens if the +ZIP file already exists. When set to yes, the ZIP file is +updated with the files specified. (New files are added; old files are +replaced with the new versions.) When set to no (the +default) the ZIP file is overwritten.

    The whenempty parameter controls what happens when no files match. If skip (the default), the ZIP is not created and a warning is issued. If fail, the ZIP is not created and the build is halted with an error. @@ -42,7 +47,7 @@ which should be recognized as such by compliant ZIP manipulation tools.

    for filenames - this is consistent with the command line ZIP tools, but causes problems if you try to open them from within Java and your filenames contain non US-ASCII characters. Use the encoding attribute -and set it to UTF8 to create zip files that can savely be read by +and set it to UTF8 to create zip files that can safely be read by Java.

    Parameters

    locale The locale used to create date/time string. The general - form is "language, country, variant" but either variant or variant and + form is "language, country, variant" but either variant or variant and country may be omitted. For more information please refer to documentation for the Locale diff --git a/docs/manual/CoreTasks/war.html b/docs/manual/CoreTasks/war.html index bb19991e1..cee682286 100644 --- a/docs/manual/CoreTasks/war.html +++ b/docs/manual/CoreTasks/war.html @@ -93,6 +93,12 @@ attributes of zipfilesets in a Zip or Jar task.)

    		the manifest file to use. No
    updateindicates whether to update or overwrite + the destination file if it already exists.No
    whenempty Behavior to use if no files match.
    @@ -109,6 +114,12 @@ Java.

    ("yes"/"no"). Default excludes are used when omitted. + + + + + @@ -136,6 +147,14 @@ for inclusion in the archive.

    />

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

    +
      <zip zipfile="${dist}/manual.zip"
+       basedir="htdocs/manual"
+       update="true"
+  />
    +

    zips all files in the htdocs/manual directory into a file called manual.zip +in the ${dist} directory. If manual.zip +doesn't exist, it is created; otherwise it is updated with the +new/changed files.

      <zip zipfile="${dist}/manual.zip"
        basedir="htdocs/manual"
        excludes="mydocs/**, **/todo.html"
@@ -169,8 +188,6 @@ under docs/examples.  The archive might end up containing the files
     docs/ChangeLog.txt
     docs/examples/index.html
    - -

    Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.

    diff --git a/docs/manual/CoreTypes/filelist.html b/docs/manual/CoreTypes/filelist.html index bb6794933..353e7f580 100644 --- a/docs/manual/CoreTypes/filelist.html +++ b/docs/manual/CoreTypes/filelist.html @@ -34,7 +34,6 @@ same level as target - i.e., as children of -
    No
    updateindicates whether to update or overwrite + the destination file if it already exists.No
    whenempty Behavior when no files match. Comma-separated list of file names. Yes

    Examples

    diff --git a/docs/manual/CoreTypes/filterset.html b/docs/manual/CoreTypes/filterset.html new file mode 100644 index 000000000..2d09cd799 --- /dev/null +++ b/docs/manual/CoreTypes/filterset.html @@ -0,0 +1,118 @@ + + + + + Ant User Manual + + + + + + +

    Filterset

    + +

    FilterSets are groups of filters. Filters can be defined as token value pairs +or be read in from a file. FilterSets can appear inside tasks that support this +feature or at the same level as target - i.e., as children of +project.

    In addition, Filtersets can have begintoken and/or +endtoken attributes to define what to match.
    Filtersets are used for doing +replacements in tasks like copy etc.
    + +

    Filterset

    + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionDefaultRequired
    starttokenThe string marking the beginning of a token. eg + @Date@@No
    endtokenThe string marking the end of a token. eg + @Date@@No
    + +

    Filter

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    tokenThe token to replace eg @Date@Yes
    valueThe value to replace it with eg Thursday, April 26, 2001Yes
    + +

    Filtersfile

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    fileThe file to load tokens from should be a properties file of + name value pairs.Yes
    + +

    Examples

    + +

    You are copying the version.txt file to the dist directory from the build directory +but wish to replace the token @DATE@ with todays date.

    +
    +<copy file="${build.home}/version.txt" toFile="${dist.home}/version.txt"<
+  <filterset>
+    <filter token="DATE" value="${DATE}"/>
+  </filterset>
+</copy>
+
    + +

    You are copying the version.txt file to the dist directory from the build directory +but wish to replace the token %DATE* with todays date.

    +
    +<copy file="${build.home}/version.txt" toFile="${dist.home}/version.txt">
+  <filterset begintoken="%" endtoken="*">
+    <filter token="DATE" value="${DATE}"/>
+  </filterset>
+</copy>
+
    + +

    Copy all the docs but change all dates and appropriate notices as stored in a file.

    +
    +<copy toDir="${dist.home}/docs" >
+  <fileset dir="${build.home}/docs">
+    <include name="**/*.html">
+  </fileset>
+  <filterset begintoken="%" endtoken="*">
+    <filter token="DATE" value="${DATE}"/>
+    <filtersfile file="${user.home}/dist.properties"/>
+  </filterset>
+</copy>
+
    + +
    + +

    Copyright © 2000,2001 Apache Software Foundation. All rights +Reserved.

    diff --git a/docs/manual/CoreTypes/mapper.html b/docs/manual/CoreTypes/mapper.html index aafa38ef4..72f434164 100644 --- a/docs/manual/CoreTypes/mapper.html +++ b/docs/manual/CoreTypes/mapper.html @@ -63,6 +63,10 @@ with the following attributes:

    Depends on implementation. +

    Note that Ant will not automatically convert / or \ characters in +the to and from attributes to the correct +directory separator of your current platform. If you need to specify +this separator, use ${file.separator} instead.

    The classpath can be specified via a nested <classpath>, as well - that is, a path-like structure.

    diff --git a/docs/manual/CoreTypes/patternset.html b/docs/manual/CoreTypes/patternset.html index b575d72a7..44d21732d 100644 --- a/docs/manual/CoreTypes/patternset.html +++ b/docs/manual/CoreTypes/patternset.html @@ -59,7 +59,7 @@ exclude.

    name - the pattern + the pattern to in/exclude. Yes diff --git a/docs/manual/Integration/Antidote.html b/docs/manual/Integration/Antidote.html index 5a73d8271..cce925978 100644 --- a/docs/manual/Integration/Antidote.html +++ b/docs/manual/Integration/Antidote.html @@ -23,7 +23,7 @@ quick generation, modification, and use of Ant build files, helping the user define a build process and track down build problems. It is not meant to be an IDE, but an enabler for the - powerful features available in Ant, particularlyl for novice + powerful features available in Ant, particularly for novice users, or users who want a rapid way of controlling their build process.

    @@ -59,36 +59,25 @@

    Getting Involved

    -

    The source code for Antidote is included with the CVS - version of Ant, - starting in the directory - jakarta-ant/src/antidote. All the existing documentation can +

    The source code for Antidote is located in a separate Module + (jakarta-ant-antidote) in CVS. + All the existing documentation can be found there where new contributors should read:

    -

    Online discussions about Antidote occur on the jakarta-ant mailing list. The application infrastructure is fairly - complete, but there are almost unlimited oppotunities for feature + complete, but there are almost unlimited opportunities for feature contributions. -

    Asipring contributors new to the Jakarta Project should +

    Aspiring contributors new to the Jakarta Project should (carefully) read the following for details on the contribution process:

      @@ -104,7 +93,7 @@
      -

      Copyright © 2000 Apache Software Foundation. All +

      Copyright © 2000,2001 Apache Software Foundation. All rights Reserved.

      diff --git a/docs/manual/Integration/VAJAntTool.html b/docs/manual/Integration/VAJAntTool.html index ea6ecab77..174eee8d6 100644 --- a/docs/manual/Integration/VAJAntTool.html +++ b/docs/manual/Integration/VAJAntTool.html @@ -19,18 +19,20 @@ Version 1.1 - 2001/02/14

      Table of Contents

      • Introduction
        • -
      • The Tasks
        • - +
      • The Tasks + +
      • A sample build file
        • -
      • The Plugin
        • - +
      • The Plugin + +
      • Frequently Asked Questions
      • Visual Age Versions
      • History
        • @@ -114,8 +116,8 @@ These tasks are described in detail below.

        Example

         <vajload>
-    <vajproject name="My Testcases" version="1.7beta" />
-    <vajproject name="JUnit" version="3.2" />
+    <vajproject name="My Testcases" version="1.7beta" />
+    <vajproject name="JUnit" version="3.2" />
 </vajload>
        @@ -125,7 +127,7 @@ These tasks are described in detail below.

        Description:

        Exports Java source files, class files and/or resources from the workspace to the file system. Exports can be specified by giving the VAJ project -name and package name(s). This works very similar to +name and package name(s). This works very similar to FileSets.

        Parameters

        @@ -143,28 +145,28 @@ FileSets.

        exportSources - export source files (default: "yes") + export source files (default: "yes") no exportResources - export resource files (default: "yes") + export resource files (default: "yes") no exportClasses - export class files (default: "no") + export class files (default: "no") no exportDebugInfo include debug info in exported - class files (default: "no") + class files (default: "no") no defaultexcludes - use default excludes when exporting (default: "yes") + use default excludes when exporting (default: "yes") no @@ -212,9 +214,9 @@ specifies the packages to exclude from the export

        Example

        -<vajexport destdir="${src.dir}" exportResources="no">
-    <include name="MyProject/**"/>
-    <exclude name="MyProject/test/**"/>
+<vajexport destdir="${src.dir}" exportResources="no">
+    <include name="MyProject/**"/>
+    <exclude name="MyProject/test/**"/>
 </vajexport>
        This example exports all packages in the VAJ project 'MyProject', except @@ -268,7 +270,7 @@ system into VAJ. These imports can be specified with a fileset.

        Parameters specified as nested elements

        fileset

        -A FileSet specifies the files to import. +A FileSet specifies the files to import.

        Example

        diff --git a/docs/manual/OptionalTasks/BorlandEJBTasks.html b/docs/manual/OptionalTasks/BorlandEJBTasks.html
index 79aaf7e0a..c4723e2cc 100644
--- a/docs/manual/OptionalTasks/BorlandEJBTasks.html
+++ b/docs/manual/OptionalTasks/BorlandEJBTasks.html
@@ -9,10 +9,10 @@
 
 
        BorlandDeployTool
        
 
        Description
        
-
        The BorlandDeployTool is a vendor specifc nested element for the Ejbjar optionaltask.
+
        The BorlandDeployTool is a vendor specific nested element for the Ejbjar optional task.
 
        BorlandDeploymentTool is dedicated to the Borland Application Server 4.5. It 
   generates and compiles the stubs and skeletons for all ejb described into the 
-  Deployement Descriptor, builds the jar file including the support files and 
+  Deployment Descriptor, builds the jar file including the support files and 
   verify whether the produced jar is valid or not.
 
        Borland element
        
 
@@ -55,7 +55,7 @@
     
+      do not, you should use a nested <dtd> element, described above 
@@ -63,7 +63,7 @@
     
+      nested <dtd> element, described above.  
@@ -75,7 +75,7 @@
 
        Deprecated. Defines the location of the 
       weblogic-ejb-jar DTD which covers the Borland specific deployment descriptors. 
       This should not be necessary if you have borland in your classpath. If you 
-      do not, you should use a nested  element, described above
     no
   
        
   
        Deprecated. Defines the location of the 
       ejb-jar DTD in the weblogic class hierarchy. This should not be necessary 
       if you have weblogic in your classpath. If you do not, you should use a 
-      nested  element, described above. 
     no
   
        
   
        
 
 
        Examples
        
-
        The following build.xml snippit is an example of how to use Borland element 
+
        The following build.xml snippet is an example of how to use Borland element 
   into the ejbjar task
 
            <ejbjar srcdir="${build.classes}"  basejarname="vsmp"  descriptordir="${rsc.dir}/hrmanager">
         <borland destdir="lib" verify="on" generateclient="on">
diff --git a/docs/manual/OptionalTasks/BorlandGenerateClient.html b/docs/manual/OptionalTasks/BorlandGenerateClient.html
index cd7a99359..82159d729 100644
--- a/docs/manual/OptionalTasks/BorlandGenerateClient.html
+++ b/docs/manual/OptionalTasks/BorlandGenerateClient.html
@@ -46,7 +46,7 @@
 
 
 
        Examples
        
-
        The following build.xml snippit is an example of how to use Borland element 
+
        The following build.xml snippet is an example of how to use Borland element 
    into the ejbjar task using the java mode.
 
         <blgenclient ejbjar="lib/secutest-ejb.jar" clientjar="lib/client.jar" debug="true" mode="java">
diff --git a/docs/manual/OptionalTasks/ccm.html b/docs/manual/OptionalTasks/ccm.html
index 1425c1940..0b405a783 100644
--- a/docs/manual/OptionalTasks/ccm.html
+++ b/docs/manual/OptionalTasks/ccm.html
@@ -16,12 +16,12 @@
   
      • CCMCreateTask
        •
      -

      These ant tasks are wrapper around Continnus Source Manager. It have been tested - under version 5.1 on Windows 2000.

      +

      These ant tasks are wrappers around Continuus Source Manager. They have been tested + with version 5.1 on Windows 2000, but should work on other platforms with ccm installed.

      CCMCheckin

      Description

      -Task to perform a Checkin command to Continnus +Task to checkin a file

      Parameters

      @@ -36,29 +36,29 @@ Task to perform a Checkin command to Continnus - + - + - + -
      commentSpecify a comment.Specify a comment. Default is "Checkin" plus the date No
      taskSpecify the task number used to checkin the file (may use 'default')Specify the task number used to check in the file (may use 'default') No
      ccmcommandpath to the ccm excutable file. default serach into the PATHpath to the ccm executable file, required if it is not on the PATH No
      +

      Examples

      <ccmcheckin file="c:/wa/com/foo/MyFile.java"
         comment="mycomment" />
      -

      Does a Continnuus checkin on the file c:/wa/com/foo/MyFile.java. +

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

      + used is the one set as the default.

      CCMCheckout

      Description

      @@ -66,45 +66,45 @@ Task to perform a Checkout command to Continuus

      Parameters

      - - - + + + - - - + + + - - - + + + - - + - + - - - + + +
      AttributeValuesRequiredAttributeValuesRequired
      filePath to the file that the command will operate onYesfilePath to the file that the command will operate onYes
      commentSpecify a comment.NocommentSpecify a comment.No
      taskSpecify the task number used to checkin the file (may use + taskSpecify the task number used to checkin the file (may use 'default')NoNo
      ccmcommandpath to the ccm excutable file. default serach into the PATHNoccmcommandpath to the ccm executable file, required if it is not on the PATHNo

      Examples

      - 
      <ccmcheckin file="c:/wa/com/foo/MyFile.java"
+  
      <ccmcheckout file="c:/wa/com/foo/MyFile.java"
         comment="mycomment"/>
      -

      Does a Continnuus checkout on the file c:/wa/com/foo/MyFile.java. +

      Check out the file c:/wa/com/foo/MyFile.java. Comment attribute mycomment is added as a task comment - The used task is the one set as the fault.

      + The used task is the one set as the default.

      CCMCheckinTask

      Description

      -Task to perform a check in default task command to Continnuus +Task to perform a check in default task command to Continuus

      Parameters

      @@ -119,12 +119,12 @@ Task to perform a check in default task command to Continnuus - + - +
      taskSpecify the task number used to checkin the file (may use 'default')Specify the task number used to check in the file (may use 'default') No
      ccmcommandpath to the ccm excutable file. default serach into the PATHpath to the ccm executable file, required if it is not on the PATH No
      @@ -133,7 +133,7 @@ Task to perform a check in default task command to Continnuus 
      <ccmcheckintask comment="blahblah/>
      -

      Does a Checkin default task on all the checkou-ed filed in the current task.

      +

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

      CCMReconfigure

      Description

      @@ -162,22 +162,22 @@ Task to perform an reconfigure command to Continuus. ccmcommand - path to the ccm excutable file. default serach into the PATH + path to the ccm executable file, required if it is not on the PATH No

      Examples

      - 
      <ccmreconfigure ccmproject="ANTCCM_TEST#BMO_1" verbose="true" />
-
+ 
      <ccmreconfigure ccmproject="ANTCCM_TEST#BMO_1" 
+         verbose="true" />
      -

      Does a Continuus reconfiguree on the project ANTCCM_TEST#BMO_1. +

      Does a Continuus reconfigure on the project ANTCCM_TEST#BMO_1.

      CCMCreateTask

      Description

      -Task to perform an create task command to Continuus. +Create a Continuus task.

      Parameters

      @@ -197,7 +197,7 @@ Task to perform an create task command to Continuus. - + @@ -223,12 +223,12 @@ Task to perform an create task command to Continuus.
      ccmcommandpath to the ccm excutable file. default serach into the PATHpath to the ccm executable file, required if it is not on the PATH No

      Examples

      - 
      <ccmcreatetask resolver="{user.name}" release="ANTCCM_TEST" comment="blahblah" />
+  
      <ccmcreatetask resolver="${user.name}" 
+            release="ANTCCM_TEST" comment="blahblah" />
      -

      Does a Continuus create task for the release ANTCCM_TEST to the - current logged person as the resolver for this task.

      -

       

      +

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

      diff --git a/docs/manual/OptionalTasks/depend.html b/docs/manual/OptionalTasks/depend.html index d8d4293e1..1e6547d1e 100644 --- a/docs/manual/OptionalTasks/depend.html +++ b/docs/manual/OptionalTasks/depend.html @@ -54,41 +54,30 @@ 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 +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 +compile your code.

      +

      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 following tests have been run when build Ant itself, on the -author's machine using JDK1.3

      - - - - - - - - - - - - - - - - - - -
      Building Ant from clean using Javac11 seconds
      Building Ant from clean using Jikes5 seconds
      Running <depend> when up-to-date and no cache4 seconds (Depend takes 2 seconds)
      Running <depend> when up-to-date and with a cache2 seconds (Depend takes 1 seconds)
      - -

      This involves compiling 177 files. The above figures are indicative only. -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.

      +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 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, @@ -112,8 +101,8 @@ your classes are.

        srcDir This is the directory where the source exists. depend -will examine this to determine which classes. If you use multiple -source directories you can pass this a path of source directories. +will examine this to determine which classes are out of date. If you use multiple +source directories you can pass this attribute a path of source directories. Yes @@ -137,14 +126,31 @@ depend will traverse the class dependency graph deleting all affected classes. Defaults to false No + + dump + If true the dependency information will be written to the debug level log + + No + + + classpath + The classpath containg jars and classes for which <depend> should also + check dependencies + No + +

        Nested Elements

        +

        depend's classpath attribute is a +PATH like structure and can also be set +via a nested classpath element.

        +

        Examples

        - 
            <depend srcdir="${java.dir}"
-    destdir="${build.classes}"
-    cache="depcache"
-    closure="yes"/>
        +
        <depend srcdir="${java.dir}"
+        destdir="${build.classes}"
+        cache="depcache"
+        closure="yes"/>

        In this example classes in the ${build.classes} directory will be removed if diff --git a/docs/manual/OptionalTasks/ftp.html b/docs/manual/OptionalTasks/ftp.html index 3108ab887..cd161b2fc 100644 --- a/docs/manual/OptionalTasks/ftp.html +++ b/docs/manual/OptionalTasks/ftp.html @@ -9,11 +9,11 @@

        FTP

        Description

        -

        Note: The ftp-task uses the NetComponents-Package which you will need to download from -http://www.savarese.org and add to your classpath.

        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 to perform each task.

        +

        Note: This task depends on external libraries not included in the Ant distribution. +See Library Dependencies for more information.

        The ftp task makes no attempt to determine what file system syntax is required by the remote server, and defaults to Unix standards. remotedir must be specified in the exact syntax required by the ftp diff --git a/docs/manual/OptionalTasks/icontract.html b/docs/manual/OptionalTasks/icontract.html index 3d54c937b..f57fe52de 100644 --- a/docs/manual/OptionalTasks/icontract.html +++ b/docs/manual/OptionalTasks/icontract.html @@ -16,8 +16,7 @@ Instruments Java classes with i The task can generate a properties file for iControl, a graphical user interface that lets you turn on/off assertions. iControl generates a control file that you can refer to from this task using the controlfile attribute. -

        -  +

        Parameters

        @@ -133,13 +132,13 @@ Instruments Java classes with i

        Example:

        -

        +

        Note: iContract will use the java compiler indicated by the project's build.compiler property. See documentation of the Javac task for - more information. -

        + more information.

        +

        Nested includes and excludes can be done very much the same way as any subclass - of MatchingTask. + of MatchingTask.

        Example:

        diff --git a/docs/manual/OptionalTasks/jdepend.html b/docs/manual/OptionalTasks/jdepend.html index 55a3a35d2..a8b190256 100644 --- a/docs/manual/OptionalTasks/jdepend.html +++ b/docs/manual/OptionalTasks/jdepend.html @@ -1,30 +1,27 @@ + + JDepend Task - JDepend Task + -

        -JDepend

        +

        JDepend

        + +

        Description

        -

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

        -

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

        +

        Source file directories are defined by nested <sourcespath>, see nested elements.

        -

        Source file directories are defined by nested <sourcespath>, see 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. -

        +

        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.

        @@ -32,88 +29,59 @@ Optionally, you can also set the outputfile name where the output i

        -

        -Parameters

        - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

        Parameters

        + +
        AttributeDescriptionRequired
        outputfileThe output file name. If not set, the output is printed on the standard output.No
        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"
        timeoutCancel 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"
        dirThe directory to invoke the VM in. (Ignored if fork is disabled)No
        classpathrefthe classpath to use, given as reference to a PATH defined elsewhere.No
        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeDescriptionRequired
        outputfileThe output file name. If not set, the output is printed on the standard output.No
        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"
        timeoutCancel 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"
        dirThe directory to invoke the VM in. (Ignored if fork is disabled)No
        classpathrefthe classpath to use, given as reference to a PATH defined elsewhere.No
        -

        Nested Elements

        +

        jdepend supports two nested elements <classpath> and <sourcespath>, +that represent PATH like structures.

        -

        jdepend supports two nested elements <classpath> and <sourcespath>, that represent PATH like -structures. - -
        <sourcespath> is used to define the paths of the source code to analyze.
        -

        +

        <sourcespath> is used to define the paths of the source code to analyze.

        -

        -Examples

        +

        Examples

        @@ -127,6 +95,7 @@ Examples
 
 This invokes JDepend on the src directory, writing the output on the standard output.
 The classpath is defined using a classpath reference.
+
 
        
 
         <jdepend outputfile="docs/jdepend.txt" fork="yes">
@@ -143,8 +112,10 @@ The classpath is defined using a classpath reference.
 
 This invokes JDepend in a separate VM on the src and testsrc directories, writing the output in the <docs/jdepend.txt> file.
 The classpath is defined using nested elements. 
-
        
+
 
        
 
 
 
+
+
diff --git a/docs/manual/OptionalTasks/junitreport.html b/docs/manual/OptionalTasks/junitreport.html
index 696836ec0..fa2f3642e 100644
--- a/docs/manual/OptionalTasks/junitreport.html
+++ b/docs/manual/OptionalTasks/junitreport.html
@@ -14,7 +14,10 @@ the testcases results.
 or Xalan 1.2.2.
 
        
 Note:For a framed format Xalan 1.2.2 will need Xerces(xerces.jar) as well as BSF(bsf.jar)
-that can be found in the distribution archive.
+that can be found in the distribution archive. Xerces will need to be before any other
+parser (such as the shipped crimson). It is *highly* recommended to use Xalan2 instead
+because Xalan1 is no more supported.
+
 
        Parameters
        
 
diff --git a/docs/manual/OptionalTasks/script.html b/docs/manual/OptionalTasks/script.html
index fdb8a2602..9aec649f3 100644
--- a/docs/manual/OptionalTasks/script.html
+++ b/docs/manual/OptionalTasks/script.html
@@ -11,6 +11,8 @@
 
        Description
        Execute a script in a 
   BSF supported language.
        
+
        Note: This task depends on external libraries not included in the Ant distribution.
+See Library Dependencies for more information.
        All items (tasks, targets, etc) of the running project are
 accessible from the script, using either their name or
 id attributes.
        
diff --git a/docs/manual/OptionalTasks/stylebook.html b/docs/manual/OptionalTasks/stylebook.html
index e1d39f23c..e52056cdb 100644
--- a/docs/manual/OptionalTasks/stylebook.html
+++ b/docs/manual/OptionalTasks/stylebook.html
@@ -12,6 +12,8 @@
 
        This executes the apache Stylebook documentation generator. 
 Unlike the commandline version of this tool, all three arguments
 are required to run stylebook.
        
+
        Note: This task depends on external libraries not included in the Ant distribution.
+See Library Dependencies for more information.
        Parameters
        
   
        
 
 
 
 
 
        
diff --git a/docs/manual/coretasklist.html b/docs/manual/coretasklist.html
index 14e5bd93c..e8ba44ba8 100644
--- a/docs/manual/coretasklist.html
+++ b/docs/manual/coretasklist.html
@@ -15,6 +15,7 @@
 build.sysclasspath
        Patternset
        Fileset
        
+Filterset
        File Mappers
        Common Attributes
        
 
diff --git a/docs/manual/install.html b/docs/manual/install.html
index b060aa3d5..94f2d57f0 100644
--- a/docs/manual/install.html
+++ b/docs/manual/install.html
@@ -8,18 +8,18 @@
 
        Installing Ant
        Getting Ant
        
-
        Binary edition
        
+
        Binary Edition
        The latest stable version of Ant can be downloaded from 
-http://jakarta.apache.org/builds/ant/release/v1.3/bin/.
+href="http://jakarta.apache.org/builds/ant/release/v1.4/bin/">
+http://jakarta.apache.org/builds/ant/release/v1.4/bin/.
 
 If you like living on the edge, you can download the latest version from http://jakarta.apache.org/builds/ant/nightly/.
        Source Edition
        If you prefer the source edition, you can download the source for the latest Ant release from 
-http://jakarta.apache.org/builds/ant/release/v1.3/src/. 
+href="http://jakarta.apache.org/builds/ant/release/v1.4/src/">
+http://jakarta.apache.org/builds/ant/release/v1.4/src/. 
 
 Again, if you prefer the edge, you can access 
 the code as it is being developed via CVS. The Jakarta website has details on 
@@ -38,10 +38,11 @@ Ant CVS repository on-line. 
        
 To build and use Ant, you must have a JAXP-compliant XML parser installed and 
 available on your classpath.
        
-The binary distribution of Ant includes the reference 
-implementation of JAXP 1.1. Please see 
+The binary distribution of Ant includes the latest version of the 
+Apache Crimson XML parser. 
+Please see 
 http://java.sun.com/xml/ 
-for more information. 
+for more information about JAXP. 
 If you wish to use a different JAXP-compliant parser, you should remove
 jaxp.jar and crimson.jar
 from Ant's lib directory.
@@ -105,12 +106,12 @@ directory of the JDK/JRE. Ant is an application, whilst the extension
 directory is intended for JDK extensions. In particular there are security 
 restrictions on the classes which may be loaded by an extension.
        
 
-
        Optional Tasks
        
+
        Optional Tasks
        Ant supports a number of optional tasks. An optional task is a task which
 typically requires an external library to function. The optional tasks are 
 packaged separately from the core Ant tasks. This package is available in 
 the same download directory as the core ant distribution. The current 
-jar containing optional tasks is named jakarta-ant-1.3-optional.jar.
+jar containing optional tasks is named jakarta-ant-1.4-optional.jar.
 This jar should be downloaded and placed in the lib directory of your Ant 
 installation.
         
 
@@ -233,8 +234,8 @@ install directory's lib directory if you are using the
 indicated feature. Note that only one of the regexp libraries is
 needed for use with the mappers. You will also need to install the
 Ant optional jar containing the task definitions to make these
-tasks available. Please refer to the 
-Installing Ant section above.
        
+tasks available. Please refer to the 
+Installing Ant / Optional Tasks section above.
        
 
 
 
 
 
 
 
 
 
 
 
 
 
 
        
diff --git a/docs/manual/resources.html b/docs/manual/resources.html
deleted file mode 100644
index 593bf3afb..000000000
--- a/docs/manual/resources.html
+++ /dev/null
@@ -1,42 +0,0 @@
-
-
-
-
-Ant User Manual
-
-
-
-
        Ant Resources
        
-
-
        FAQ
        
-
        There is an on-line FAQ for Ant at jakarta.apache.org.
        
-
-
        External Resources
        
-
-
        There is a powerpoint presentation by Patrick Chanezon (chanezon@netscape.com)
-here: 
-http://people.netscape.com/chanezon/tech/ant/ant_preso.ppt
        
-
-
        Another pres by Steve Loughran (steve_l@iseran.com)
-http://www.iseran.com/Steve/modern_development_processes.html.
        
-
-
        and some articles to get ideas from here:
-http://www-106.ibm.com/developerworks/library/j-ant/?dwzone=java
-http://www.javaworld.com/javaworld/jw-10-2000/jw-1020-ant.html
-http://jakarta.apache.org/commons/cactus/ant.html
        
-
-
        Here's another Ant presentation, made at the St. Louis Java Users
-Group meeting in March (PowerPoint):
-http://www.ociweb.com/javasig/knowledgebase/March2001/index.html
        
-
-
        An article about developing tasks with VAJ by Glenn McAllister can
-be found at http://www7.software.ibm.com/vad.nsf/data/document2366?OpenDocument&p=1&BCT=1&Footer=1
        
-
-
        
-
        Copyright © 2000,2001 Apache Software Foundation. All rights
-Reserved.
        
-
-
-
-
diff --git a/docs/manual/toc.html b/docs/manual/toc.html
index f3ac39695..697d0c081 100644
--- a/docs/manual/toc.html
+++ b/docs/manual/toc.html
@@ -18,7 +18,6 @@
 Editor/IDE Integration
        Developing with Ant
        Ant API
        
-Ant Resources
        License
        Feedback

        Authors
        
diff --git a/docs/manual/using.html b/docs/manual/using.html
index 7c635ae74..12abd42d5 100644
--- a/docs/manual/using.html
+++ b/docs/manual/using.html
@@ -200,7 +200,7 @@ if there is a "builddir" property with the value
 ${builddir}/classes.
 This is resolved as build/classes.
        
 
-
        Built-in Properties
        
+
        Built-in Properties
        Ant provides access to all system properties as if they had been
 defined using a <property> task.
 For example, ${os.name} expands to the
@@ -216,7 +216,7 @@ ant.version         the version of Ant
 ant.project.name    the name of the project that is currently executing;
                     it is set in the name attribute of <project>.
 ant.java.version    the JVM version Ant detected; currently it can hold
-                    the values "1.1", "1.2" and "1.3".
+                    the values "1.1", "1.2", "1.3" and "1.4".
 
 
 
        Example
        
@@ -307,7 +307,7 @@ supports path and
       <pathelement path="${classpath}"/>
     </classpath>
 
-
        can be abreviated to:
        
+
        can be abbreviated to:
             <classpath path="${classpath}"/>