Return-Path: Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm Delivered-To: mailing list ant-dev@jakarta.apache.org Received: (qmail 39048 invoked by uid 500); 27 Mar 2000 00:46:34 -0000 Delivered-To: apmail-jakarta-ant-cvs@apache.org Received: (qmail 39043 invoked by uid 1064); 27 Mar 2000 00:46:34 -0000 Date: 27 Mar 2000 00:46:34 -0000 Message-ID: <20000327004634.39042.qmail@locus.apache.org> From: rubys@locus.apache.org To: jakarta-ant-cvs@apache.org Subject: cvs commit: jakarta-ant/docs index.html rubys 00/03/26 16:46:34 Modified: docs index.html Log: Documented optional tasks to my knowledge Submitted by: dIon Gillard Revision Changes Path 1.16 +358 -0 jakarta-ant/docs/index.html Index: index.html =================================================================== RCS file: /home/cvs/jakarta-ant/docs/index.html,v retrieving revision 1.15 retrieving revision 1.16 diff -u -r1.15 -r1.16 --- index.html 2000/03/23 03:40:32 1.15 +++ index.html 2000/03/27 00:46:34 1.16 @@ -30,6 +30,7 @@

Built in Tasks +

Optional Tasks

Writing your own task

License

Feedback

@@ -2179,6 +2180,363 @@

+ +

NetRexxC

Description:

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

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

Files in the source tree are copied to the destination directory, +allowing support files to be located properly in the classpath. The source +files are copied because the NetRexx compiler cannot produce class files in a +specific directory via parameters

The directory structure of the source tree should follow the package +hierarchy.

It is possible to refine the set of files that are being compiled/copied. +This can be done with the includes, excludes and +defaultexcludes attributes. With the includes attribute you +specify the files you want to have included by using patterns. The +exclude attribute is used to specify the files you want to have +excluded. This is also done with patterns. And finally with the +defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns. The +patterns are relative to the srcDir directory.

+ +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute	Description	Required
binary	Whether literals are treated as the java binary + type rather than the NetRexx types	No
classpath	The classpath to use during compilation	No
comments	Whether comments are passed through to the + generated java source	No
compact	Whether error messages come out in compact or + verbose format	No
compile	Whether the NetRexx compiler should compile the + generated java code	No
console	Whether or not messages should be displayed on the + 'console'	No
crossref	Whether variable cross references are generated	No
decimal	Whether decimal arithmetic should be used for the + NetRexx code	No
defaultexcludes	indicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when + omitted.	No
destDir	the destination directory into which the NetRexx + source files should be copied and then compiled	Yes
diag	Whether diagnostic information about the compile is + generated	No
excludes	comma separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when + omitted.	No
explicit	Whether variables must be declared explicitly + before use	No
format	Whether the generated java code is formatted nicely + or left to match NetRexx line numbers for call stack debugging	No
includes	comma separated list of patterns of files that must be + included. All files are included when omitted.	No
java	Whether the generated java code is produced	No
keep	Sets whether the generated java source file should be kept + after compilation. The generated files will have an extension of + .java.keep, not .java	No
logo	Whether the compiler text logo is displayed when + compiling	No
replace	Whether the generated .java file should be replaced + when compiling	No
savelog	Whether the compiler messages will be written to + NetRexxC.log as well as to the console	No
sourcedir	Tells the NetRexx compiler to store the class files in the + same directory as the source files. The alternative is the working + directory	No
srcDir	Set the source dir to find the source Netrexx + files	Yes
strictargs	Tells the NetRexx compiler that method calls always + need parentheses, even if no arguments are needed, e.g. + `aStringVar.getBytes` vs. + `aStringVar.getBytes()`	No
strictassign	Tells the NetRexx compile that assignments must + match exactly on type	No
strictcase	Specifies whether the NetRexx compiler should be + case sensitive or not	No
strictimport	Whether classes need to be imported explicitly using an + `import` statement. By default the NetRexx compiler will + import certain packages automatically	No
strictprops	Whether local properties need to be qualified + explicitly using `this`	No
strictsignal	Whether the compiler should force catching of + exceptions by explicitly named types	No
symbols	Whether debug symbols should be generated into the + class file	No
time	Asks the NetRexx compiler to print compilation + times to the console	No
trace	Turns on or off tracing and directs the resultant + trace output	No
utf8	Tells the NetRexx compiler that the source is in UTF8	No
verbose	Whether lots of warnings and error messages should + be generated	Yes

Examples

+
<netrexxc srcDir="/source/project" + includes="vnr/util/*" + destDir="/source/project/build" + classpath="/source/project2/proj.jar" + comments="true" + crossref="false" replace="true" + keep="true" /> +
+

RenameExtensions

Description:

Renames files in the srcDir directory ending with the +fromExtension string so that they end with the +toExtension string. Files are only replaced if +replace is true +

See the section on +directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns. The +patterns are relative to the srcDir directory.

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Attribute	Description	Required
defaultexcludes	indicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when + omitted.	No
excludes	comma separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when + omitted.	No
fromExtention	The string that files must end in to be renamed	Yes
includes	comma separated list of patterns of files that must be + included. All files are included when omitted.	No
replace	Whether the file being renamed to should be + replaced if it already exists	No
srcDir	The starting directory for files to search in	Yes
toExtension	The string that renamed files will end with on + completion	Yes

Examples

+
<renameext srcDir="/source/project1" + includes="**" + excludes="**/samples/*" + fromExtension=".java.keep" + toExtension=".java" + replace="true" /> + +
+

+ +

Script

Description:

Execute a script in a + BSF supported language. +

All items (tasks, targets, etc) of the running project are accessible +from the script. +

Parameters:

+ + + + + + + + + + + + + + + + +

Attribute	Description	Required
language	The programming language the script is written in. + Must be a supported BSF language	No
src	The location of the script as a file, if not inline	No

Examples

+
None yet available
+