ant-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@multitask.com.au
Subject [PATCH]: docs/index.html Documented optional tasks to my knowledge
Date Mon, 20 Mar 2000 16:47:32 GMT
RCS file: /home/cvspublic/jakarta-ant/docs/index.html,v
retrieving revision 1.14
diff -r1.14 index.html
32a33
>   <li><a href="#optionaltasks">Optional Tasks</a>
2077a2079,2389
> <h2><a name="optionaltasks">Optional tasks</a></h2>
> <ul>
>   <li><a href="#netrexxc">NetRexxC</a></li>
>   <li><a href="#renameexts">RenameExtensions</a></li>
>   <li><a href="#script">Script</a></li>
> </ul>
> <hr>
> <h2><a name="netrexxc">NetRexxC</a></h2>
> <h3><b>Description:</b></h3>
> <p>Compiles a <a href="http://www2.hursley.ibm.com/netrexx">NetRexx</a>

source tree within the running (Ant) VM.</p>
> <p>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.</p>
> <p>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</p>
> <p>The directory structure of the source tree should follow the package
> hierarchy.</p>
> <p>It is possible to refine the set of files that are being 
compiled/copied.
> This can be done with the <i>includes</i>, <i>excludes</i> and

<i>defaultexcludes</i>
> attributes. With the <i>includes</i> attribute you specify the files you

want to
> have included by using patterns. The <i>exclude</i> attribute is used to

specify
> the files you want to have excluded. This is also done with patterns. 
And
> finally with the <i>defaultexcludes</i> attribute, you can specify 
whether you
> want to use default exclusions or not. See the section on <a
> href="#directorybasedtasks">directory based tasks</a>, on how the
> inclusion/exclusion of files works, and how to write patterns. The 
patterns are
> relative to the <i>srcDir</i> directory.</p>
> 
> <h3>Parameters:</h3>
> <table border="1" cellpadding="2" cellspacing="0">
>   <tr>
>     <td valign="top"><b>Attribute</b></td>
>     <td valign="top"><b>Description</b></td>
>     <td align="center" valign="top"><b>Required</b></td>
>   </tr>
>   <tr>
>     <td valign="top">binary</td>
>     <td valign="top">Whether literals are treated as the java binary 
type rather than the NetRexx types</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">classpath</td>
>     <td valign="top">The classpath to use during compilation</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">comments</td>
>     <td valign="top">Whether comments are passed through to the 
generated java source</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">compact</td>
>     <td valign="top">Whether error messages come out in compact or 
verbose format</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">compile</td>
>     <td valign="top">Whether the NetRexx compiler should compile the 
generated java code</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">console</td>
>     <td valign="top">Whether or not messages should be displayed on the 
'console'</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">crossref</td>
>     <td valign="top">Whether variable cross references are 
generated</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">decimal</td>
>     <td valign="top">Whether decimal arithmetic should be used for the 
NetRexx code</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">defaultexcludes</td>
>     <td valign="top">indicates whether default excludes should be used 
or not
>       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when

