nico 01/08/28 14:50:54 Modified: docs/manual Tag: ANT_14_BRANCH install.html using.html docs/manual/CoreTasks Tag: ANT_14_BRANCH antcall.html available.html dependset.html ear.html fixcrlf.html javac.html overview.html parallel.html recorder.html sql.html style.html tstamp.html zip.html docs/manual/CoreTypes Tag: ANT_14_BRANCH filelist.html filterset.html patternset.html docs/manual/Integration Tag: ANT_14_BRANCH Antidote.html VAJAntTool.html docs/manual/OptionalTasks Tag: ANT_14_BRANCH BorlandEJBTasks.html BorlandGenerateClient.html ccm.html ftp.html icontract.html jdepend.html script.html stylebook.html Log: - Cleaned up HTML - Fixed some typos - Make references to install -> dependencies instead of having links all over the place - Verified links and corrected them if possible - Added new task to overview Revision Changes Path No revision No revision 1.10.2.3 +4 -4 jakarta-ant/docs/manual/install.html Index: install.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/install.html,v retrieving revision 1.10.2.2 retrieving revision 1.10.2.3 diff -u -r1.10.2.2 -r1.10.2.3 --- install.html 2001/08/17 10:38:11 1.10.2.2 +++ install.html 2001/08/28 21:50:53 1.10.2.3 @@ -8,7 +8,7 @@

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.4/bin/. @@ -106,7 +106,7 @@ 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 @@ -234,8 +234,8 @@ 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.

1.7.2.2 +2 -2 jakarta-ant/docs/manual/using.html Index: using.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/using.html,v retrieving revision 1.7.2.1 retrieving revision 1.7.2.2 diff -u -r1.7.2.1 -r1.7.2.2 --- using.html 2001/08/09 15:09:56 1.7.2.1 +++ using.html 2001/08/28 21:50:53 1.7.2.2 @@ -216,7 +216,7 @@ 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 @@ <pathelement path="${classpath}"/> </classpath> -

can be abreviated to:

+

can be abbreviated to:

       <classpath path="${classpath}"/>
No revision No revision 1.4.2.1 +4 -4 jakarta-ant/docs/manual/CoreTasks/antcall.html Index: antcall.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/antcall.html,v retrieving revision 1.4 retrieving revision 1.4.2.1 diff -u -r1.4 -r1.4.2.1 --- antcall.html 2001/08/08 12:09:08 1.4 +++ antcall.html 2001/08/28 21:50:53 1.4.2.1 @@ -24,10 +24,10 @@

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