omitted.</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">destDir</td>
>     <td valign="top">the destination directory into which the NetRexx 
source files should be copied and then compiled</td>
>     <td valign="top" align="center">Yes</td>
>   </tr>
>   <tr>
>     <td valign="top">diag</td>
>     <td valign="top">Whether diagnostic information about the compile is 
generated</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">excludes</td>
>     <td valign="top">comma separated list of patterns of files that must 
be
>       excluded. No files (except default excludes) are excluded when 
omitted.</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">explicit</td>
>     <td valign="top">Whether variables must be declared explicitly 
before use</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">format</td>
>     <td valign="top">Whether the generated java code is formatted nicely 
or left to match NetRexx line numbers for call stack debugging</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">includes</td>
>     <td valign="top">comma separated list of patterns of files that must 
be
>       included. All files are included when omitted.</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">java</td>
>     <td valign="top">Whether the generated java code is produced</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">keep</td>
>     <td valign="top">Sets whether the generated java source file should 
be kept after compilation. The generated files will have an extension of 
.java.keep, <b>not</b> .java</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">logo</td>
>     <td valign="top">Whether the compiler text logo is displayed when 
compiling</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">replace</td>
>     <td valign="top">Whether the generated .java file should be replaced 
when compiling</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">savelog</td>
>     <td valign="top">Whether the compiler messages will be written to 
NetRexxC.log as well as to the console</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">sourcedir</td>
>     <td valign="top">Tells the NetRexx compiler to store the class files 
in the same directory as the source files. The alternative is the working 
directory</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">srcDir</td>
>     <td valign="top">Set the source dir to find the source Netrexx 
files</td>
>     <td valign="top" align="center">Yes</td>
>   </tr>
>   <tr>
>     <td valign="top">strictargs</td>
>     <td valign="top">Tells the NetRexx compiler that method calls always 
need parentheses, even if no arguments are needed,
>         e.g. <code>aStringVar.getBytes</code> vs. 
<code>aStringVar.getBytes()</code></td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">strictassign</td>
>     <td valign="top">Tells the NetRexx compile that assignments must 
match exactly on type</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">strictcase</td>
>     <td valign="top">Specifies whether the NetRexx compiler should be 
case sensitive or not</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">strictimport</td>
>     <td valign="top">Whether classes need to be imported explicitly 
using an <code>import</code> statement.
>          By default the NetRexx compiler will import certain packages 
automatically</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">strictprops</td>
>     <td valign="top">Whether local properties need to be qualified 
explicitly using <code>this</code></td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">strictsignal</td>
>     <td valign="top">Whether the compiler should force catching of 
exceptions by explicitly named types</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">symbols</td>
>     <td valign="top">Whether debug symbols should be generated into the 
class file</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">time</td>
>     <td valign="top">Asks the NetRexx compiler to print compilation 
times to the console</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">trace</td>
>     <td valign="top">Turns on or off tracing and directs the resultant 
trace output</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">utf8</td>
>     <td valign="top">Tells the NetRexx compiler that the source is in 
UTF8</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">verbose</td>
>     <td valign="top">Whether lots of warnings and error messages should 
be generated</td>
>     <td valign="top" align="center">Yes</td>
>   </tr>
> </table>
> <h3>Examples</h3>
> <blockquote>
>   <p><code>&lt;netrexxc srcDir=&quot;/source/project&quot;
>            includes=&quot;vnr/util/*&quot;
>            destDir=&quot;/source/project/build&quot; 
>            classpath=&quot;/source/project2/proj.jar&quot; 
comments=&quot;true&quot;
>              crossref=&quot;false&quot; replace=&quot;true&quot; 
keep=&quot;true&quot; /&gt;</code>
>   </p>
> </blockquote>
> <hr>
> <h2><a name="renameexts">RenameExtensions</a></h2>
> <h3><b>Description:</b></h3>
> <p>Renames files in the <code>srcDir</code> directory ending with the

<code>fromExtension</code> string
> so that they end with the <code>toExtension</code> string. Files are 
only replaced if <code>replace</code> is true
> </p>
> <p>See the section on <a href="#directorybasedtasks">directory based 
tasks</a>, on how the
> inclusion/exclusion of files works, and how to write patterns. The 
patterns are
> relative to the <i>srcDir</i> directory.</p>
> <h3>Parameters:</h3>
> <table border="1" cellpadding="2" cellspacing="0">
>   <tr>
>     <td valign="top"><b>Attribute</b></td>
>     <td valign="top"><b>Description</b></td>
>     <td align="center" valign="top"><b>Required</b></td>
>   </tr>
>   <tr>
>     <td valign="top">defaultexcludes</td>
>     <td valign="top">indicates whether default excludes should be used 
or not
>       (&quot;yes&quot;/&quot;no&quot;). Default excludes are used when

omitted.</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">excludes</td>
>     <td valign="top">comma separated list of patterns of files that must 
be
>       excluded. No files (except default excludes) are excluded when 
omitted.</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">fromExtention</td>
>     <td valign="top">The string that files must end in to be 
renamed</td>
>     <td valign="top" align="center">Yes</td>
>   </tr>
>   <tr>
>     <td valign="top">includes</td>
>     <td valign="top">comma separated list of patterns of files that must 
be
>       included. All files are included when omitted.</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">replace</td>
>     <td valign="top">Whether the file being renamed to should be 
replaced if it already exists</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">srcDir</td>
>     <td valign="top">The starting directory for files to search in</td>
>     <td valign="top" align="center">Yes</td>
>   </tr>
>   <tr>
>     <td valign="top">toExtension</td>
>     <td valign="top">The string that renamed files will end with on 
completion</td>
>     <td valign="top" align="center">Yes</td>
>   </tr>
> </table>
> <h3>Examples</h3>
> <blockquote>
>   <p><code>&lt;renameext srcDir=&quot;/source/project1&quot;
>               includes=&quot;**&quot;
>               excludes=&quot;**/samples/*&quot;
>               fromExtension=&quot;.java.keep&quot; 
>               toExtension=&quot;.java&quot;
>                 replace=&quot;true&quot; /&gt;
> </code>
>   </p>
> </blockquote>
> 
> <hr>
> <h2><a name="script">Script</a></h2>
> <h3><b>Description:</b></h3>
> <p>Execute a script in a <a 
href="http://www.alphaworks.ibm.com/tech/bsf">BSF</a> supported language.
> <p>All items (tasks, targets, etc) of the running project are accessible 
from the script.
> <h3>Parameters:</h3>
> <table border="1" cellpadding="2" cellspacing="0">
>   <tr>
>     <td valign="top"><b>Attribute</b></td>
>     <td valign="top"><b>Description</b></td>
>     <td align="center" valign="top"><b>Required</b></td>
>   </tr>
>   <tr>
>     <td valign="top">language</td>
>     <td valign="top">The programming language the script is written in. 
Must be a supported BSF language</td>
>     <td valign="top" align="center">No</td>
>   </tr>
>   <tr>
>     <td valign="top">src</td>
>     <td valign="top">The location of the script as a file, if not 
inline</td>
>     <td valign="top" align="center">No</td>
>   </tr>
> </table>
> <h3>Examples</h3>
> <blockquote>
>   <p>None yet available</p>
> </blockquote>
> 
> 

--
dIon Gillard, Multitask Consulting
Work:      http://www.multitask.com.au
NetRexx: http://www.multitask.com.au/NetRexx.nsf

Mime
View raw message