1.4.2.2 +3 -1 jakarta-ant/docs/manual/CoreTasks/available.html Index: available.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/available.html,v retrieving revision 1.4.2.1 retrieving revision 1.4.2.2 diff -u -r1.4.2.1 -r1.4.2.2 --- available.html 2001/08/24 13:25:29 1.4.2.1 +++ available.html 2001/08/28 21:50:53 1.4.2.2 @@ -63,7 +63,9 @@ - + 1.1.2.1 +2 -2 jakarta-ant/docs/manual/CoreTasks/dependset.html Index: dependset.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/dependset.html,v retrieving revision 1.1 retrieving revision 1.1.2.1 diff -u -r1.1 -r1.1.2.1 --- dependset.html 2001/08/06 14:32:45 1.1 +++ dependset.html 2001/08/28 21:50:53 1.1.2.1 @@ -110,12 +110,12 @@

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 1.4.2.2 +2 -2 jakarta-ant/docs/manual/CoreTasks/ear.html Index: ear.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/ear.html,v retrieving revision 1.4.2.1 retrieving revision 1.4.2.2 diff -u -r1.4.2.1 -r1.4.2.2 --- ear.html 2001/08/22 17:51:36 1.4.2.1 +++ ear.html 2001/08/28 21:50:53 1.4.2.2 @@ -112,8 +112,8 @@ 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>
1.4.2.1 +4 -5 jakarta-ant/docs/manual/CoreTasks/fixcrlf.html Index: fixcrlf.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/fixcrlf.html,v retrieving revision 1.4 retrieving revision 1.4.2.1 diff -u -r1.4 -r1.4.2.1 --- fixcrlf.html 2001/08/06 15:10:41 1.4 +++ fixcrlf.html 2001/08/28 21:50:53 1.4.2.1 @@ -102,9 +102,9 @@
  • 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 @@ 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 @@

    - - + @@ -56,6 +56,13 @@ + + + + + @@ -95,6 +102,13 @@ + + + + + @@ -113,16 +127,6 @@ - - - - - @@ -192,16 +196,22 @@ + necessary.

    + a new directory.

    + + + + + @@ -215,13 +225,13 @@ + resource) in the project.

    + output to a file.

    @@ -232,7 +242,7 @@ + in selected file.

    @@ -241,6 +251,14 @@ + + + + + @@ -271,13 +289,13 @@ + used in the current project.

    + the same time.

    @@ -290,7 +308,7 @@ + new type can be used in the current project.

    @@ -316,7 +334,7 @@ + Source files.

    1.2.2.1 +3 -3 jakarta-ant/docs/manual/CoreTasks/parallel.html Index: parallel.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/parallel.html,v retrieving revision 1.2 retrieving revision 1.2.2.1 diff -u -r1.2 -r1.2.2.1 --- parallel.html 2001/08/09 11:03:39 1.2 +++ parallel.html 2001/08/28 21:50:53 1.2.2.1 @@ -22,7 +22,7 @@

    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 @@

    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 @@

    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 1.2.2.1 +19 -19 jakarta-ant/docs/manual/CoreTasks/recorder.html Index: recorder.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/recorder.html,v retrieving revision 1.2 retrieving revision 1.2.2.1 diff -u -r1.2 -r1.2.2.1 --- recorder.html 2001/04/12 06:03:39 1.2 +++ recorder.html 2001/08/28 21:50:53 1.2.2.1 @@ -16,11 +16,11 @@ 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 @@

    @@ -50,7 +50,7 @@ + this file. [Values = {yes|no}, Default=yes] @@ -58,38 +58,38 @@
    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
    No
    tab Specifies how tab characters are to be handled. Valid values for this property are: 1.10.2.5 +5 -5 jakarta-ant/docs/manual/CoreTasks/javac.html Index: javac.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/javac.html,v retrieving revision 1.10.2.4 retrieving revision 1.10.2.5 diff -u -r1.10.2.4 -r1.10.2.5 --- javac.html 2001/08/27 12:34:54 1.10.2.4 +++ javac.html 2001/08/28 21:50:53 1.10.2.5 @@ -287,13 +287,13 @@

    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 +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. @@ -302,9 +302,9 @@ 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 +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.warnings is "true" while all others are "false" @@ -339,7 +339,7 @@
    enable full dependency checking,
    - "+F" in the jikes manual. + "+F" in the jikes manual.
    1.1.2.1 +38 -20 jakarta-ant/docs/manual/CoreTasks/overview.html Index: overview.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/overview.html,v retrieving revision 1.1 retrieving revision 1.1.2.1 diff -u -r1.1 -r1.1.2.1 --- overview.html 2001/07/08 20:30:59 1.1 +++ overview.html 2001/08/28 21:50:53 1.1.2.1 @@ -36,7 +36,7 @@
    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.
    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 treatment for files that should end up in an Enterprise Application archive.

    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.
    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.
    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 @@ - @@ -124,10 +124,10 @@ - @@ -137,7 +137,7 @@ - 1.4.2.1 +28 -11 jakarta-ant/docs/manual/CoreTasks/sql.html Index: sql.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/sql.html,v retrieving revision 1.4 retrieving revision 1.4.2.1 diff -u -r1.4 -r1.4.2.1 --- sql.html 2001/05/17 10:41:08 1.4 +++ sql.html 2001/08/28 21:50:53 1.4.2.1 @@ -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 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.

    -

    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.

    - -

    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 @@ - + @@ -134,7 +142,9 @@ /> -

    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 @@

    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 @@ ]]></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 @@
   </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"
  
  
  
  1.8.2.2   +2 -0      jakarta-ant/docs/manual/CoreTasks/style.html
  
  Index: style.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/style.html,v
  retrieving revision 1.8.2.1
  retrieving revision 1.8.2.2
  diff -u -r1.8.2.1 -r1.8.2.2
  --- style.html	2001/08/21 20:25:22	1.8.2.1
  +++ style.html	2001/08/28 21:50:53	1.8.2.2
  @@ -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
  
  
  
  1.6.2.1   +2 -2      jakarta-ant/docs/manual/CoreTasks/tstamp.html
  
  Index: tstamp.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/tstamp.html,v
  retrieving revision 1.6
  retrieving revision 1.6.2.1
  diff -u -r1.6 -r1.6.2.1
  --- tstamp.html	2001/08/01 11:22:18	1.6
  +++ tstamp.html	2001/08/28 21:50:53	1.6.2.1
  @@ -36,7 +36,7 @@
   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
    @@ -82,7 +82,7 @@ - No revision No revision 1.3.2.1 +12 -23 jakarta-ant/docs/manual/Integration/Antidote.html Index: Antidote.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/Integration/Antidote.html,v retrieving revision 1.3 retrieving revision 1.3.2.1 diff -u -r1.3 -r1.3.2.1 --- Antidote.html 2001/02/13 13:38:53 1.3 +++ Antidote.html 2001/08/28 21:50:53 1.3.2.1 @@ -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:

    - + - + - + + class files (default: "no") - @@ -212,9 +214,9 @@

    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 @@

    Parameters specified as nested elements

    fileset

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

    Example

      
  
  
  No                   revision
  
  
  No                   revision
  
  
  1.1.2.1   +5 -5      jakarta-ant/docs/manual/OptionalTasks/BorlandEJBTasks.html
  
  Index: BorlandEJBTasks.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/BorlandEJBTasks.html,v
  retrieving revision 1.1
  retrieving revision 1.1.2.1
  diff -u -r1.1 -r1.1.2.1
  --- BorlandEJBTasks.html	2001/04/07 03:51:30	1.1
  +++ BorlandEJBTasks.html	2001/08/28 21:50:54	1.1.2.1
  @@ -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
    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 1.4.2.2 +1 -1 jakarta-ant/docs/manual/CoreTasks/zip.html Index: zip.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/zip.html,v retrieving revision 1.4.2.1 retrieving revision 1.4.2.2 diff -u -r1.4.2.1 -r1.4.2.2 --- zip.html 2001/08/22 17:51:36 1.4.2.1 +++ zip.html 2001/08/28 21:50:53 1.4.2.2 @@ -47,7 +47,7 @@ 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

    No revision No revision 1.1.2.1 +0 -1 jakarta-ant/docs/manual/CoreTypes/filelist.html Index: filelist.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTypes/filelist.html,v retrieving revision 1.1 retrieving revision 1.1.2.1 diff -u -r1.1 -r1.1.2.1 --- filelist.html 2001/08/06 14:32:46 1.1 +++ filelist.html 2001/08/28 21:50:53 1.1.2.1 @@ -34,7 +34,6 @@ -
    Comma-separated list of file names. Yes

    Examples

    1.1.2.2 +118 -96 jakarta-ant/docs/manual/CoreTypes/Attic/filterset.html Index: filterset.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTypes/Attic/filterset.html,v retrieving revision 1.1.2.1 retrieving revision 1.1.2.2 diff -u -r1.1.2.1 -r1.1.2.2 --- filterset.html 2001/08/17 11:39:15 1.1.2.1 +++ filterset.html 2001/08/28 21:50:53 1.1.2.2 @@ -1,96 +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.

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

    1.4.2.1 +1 -1 jakarta-ant/docs/manual/CoreTypes/patternset.html Index: patternset.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTypes/patternset.html,v retrieving revision 1.4 retrieving revision 1.4.2.1 diff -u -r1.4 -r1.4.2.1 --- patternset.html 2001/08/01 09:23:47 1.4 +++ patternset.html 2001/08/28 21:50:53 1.4.2.1 @@ -59,7 +59,7 @@
    namethe pattern + the pattern to in/exclude. Yes
    exportSourcesexport source files (default: "yes")export source files (default: "yes") no
    exportResourcesexport resource files (default: "yes")export resource files (default: "yes") no
    exportClassesexport class files (default: "no")export class files (default: "no") no
    exportDebugInfo include debug info in exported - class files (default: "no") no
    defaultexcludes use default excludes when exporting (default: "yes") + use default excludes when exporting (default: "yes") no
    @@ -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">
  
  
  
  1.2.2.1   +1 -1      jakarta-ant/docs/manual/OptionalTasks/BorlandGenerateClient.html
  
  Index: BorlandGenerateClient.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/BorlandGenerateClient.html,v
  retrieving revision 1.2
  retrieving revision 1.2.2.1
  diff -u -r1.2 -r1.2.2.1
  --- BorlandGenerateClient.html	2001/04/19 14:02:15	1.2
  +++ BorlandGenerateClient.html	2001/08/28 21:50:54	1.2.2.1
  @@ -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">
  
  
  
  1.1.2.2   +1 -1      jakarta-ant/docs/manual/OptionalTasks/ccm.html
  
  Index: ccm.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/ccm.html,v
  retrieving revision 1.1.2.1
  retrieving revision 1.1.2.2
  diff -u -r1.1.2.1 -r1.1.2.2
  --- ccm.html	2001/08/19 09:28:41	1.1.2.1
  +++ ccm.html	2001/08/28 21:50:54	1.1.2.2
  @@ -36,7 +36,7 @@
     
      
       comment
  -    Specify a comment. Default is "Checkin" plus the date
  +    Specify a comment. Default is "Checkin" plus the date
       No
     
      
  
  
  
  1.4.2.1   +2 -2      jakarta-ant/docs/manual/OptionalTasks/ftp.html
  
  Index: ftp.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/ftp.html,v
  retrieving revision 1.4
  retrieving revision 1.4.2.1
  diff -u -r1.4 -r1.4.2.1
  --- ftp.html	2001/07/30 06:21:17	1.4
  +++ ftp.html	2001/08/28 21:50:54	1.4.2.1
  @@ -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
  
  
  
  1.4.2.1   +5 -6      jakarta-ant/docs/manual/OptionalTasks/icontract.html
  
  Index: icontract.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/icontract.html,v
  retrieving revision 1.4
  retrieving revision 1.4.2.1
  diff -u -r1.4 -r1.4.2.1
  --- icontract.html	2001/04/10 05:06:46	1.4
  +++ icontract.html	2001/08/28 21:50:54	1.4.2.1
  @@ -16,8 +16,7 @@
    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 @@
   
    
    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:
    
   
  
  
  
  1.1.2.1   +121 -150  jakarta-ant/docs/manual/OptionalTasks/jdepend.html
  
  Index: jdepend.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/jdepend.html,v
  retrieving revision 1.1
  retrieving revision 1.1.2.1
  diff -u -r1.1 -r1.1.2.1
  --- jdepend.html	2001/06/01 04:43:02	1.1
  +++ jdepend.html	2001/08/28 21:50:54	1.1.2.1
  @@ -1,150 +1,121 @@
  -
  -
  -
  -   
  -   
  -   JDepend Task
  -
  -
  -
  -
    
  -JDepend
    
  -
  -
    
  -Description
    
  -
  -
    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."
  -
    
  -
  -
    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.
  -
    
  -
  -
     The task requires at least the JDepend 1.2 version. 
    	
  -
  -
    Note: whereas the JDepend tool can be customized to exclude some packages, the current jdepend And Task does not have parameters to allow these exclusions. Read JDepend specific documentation for that purpose.
    
  -
  -
    
  -
  -
    
  -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
    
  -
  -
  -
    Nested Elements
    
  -
  -
  -
    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.
    
  -
     
  -
  -
    
  -Examples
    
  -
  -
    
  -
      -<jdepend classpathref="base.path">
  -    <sourcespath>
  -        <pathelement location="src" />
  -    </sourcespath>
  -</jdepend>
  -
    
  -
    
  -
  -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">
  -    <sourcespath>
  -        <pathelement location="src" />
  -    </sourcespath>
  -    <classpath>
  -        <pathelement location="classes" />
  -        <pathelement location="lib/jdepend.jar" />
  -    </classpath>
  -</jdepend>
  -
    
  -
      
  -
  -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. 
  -
    
  -
    
  -
  -
  -
  +
  +
  +
  +
  +   JDepend Task
  +   
  +   
  +
  +
  +
  +
  +
    JDepend
    
  +
  +
    Description
    
  +
  +
    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."
    
  +
  +
    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.
    
  +
  +
     The task requires at least the JDepend 1.2 version. 
    	
  +
  +
    Note: whereas the JDepend tool can be customized to exclude some packages, the current jdepend And Task does not have parameters to allow these exclusions. Read JDepend specific documentation for that purpose.
    
  +
  +
    
  +
  +
    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
    
  +
  +
    Nested Elements
    
  +
  +
    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.
    
  +
  +
    Examples
    
  +
  +
    
  +
      +<jdepend classpathref="base.path">
  +    <sourcespath>
  +        <pathelement location="src" />
  +    </sourcespath>
  +</jdepend>
  +
    
  +
    
  +
  +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">
  +    <sourcespath>
  +        <pathelement location="src" />
  +    </sourcespath>
  +    <classpath>
  +        <pathelement location="classes" />
  +        <pathelement location="lib/jdepend.jar" />
  +    </classpath>
  +</jdepend>
  +
    
  +
      
  +
  +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. 
  +
  +
    
  +
  +
  +
  +
  +
  
  
  
  1.2.2.1   +2 -0      jakarta-ant/docs/manual/OptionalTasks/script.html
  
  Index: script.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/script.html,v
  retrieving revision 1.2
  retrieving revision 1.2.2.1
  diff -u -r1.2 -r1.2.2.1
  --- script.html	2001/02/13 12:31:56	1.2
  +++ script.html	2001/08/28 21:50:54	1.2.2.1
  @@ -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.
    
  
  
  
  1.2.2.1   +2 -0      jakarta-ant/docs/manual/OptionalTasks/stylebook.html
  
  Index: stylebook.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/docs/manual/OptionalTasks/stylebook.html,v
  retrieving revision 1.2
  retrieving revision 1.2.2.1
  diff -u -r1.2 -r1.2.2.1
  --- stylebook.html	2001/02/13 12:31:56	1.2
  +++ stylebook.html	2001/08/28 21:50:54	1.2.2.1
  @@ -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