You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by gi...@apache.org on 2018/02/28 07:01:47 UTC
[32/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/jdepend.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/jdepend.html b/manual/Tasks/jdepend.html
index 4ad2b5f..e3b9d2e 100644
--- a/manual/Tasks/jdepend.html
+++ b/manual/Tasks/jdepend.html
@@ -29,91 +29,92 @@
<p>Invokes the <a href="http://www.clarkware.com/software/JDepend.html">JDepend</a> parser.</p>
-<p>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."</p>
+<p>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."</p>
-<p>Source file directories are defined by nested
-<code><sourcespath></code>; Class file directories are defined
-by nested <code><classespath></code>, see <a
-href="#nested">nested elements</a>.</p>
+<p>Source file directories are defined by nested <code><sourcespath></code>. Class file
+directories are defined by nested <code><classespath></code>. See <a href="#nested">nested
+elements</a>.</p>
-<p>Optionally, you can also set the <code>outputfile</code> name where the output is stored. By default the task writes its report to the standard output.</P>
+<p>Optionally, you can also set the <var>outputfile</var> name where the output is stored. By
+default the task writes its report to the standard output.</p>
<p>The task requires at least the JDepend 1.2 version.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">outputfile</td>
- <td valign="top">The output file name. If not set, the output is printed on the standard output.</td>
- <td align="center" valign="top">No</td>
+ <td>outputfile</td>
+ <td>The output file name. If not set, the output is printed on the standard output.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">format</td>
- <td valign="top">The format to write the output in. The default is "text", the alternative is "xml"</td>
- <td align="center" valign="top">No</td>
+ <td>format</td>
+ <td>The format to write the output in,
+ either <q>text</q> (default) or <q>xml</q></td>
+ <td>No; the default is <q>text</q></td>
</tr>
<tr>
- <td valign="top">fork</td>
- <td valign="top">Run the tests in a separate VM.</td>
- <td align="center" valign="top">No, default is "off"</td>
+ <td>fork</td>
+ <td>Run the tests in a separate JVM.</td>
+ <td>No; default is <q>off</q></td>
</tr>
<tr>
- <td valign="top">haltonerror</td>
- <td valign="top">Stop the build process if an error occurs during the jdepend analysis.</td>
- <td align="center" valign="top">No, default is "off"</td>
+ <td>haltonerror</td>
+ <td>Stop the build process if an error occurs during the <code>jdepend</code> analysis.</td>
+ <td>No; default is <q>off</q></td>
</tr>
<tr>
- <td valign="top">timeout</td>
- <td valign="top">Cancel the operation if it doesn't finish in the given time (measured in milliseconds). (Ignored if fork is disabled.)</td>
- <td align="center" valign="top">No</td>
+ <td>timeout</td>
+ <td>Cancel the operation if it doesn't finish in the given time (measured in milliseconds).</td>
+ <td>No, ignored if <var>fork</var> is <q>false</q></td>
</tr>
<tr>
- <td valign="top">jvm</td>
- <td valign="top">The 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.)</td>
- <td align="center" valign="top">No, default "java"</td>
+ <td>jvm</td>
+ <td>The command used to invoke JVM. The command is resolved
+ by <code>java.lang.Runtime.exec()</code>.</td>
+ <td>No; default <q>java</q>, ignored if <var>fork</var> is <q>false</q></td>
</tr>
<tr>
- <td valign="top">dir</td>
- <td valign="top">The directory to invoke the VM in. (Ignored if fork is disabled)</td>
- <td align="center" valign="top">No</td>
+ <td>dir</td>
+ <td>The directory to invoke JVM in.</td>
+ <td>No, ignored if <var>fork</var> is <q>false</q></td>
</tr>
<tr>
- <td valign="top">includeruntime</td>
- <td valign="top">Implicitly add the classes required to run jdepend
- in forked mode. (Ignored if fork is disabled). <em>Since Apache Ant 1.6</em>.</td>
- <td align="center" valign="top">No, default is "no".</td>
+ <td>includeruntime</td>
+ <td>Implicitly add the classes required to run <code>jdepend</code> in forked mode. <em>Since
+ Apache Ant 1.6</em>.</td>
+ <td>No; default is <q>no</q>, ignored if <var>fork</var> is <q>false</q></td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">the classpath to use, given as reference to a PATH defined elsewhere.</td>
- <td align="center" valign="top">No</td>
+ <td>classpathref</td>
+ <td>the <var>classpath</var> to use, given as reference to a PATH defined elsewhere.</td>
+ <td>No</td>
</tr>
</table>
<h3 id="nested">Nested Elements</h3>
-<p><code>jdepend</code> supports four nested elements:
-<code><classpath>, <classespath></code> and
-<code><sourcespath></code>, that represent <a
-href="../using.html#path">PATH like structures</a>, and
-<code><exclude></code>.</p>
-
-<p><code><sourcespath></code> is used to define the paths of the
-source code to analyze, but it is deprecated. With version 2.5 of
-JDepend, only class files are analyzed. The nested element
-<code><classespath></code> replaces <code><sourcespath></code> and is used to define
-the paths of compiled class code to analyze; the <code><sourcespath></code>
-variable is still available in case you are using an earlier version
-of JDepend. The <code><exclude></code> element can be used to set packages
-to ignore (requires JDepend 2.5 or above).</p>
+<p><code>jdepend</code> supports four nested
+elements: <code><classpath></code>, <code><classespath></code>
+and <code><sourcespath></code>, that represent <a href="../using.html#path">path-like
+structures</a>, and <code><exclude></code>.</p>
+
+<p><code><sourcespath></code> is used to define the paths of the source code to analyze, but
+it is deprecated. With version 2.5 of JDepend, only class files are analyzed. The nested
+element <code><classespath></code> replaces <code><sourcespath></code> and is used to
+define the paths of compiled class code to analyze; the <code><sourcespath></code> variable is
+still available in case you are using an earlier version of JDepend.
+The <code><exclude></code> element can be used to set packages to ignore (requires JDepend 2.5
+or above).</p>
<h3>Examples</h3>
@@ -122,13 +123,10 @@ to ignore (requires JDepend 2.5 or above).</p>
<classespath>
<pathelement location="build"/>
</classespath>
-</jdepend>
-</pre>
-
-<p>This invokes JDepend on the <code>build</code> directory, writing
-the output on the standard output. The classpath is defined using a
-classpath reference.</p>
+</jdepend></pre>
+<p>This invokes JDepend on the <samp>build</samp> directory, writing the output on the standard
+output. The classpath is defined using a classpath reference.</p>
<pre>
<jdepend outputfile="docs/jdepend.xml" fork="yes" format="xml">
@@ -139,12 +137,10 @@ classpath reference.</p>
<pathelement location="classes"/>
<pathelement location="lib/jdepend.jar"/>
</classpath>
-</jdepend>
-</pre>
+</jdepend></pre>
-<p>This invokes JDepend in a separate VM on the <code>src</code> and
-<code>testsrc</code> directories, writing the output to the
-<code><docs/jdepend.xml></code> file in xml format. The
+<p>This invokes JDepend in a separate JVM on the <samp>src</samp> and <samp>testsrc</samp>
+directories, writing the output to the <samp>docs/jdepend.xml</samp> file in xml format. The
classpath is defined using nested elements.</p>
<pre>
@@ -154,12 +150,10 @@ classpath is defined using nested elements.</p>
<classespath>
<pathelement location="build"/>
</classespath>
-</jdepend>
-</pre>
+</jdepend></pre>
-<p>This invokes JDepend with the build directory as the base for class
-files to analyze, and will ignore all classes in the java.* and
-javax.* packages.</p>
+<p>This invokes JDepend with the build directory as the base for class files to analyze, and will
+ignore all classes in the <samp>java.*</samp> and <samp>javax.*</samp> packages.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/jjdoc.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/jjdoc.html b/manual/Tasks/jjdoc.html
index d0bf263..c61e892 100644
--- a/manual/Tasks/jjdoc.html
+++ b/manual/Tasks/jjdoc.html
@@ -26,76 +26,74 @@
<p><em>Since Apache Ant 1.6</em></p>
<h3>Description</h3>
-<p>Invokes the <a href="http://javacc.dev.java.net/">JJDoc</a> preprocessor
-for the JavaCC compiler compiler. It takes a JavaCC parser specification
-and produces documentation for the BNF grammar.
-It can operate in three modes, determined by command line options.
-<p>To use the jjdoc task, set the <i>target</i> attribute to the name
-of the JavaCC grammar file to process. You also need to specify the directory
-containing the JavaCC installation using the <i>javacchome</i> attribute,
-so that Ant can find the JavaCC classes. Optionally, you can also set the
-<i>outputfile</i> to write the generated BNF documentation file to a specific (directory and) file.
-Otherwise jjdoc writes the generated BNF documentation file as the JavaCC
-grammar file with a suffix .txt or .html.</p>
-<p>This task only invokes JJDoc if the grammar file is newer than the
-generated BNF documentation file.</p>
+<p>Invokes the <a href="https://javacc.org/">JJDoc</a> preprocessor for the JavaCC compiler
+compiler. It takes a JavaCC parser specification and produces documentation for the BNF grammar. It
+can operate in three modes, determined by command line options.
+<p>To use the <code>jjdoc</code> task, set the <var>target</var> attribute to the name of the JavaCC
+grammar file to process. You also need to specify the directory containing the JavaCC installation
+using the <var>javacchome</var> attribute, so that Ant can find the JavaCC classes. Optionally, you
+can also set the <var>outputfile</var> to write the generated BNF documentation file to a specific
+(directory and) file. Otherwise <code>jjdoc</code> writes the generated BNF documentation file as
+the JavaCC grammar file with a suffix <samp>.txt</samp> or <samp>.html</samp>.</p>
+<p>This task only invokes <code>JJDoc</code> if the grammar file is newer than the generated BNF
+documentation file.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">target</td>
- <td valign="top">The javacc grammar file to process.</td>
- <td align="center" valign="top">Yes</td>
+ <td>target</td>
+ <td>The JavaCC grammar file to process.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">javacchome</td>
- <td valign="top">The directory containing the JavaCC distribution.</td>
- <td align="center" valign="top">Yes</td>
+ <td>javacchome</td>
+ <td>The directory containing the JavaCC distribution.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">outputfile</td>
- <td valign="top">The file to write the generated BNF documentation file to. If not set,
- the file is written with the same name as the JavaCC grammar file but with a the suffix .html or .txt</td>
- <td align="center" valign="top">No</td>
+ <td>outputfile</td>
+ <td>The file to write the generated BNF documentation file to. If not set, the file is written
+ with the same name as the JavaCC grammar file but with a the suffix <samp>.html</samp>
+ or <samp>.txt</samp></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">text</td>
- <td valign="top">Sets the TEXT BNF documentation option. This is a boolean option.</td>
- <td align="center" valign="top">No</td>
+ <td>text</td>
+ <td>Sets the TEXT BNF documentation option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">onetable</td>
- <td valign="top">Sets the ONE_TABLE BNF documentation option. This is a boolean option.</td>
- <td align="center" valign="top">No</td>
+ <td>onetable</td>
+ <td>Sets the ONE_TABLE BNF documentation option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">maxmemory</td>
- <td valign="top">Max amount of memory to allocate to the forked
- VM. <em>since Ant 1.8.3</em></td>
- <td align="center" valign="top">No</td>
+ <td>maxmemory</td>
+ <td>Max amount of memory to allocate to the forked JVM. <em>since Ant 1.8.3</em></td>
+ <td>No</td>
</tr>
</table>
<h3>Example</h3>
-<pre><jjdoc
- target="src/Parser.jj"
- outputfile="doc/ParserBNF.html"
- javacchome="c:/program files/JavaCC"/></pre>
+<pre>
+<jjdoc target="src/Parser.jj"
+ outputfile="doc/ParserBNF.html"
+ javacchome="c:/program files/JavaCC"/></pre>
-This invokes JJDoc on grammar file src/Parser.jj, writing the generated
-BNF documentation file, ParserBNF.html, file to doc.
+<p>This invokes JJDoc on grammar file <samp>src/Parser.jj</samp>, writing the generated BNF
+documentation file, <samp>ParserBNF.html</samp>, to <samp>doc</samp>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/jjtree.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/jjtree.html b/manual/Tasks/jjtree.html
index a94390e..0757856 100644
--- a/manual/Tasks/jjtree.html
+++ b/manual/Tasks/jjtree.html
@@ -25,193 +25,153 @@
<h2 id="jjtree">JJTree</h2>
<h3>Description</h3>
-<p>Invokes the <a href="http://javacc.dev.java.net/">JJTree</a> preprocessor
-for the JavaCC compiler compiler. It inserts parse tree building actions
-at various places in the JavaCC source that it generates. The output of
-JJTree is run through JavaCC to create the parser.
-<p>To use the jjtree task, set the <i>target</i> attribute to the name
-of the JJTree grammar file to process. You also need to specify the directory
-containing the JavaCC installation using the <i>javacchome</i> attribute,
-so that Ant can find the JavaCC classes. Optionally, you can also set the
-<i>outputdirectory</i>
-to write the generated JavaCC grammar and node files to a specific directory.
-Otherwise jjtree writes the generated JavaCC grammar and node files to the directory
-containing the JJTree grammar file. As an extra option, you can also set the
-<i>outputfile</i> to write the generated JavaCC grammar file to a specific (directory and) file.
-Otherwise jjtree writes the generated JavaCC grammar file as the JJTree
-grammar file with a suffix .jj.</p>
-<p>This task only invokes JJTree if the grammar file is newer than the
-generated JavaCC file.</p>
+<p>Invokes the <a href="https://javacc.org/">JJTree</a> preprocessor for the JavaCC compiler
+compiler. It inserts parse tree building actions at various places in the JavaCC source that it
+generates. The output of JJTree is run through JavaCC to create the parser.</p>
+<p>To use the <code>jjtree</code> task, set the <var>target</var> attribute to the name of the
+JJTree grammar file to process. You also need to specify the directory containing the JavaCC
+installation using the <var>javacchome</var> attribute, so that Ant can find the JavaCC
+classes. Optionally, you can also set the <var>outputdirectory</var> to write the generated JavaCC
+grammar and node files to a specific directory. Otherwise <code>jjtree</code> writes the generated
+JavaCC grammar and node files to the directory containing the JJTree grammar file. As an extra
+option, you can also set the <var>outputfile</var> to write the generated JavaCC grammar file to a
+specific (directory and) file. Otherwise <code>jjtree</code> writes the generated JavaCC grammar
+file as the JJTree grammar file with a suffix <samp>.jj</samp>.</p>
+<p>This task only invokes JJTree if the grammar file is newer than the generated JavaCC file.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
-<td valign="top"><b>Attribute</b></td>
-
-<td valign="top"><b>Description</b></td>
-
-<td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
-<td valign="top">target</td>
-
-<td valign="top">The jjtree grammar file to process.</td>
-
-<td align="center" valign="top">Yes</td>
+ <td>target</td>
+ <td>The JJTree grammar file to process.</td>
+ <td>Yes</td>
</tr>
<tr>
-<td valign="top">javacchome</td>
-
-<td valign="top">The directory containing the JavaCC distribution.</td>
-
-<td align="center" valign="top">Yes</td>
+ <td>javacchome</td>
+ <td>The directory containing the JavaCC distribution.</td>
+ <td>Yes</td>
</tr>
<tr>
-<td valign="top">outputdirectory</td>
-
-<td valign="top">The directory to write the generated JavaCC grammar and node files to.
-If not set, the files are written to the directory containing the grammar file.</td>
-
-<td align="center" valign="top">No</td>
+ <td>outputdirectory</td>
+ <td>The directory to write the generated JavaCC grammar and node files to. If not set, the files
+ are written to the directory containing the grammar file.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">outputfile</td>
-
-<td valign="top">The file to write the generated JavaCC grammar file
-to. If not set, the file is written with the same name as the JJTree
-grammar file but with a the suffix <code>.jj</code>. This is a
-filename relative to <em>outputdirectory</em> if specified, the
-project's basedir.</td>
-
-<td align="center" valign="top">No</td>
+ <td>outputfile</td>
+ <td>The file to write the generated JavaCC grammar file to. If not set, the file is written with
+ the same name as the JJTree grammar file but with a the suffix <code>.jj</code>. This is a
+ filename relative to <var>outputdirectory</var> if specified, the project's basedir.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">buildnodefiles</td>
-
-<td valign="top">Sets the BUILD_NODE_FILES grammar option. This is a boolean
-option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>buildnodefiles</td>
+ <td>Sets the BUILD_NODE_FILES grammar option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">multi</td>
-
-<td valign="top">Sets the MULTI grammar option. This is a boolean option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>multi</td>
+ <td>Sets the MULTI grammar option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">nodedefaultvoid</td>
-
-<td valign="top">Sets the NODE_DEFAULT_VOID grammar option. This is a boolean
-option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>nodedefaultvoid</td>
+ <td>Sets the NODE_DEFAULT_VOID grammar option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">nodefactory</td>
-
-<td valign="top">Sets the NODE_FACTORY grammar option. This is boolean option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>nodefactory</td>
+ <td>Sets the NODE_FACTORY grammar option. This is boolean option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">nodescopehook</td>
-
-<td valign="top">Sets the NODE_SCOPE_HOOK grammar option. This is a boolean
-option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>nodescopehook</td>
+ <td>Sets the NODE_SCOPE_HOOK grammar option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">nodeusesparser</td>
-
-<td valign="top">Sets the NODE_USES_PARSER grammar option. This is a boolean
-option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>nodeusesparser</td>
+ <td>Sets the NODE_USES_PARSER grammar option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">static</td>
-
-<td valign="top">Sets the STATIC grammar option. This is a boolean option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>static</td>
+ <td>Sets the STATIC grammar option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">visitor</td>
-
-<td valign="top">Sets the VISITOR grammar option. This is a boolean option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>visitor</td>
+ <td>Sets the VISITOR grammar option. This is a boolean option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">nodepackage</td>
-
-<td valign="top">Sets the NODE_PACKAGE grammar option. This is a string option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>nodepackage</td>
+ <td>Sets the NODE_PACKAGE grammar option. This is a string option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">visitorexception</td>
-
-<td valign="top">Sets the VISITOR_EXCEPTION grammar option. This is a string
-option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>visitorexception</td>
+ <td>Sets the VISITOR_EXCEPTION grammar option. This is a string option.</td>
+ <td>No</td>
</tr>
<tr>
-<td valign="top">nodeprefix</td>
-
-<td valign="top">Sets the NODE_PREFIX grammar option. This is a string option.</td>
-
-<td align="center" valign="top">No</td>
+ <td>nodeprefix</td>
+ <td>Sets the NODE_PREFIX grammar option. This is a string option.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">maxmemory</td>
- <td valign="top">Max amount of memory to allocate to the forked
- VM. <em>since Ant 1.8.3</em></td>
- <td align="center" valign="top">No</td>
+ <td>maxmemory</td>
+ <td>Max amount of memory to allocate to the forked JVM. <em>since Ant 1.8.3</em></td>
+ <td>No</td>
</tr>
</table>
<h3>Example</h3>
-<pre><jjtree
- target="src/Parser.jjt"
- outputdirectory="build/src"
- javacchome="c:/program files/JavaCC"
- nodeusesparser="true"/></pre>
-This invokes JJTree on grammar file src/Parser.jjt, writing the generated
-grammar file, Parser.jj, file to build/src. The grammar option NODE_USES_PARSER
-is set to true when invoking JJTree.
+<pre>
+<jjtree target="src/Parser.jjt"
+ outputdirectory="build/src"
+ javacchome="c:/program files/JavaCC"
+ nodeusesparser="true"/></pre>
-<h3>Comparison output locations between command line JJTree and different Ant taskdef versions</h3>
+<p>This invokes JJTree on grammar file <samp>src/Parser.jjt</samp>, writing the generated grammar
+file, <samp>Parser.jj</samp>, file to <samp>build/src</samp>. The grammar option NODE_USES_PARSER is
+set to <q>true</q> when invoking JJTree.</p>
+
+<h3>Comparison output locations between command line JJTree and different Ant <code>taskdef</code>
+versions</h3>
<table>
+ <thead class="no-bold">
<tr>
- <td><b>Command Line JJTree options</b>
- <i>and Generated Files</i> (working directory: <code>/tmp</code>)</td>
- <td><b>Ant 1.5.3</b> versus command line</td>
- <td><b>Ant 1.6</b> versus command line</td>
+ <th><strong>Command line JJTree options</strong> and <em>generated files</em> (working directory: <samp>/tmp</samp>)</th>
+ <th><strong>Ant 1.5.3</strong> versus command line</th>
+ <th><strong>Ant 1.6</strong> versus command line</th>
</tr>
+ </thead>
+ <tbody>
<tr>
<td><pre><b>jjtree grammar.jjt</b>
/tmp/grammar.jj
@@ -232,7 +192,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree /tmp/absolute/grammar.jjt</b>
/tmp/grammar.jj
/tmp/<generated>.java</pre>
</td>
@@ -243,7 +203,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative grammar.jjt</b>
/tmp/relative/grammar.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -251,7 +211,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
/tmp/relative/grammar.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -259,7 +219,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
/tmp/relative/grammar.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -267,7 +227,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
/tmp/absolute/grammar.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -275,7 +235,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
/tmp/absolute/grammar.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -283,7 +243,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
/tmp/absolute/grammar.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -291,7 +251,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj grammar.jjt</b>
/tmp/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -299,7 +259,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj relative/grammar.jjt</b>
/tmp/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -307,7 +267,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj /tmp/absolute/grammar.jjt</b>
/tmp/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -315,7 +275,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
/tmp/relative/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -323,7 +283,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
/tmp/relative/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -331,7 +291,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
/tmp/relative/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -339,7 +299,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
/tmp/absolute/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -347,7 +307,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
/tmp/absolute/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -355,7 +315,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
/tmp/absolute/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -363,7 +323,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -371,7 +331,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj relative/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -379,7 +339,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj /tmp/absolute/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -387,7 +347,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
/tmp/relative/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -395,7 +355,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
/tmp/relative/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -403,7 +363,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
/tmp/relative/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -411,7 +371,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
/tmp/absolute/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -419,7 +379,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
/tmp/absolute/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -427,7 +387,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
/tmp/absolute/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -435,7 +395,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -443,7 +403,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj relative/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -451,7 +411,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj /tmp/absolute/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -459,7 +419,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:<i><u>D:</u></i>/tmp/subdir/output.jj grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:<i>D:</i>/tmp/subdir/output.jj grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -467,7 +427,7 @@ is set to true when invoking JJTree.
<td>Not Supported *)</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:<i><u>D:</u></i>/tmp/subdir/output.jj relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:<i>D:</i>/tmp/subdir/output.jj relative/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -475,7 +435,7 @@ is set to true when invoking JJTree.
<td>Not Supported *)</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:<i><u>D:</u></i>/tmp/subdir/output.jj /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:<i>D:</i>/tmp/subdir/output.jj /tmp/absolute/grammar.jjt</b>
/tmp/subdir/output.jj
/tmp/<generated>.java</pre>
</td>
@@ -483,7 +443,7 @@ is set to true when invoking JJTree.
<td>Not Supported *)</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative grammar.jjt</b>
/tmp/relative/tmp/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -491,7 +451,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative relative/grammar.jjt</b>
/tmp/relative/tmp/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -499,7 +459,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:relative /tmp/absolute/grammar.jjt</b>
/tmp/relative/tmp/subdir/output.jj
/tmp/relative/<generated>.java</pre>
</td>
@@ -507,7 +467,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ grammar.jjt</b>
/tmp/absolute/tmp/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -515,7 +475,7 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ relative/grammar.jjt</b>
/tmp/absolute/tmp/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
@@ -523,26 +483,30 @@ is set to true when invoking JJTree.
<td>Same</td>
</tr>
<tr>
- <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
+ <td><pre><b>jjtree -OUTPUT_FILE:/tmp/subdir/output.jj -OUTPUT_DIRECTORY:/tmp/absolute/ /tmp/absolute/grammar.jjt</b>
/tmp/absolute/tmp/subdir/output.jj
/tmp/absolute/<generated>.java</pre>
</td>
<td>Not Supported</td>
<td>Same</td>
</tr>
+ </tbody>
</table>
-<p>*) <u>Footnote</u>: When running JJTree with the Ant taskdef <i>jjtree</i> the option <code>-OUTPUT_DIRECTORY</code> must always
-be set, because the project's basedir and the Ant working directory might differ. So even if you don't specify the jjtree taskdef
-<i>outputdirectory</i> JJTree will be called with the <code>-OUTPUT_DIRECTORY</code> set to the project's basedirectory.
-But when the <code>-OUTPUT_DIRECTORY</code> is set, the <code>-OUTPUT_FILE</code> setting is handled as if relative to this
-<code>-OUTPUT_DIRECTORY</code>. Thus when the <code>-OUTPUT_FILE</code> is absolute or contains a drive letter we have a
-problem.
-Therefore absolute <i>outputfile</i>s (when the <i>outputdirectory</i> isn't specified) are made relative to the default directory.
-And for this reason <i>outputfile</i>s that contain a drive letter can't be supported.</p>
-
-<p>By the way: specifying a drive letter in the <code>-OUTPUT_FILE</code> when the <code>-OUTPUT_DIRECTORY</code> is set, also
-results in strange behavior when running JJTree from the command line.</p>
+<p>*) <strong>Footnote</strong>: When running JJTree with the Ant <code>taskdef jjtree</code> the
+option <code>-OUTPUT_DIRECTORY</code> must always be set, because the project's <var>basedir</var>
+and the Ant working directory might differ. So even if you don't specify
+the <var>outputdirectory</var> for <code>taskdef jjtree</code>, JJTree will be called with
+the <code>-OUTPUT_DIRECTORY</code> set to the project's <var>basedir</var>. But when
+the <code>-OUTPUT_DIRECTORY</code> is set, the <code>-OUTPUT_FILE</code> setting is handled as if
+relative to this <code>-OUTPUT_DIRECTORY</code>. Thus when the <code>-OUTPUT_FILE</code> is absolute
+or contains a drive letter we have a problem. Therefore absolute <var>outputfile</var>s (when
+the <var>outputdirectory</var> isn't specified) are made relative to the default directory. And for
+this reason <var>outputfile</var>s that contain a drive letter can't be supported.</p>
+
+<p>By the way: specifying a drive letter in the <code>-OUTPUT_FILE</code> when
+the <code>-OUTPUT_DIRECTORY</code> is set, also results in strange behavior when running JJTree from
+the command line.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/jlink.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/jlink.html b/manual/Tasks/jlink.html
index 5cf7b34..69f420f 100644
--- a/manual/Tasks/jlink.html
+++ b/manual/Tasks/jlink.html
@@ -22,104 +22,80 @@
<body>
<h2 id="jlink">Jlink</h2>
-<h3><i>Deprecated</i></h3>
-<p><i>This task has been deprecated. Use a <a href="../Types/zipfileset.html">zipfileset</a>
- or <a href="../Tasks/zip.html#zipgroupfileset">zipgroupfileset</a> with the
- <a href="../Tasks/jar.html">Jar task</a> or <a href="../Tasks/zip.html">Zip task</a>
- instead.</i></p>
+<h3><em><u>Deprecated</u></em></h3>
+<p><em>This task has been <u>deprecated</u>. Use a <a href="../Types/zipfileset.html">zipfileset</a>
+or <a href="../Tasks/zip.html#zipgroupfileset">zipgroupfileset</a> with
+the <a href="../Tasks/jar.html">Jar task</a> or <a href="../Tasks/zip.html">Zip task</a>
+instead.</em></p>
-<h3><b>Description:</b></h3>
+<h3>Description</h3>
<p>Links entries from sub-builds and libraries.</p>
-<p>The jlink task can be used to build jar and zip files, similar to
-the <i>jar</i> task.
-However, jlink provides options for controlling the way entries from
-input files
-are added to the output file. Specifically, capabilities for merging
-entries from
-multiple zip or jar files is available.</p>
-
-<p>If a mergefile is specified directly (eg. at the top level of a
-<i>mergefiles</i>
-pathelement) <i>and</i> the mergefile ends in ".zip" or
-".jar",
-entries in the mergefile will be merged into the outfile. A file with
-any other extension
-will be added to the output file, even if it is specified in the
-mergefiles element.
-Directories specified in either the mergefiles or addfiles element
-are added to the
-output file as you would expect: all files in subdirectories are
-recursively added to
-the output file with appropriate prefixes in the output file
-(without merging).
-</p>
-
-<p>
-In the case where duplicate entries and/or files are found among the
-files to be merged or
-added, jlink merges or adds the first entry and ignores all subsequent entries.
-</p>
-
-<p>
-jlink ignores META-INF directories in mergefiles. Users should supply their
-own manifest information for the output file.
-</p>
-
-<p>It is possible to refine the set of files that are being jlinked.
-This can be
-done with the <i>includes</i>, <i>includesfile</i>, <i>excludes</i>,
-<i>excludesfile</i>,
-and <i>defaultexcludes</i> attributes on the <i>addfiles</i> and
-<i>mergefiles</i>
-nested elements. With the <i>includes</i> or <i>includesfile</i>
-attribute you specify the files you want to have included by using patterns.
-The <i>exclude</i> or <i>excludesfile</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="../dirtasks.html#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>base</i> directory.</p>
-
-
-
-<h3>Parameters:</h3>
-<table>
+<p>The <code>jlink</code> task can be used to build jar and zip files, similar to
+the <code>jar</code> task. However, <code>jlink</code> provides options for controlling the way
+entries from input files are added to the output file. Specifically, capabilities for merging
+entries from multiple zip or jar files is available.</p>
+
+<p>If a mergefile is specified directly (eg. at the top level of a <code>mergefiles</code>
+pathelement) <em>and</em> the mergefile ends in <samp>.zip</samp> or <samp>.jar</samp>, entries in
+the mergefile will be merged into the <var>outfile</var>. A file with any other extension will be
+added to the output file, even if it is specified in the <code>mergefiles</code> element.
+Directories specified in either the <code>mergefiles</code> or <code>addfiles</code> element are
+added to the output file as you would expect: all files in subdirectories are recursively added to
+the output file with appropriate prefixes in the output file (without merging).</p>
+
+<p>In the case where duplicate entries and/or files are found among the files to be merged or
+added, <code>jlink</code> merges or adds the first entry and ignores all subsequent entries.</p>
+
+<p><code>jlink</code> ignores <samp>META-INF</samp> directories in <var>mergefiles</var>. Users
+should supply their own manifest information for the output file.</p>
+
+<p>It is possible to refine the set of files that are being jlinked. This can be done with
+the <var>includes</var>, <var>includesfile</var>, <var>excludes</var>, <var>excludesfile</var>,
+and <var>defaultexcludes</var> attributes on the <code>addfiles</code> and <code>mergefiles</code>
+nested elements. With the <var>includes</var> or <var>includesfile</var> attribute you specify the
+files you want to have included by using patterns. The <var>exclude</var>
+or <var>excludesfile</var> attribute is used to specify the files you want to have excluded. This is
+also done with patterns. And finally with the <var>defaultexcludes</var> attribute, you can specify
+whether you want to use default exclusions or not. See the section
+on <a href="../dirtasks.html#directorybasedtasks">directory based tasks</a>, on how the
+inclusion/exclusion of files works, and how to write patterns. The patterns are relative to
+the <em>base</em> directory.</p>
+
+<h3>Parameters</h3>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">outfile</td>
- <td valign="top">the path of the output file.</td>
- <td valign="top" align="center">Yes</td>
+ <td>outfile</td>
+ <td>the path of the output file.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">compress</td>
- <td valign="top">whether or not the output should be compressed.
-<i>true</i>,
- <i>yes</i>, or <i>on</i> result in compressed output.
- If omitted, output will be uncompressed (inflated).</td>
- <td valign="top" align="center">No</td>
+ <td>compress</td>
+ <td>whether or not the output should be compressed. <q>true</q>, <q>yes</q>, or <q>on</q>
+ result in compressed output.</td>
+ <td>No; defaults to uncompressed (inflated) output</td>
</tr>
<tr>
- <td valign="top">mergefiles</td>
- <td valign="top">files to be merged into the output, if possible.</td>
- <td valign="middle" align="center" rowspan="2">Exactly one of the two</td>
+ <td>mergefiles</td>
+ <td>files to be merged into the output, if possible.</td>
+ <td rowspan="2">Exactly one of the two</td>
</tr>
<tr>
- <td valign="top">addfiles</td>
- <td valign="top">files to be added to the output.</td>
+ <td>addfiles</td>
+ <td class="left">files to be added to the output.</td>
</tr>
</table>
<h3>Examples</h3>
-<p>The following will merge the entries in mergefoo.jar and mergebar.jar
-into out.jar.
-mac.jar and pc.jar will be added as single entries to out.jar.</p>
+<p>The following will merge the entries in <samp>mergefoo.jar</samp> and <samp>mergebar.jar</samp>
+into <samp>out.jar</samp>. <samp>mac.jar</samp> and <samp>pc.jar</samp> will be added as single
+entries to <samp>out.jar</samp>.</p>
<pre>
<jlink compress="false" outfile="out.jar">
<mergefiles>
@@ -133,7 +109,7 @@ mac.jar and pc.jar will be added as single entries to out.jar.</p>
</jlink>
</pre>
-<p><b>Non-deprecated alternative to the above:</b></p>
+<p><strong>Non-deprecated alternative to the above:</strong></p>
<pre>
<jar compress="false" destfile="out.jar">
<zipgroupfileset dir="${build.dir}">
@@ -147,28 +123,25 @@ mac.jar and pc.jar will be added as single entries to out.jar.</p>
</jar>
</pre>
-<p>Suppose the file foo.jar contains two entries: bar.class and
-barnone/myClass.zip.
-Suppose the path for file foo.jar is build/tempbuild/foo.jar. The
-following example
-will provide the entry tempbuild/foo.jar in the out.jar.</p>
+<p>Suppose the file foo.jar contains two entries: <samp>bar.class</samp>
+and <samp>barnone/myClass.zip</samp>. Suppose the path for file <samp>foo.jar</samp>
+is <samp>build/tempbuild/foo.jar</samp>. The following example will provide the
+entry <samp>tempbuild/foo.jar</samp> in the <samp>out.jar</samp>.</p>
<pre>
<jlink compress="false" outfile="out.jar">
<mergefiles>
<pathelement path="build/tempbuild"/>
</mergefiles>
-</jlink>
-</pre>
+</jlink></pre>
-<p>However, the next example would result in two top-level entries in out.jar,
-namely bar.class and barnone/myClass.zip</p>
+<p>However, the next example would result in two top-level entries in <samp>out.jar</samp>,
+namely <samp>bar.class</samp> and <samp>barnone/myClass.zip</samp></p>
<pre>
<jlink compress="false" outfile="out.jar">
<mergefiles>
<pathelement path="build/tempbuild/foo.jar"/>
</mergefiles>
-</jlink>
-</pre>
+</jlink></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/jspc.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/jspc.html b/manual/Tasks/jspc.html
index 678d02d..02acd3d 100644
--- a/manual/Tasks/jspc.html
+++ b/manual/Tasks/jspc.html
@@ -25,233 +25,191 @@
<body>
<h2 id="jspc">jspc</h2>
-<h3><i>Deprecated</i></h3>
-<p>
-<i>If you use this task with Tomcat's Jasper JSP compiler, you should seriously
-consider using the task shipping with Tomcat instead.</i> This task is only
-tested against Tomcat 4.x. There are known problems with Tomcat 5.x that won't
-get fixed in Ant, please use Tomcat's jspc task instead.<br/>
-Instead of relying on container specific JSP-compilers we suggest deploying the
-raw files (*.jsp) and use the container build-in functions: after deploying run
-a test suite
-(e.g. with <a href="http://attic.apache.org/projects/jakarta-cactus.html">Cactus</a>
-or <a href="http://httpunit.sourceforge.net/">HttpUnit</a>) against the deployed
-web application. So you'll get the test result <i>and</i> the compiled JSPs.
-</p>
+<h3><em><u>Deprecated</u></em></h3>
+<p><em>If you use this task with Tomcat's Jasper JSP compiler, you should seriously consider using
+the task shipping with Tomcat instead.</em> This task is only tested against Tomcat 4.x. There are
+known problems with Tomcat 5.x that won't get fixed in Ant, please use Tomcat's <code>jspc</code>
+task instead.<br/> Instead of relying on container-specific JSP compilers we suggest deploying the
+raw files (<samp>*.jsp</samp>) and use the container build-in functions: after deploying run a test
+suite (e.g. with <a href="https://attic.apache.org/projects/jakarta-cactus.html">Cactus</a>
+or <a href="http://httpunit.sourceforge.net/">HttpUnit</a>) against the deployed web application. So
+you'll get the test result <em>and</em> the compiled JSPs.</p>
<h3>Description</h3>
-<p>
-Apache Ant task to run the JSP compiler and turn JSP pages into Java source.
-</p>
+<p>Apache Ant task to run the JSP compiler and turn JSP pages into Java source files.</p>
-<p>
-This task can be used to precompile JSP pages for fast initial invocation of JSP
-pages, deployment on a server without the full JDK installed, or simply to
-syntax check the pages without deploying them. In most cases, a javac task is
-usually the next stage in the build process. The task does basic dependency
-checking to prevent unnecessary recompilation - this checking compares source
-and destination timestamps, and does not factor in class or taglib dependencies,
-or <code><jsp:include></code> references.
-</p>
+<p>This task can be used to precompile JSP pages for fast initial invocation of JSP pages,
+deployment on a server without the full JDK installed, or simply to syntax check the pages without
+deploying them. In most cases, a <code>javac</code> task is usually the next stage in the build
+process. The task does basic dependency checking to prevent unnecessary recompilation—this
+checking compares source and destination timestamps, and does not factor in class or taglib
+dependencies, or <code><jsp:include></code> references.</p>
-<p>
-By default the task uses the Jasper JSP compiler. This
-means the task needs jasper.jar and jasper-runtime.jar, which come with
-builds of Tomcat 4/Catalina from the
-<a href="http://tomcat.apache.org/">Apache Tomcat project</a>,
-and any other Jar files which may be needed in future versions (it changes)
+<p>By default the task uses the Jasper JSP compiler. This means the task
+needs <samp>jasper.jar</samp> and <samp>jasper-runtime.jar</samp>, which come with builds of Tomcat
+4/Catalina from the <a href="https://tomcat.apache.org/">Apache Tomcat project</a>, and any other
+jar files which may be needed in future versions (it changes).</p>
-We recommend (in March 2003) Tomcat version 4.1.x for the most robust version
-of Jasper.
-</p>
+<p>We recommend (in March 2003) Tomcat version 4.1.x for the most robust version of Jasper.</p>
-<p>
-There are many limitations with this task which partially stem from the many
-versions of Jasper, others from implementation 'issues' in the task
-(i.e. nobody's willingness to radically change large bits of it to work around
-jasper). Because of this and the fact that JSP pages do not have to be portable
-across implementations -or versions of implementations- this task is better used
-for validating JSP pages before deployment, rather than precompiling them. For
-that, just deploy and run your httpunit junit tests after deployment to compile
-and test your pages, all in one go.
-</p>
+<p>There are many limitations with this task which partially stem from the many versions of Jasper,
+others from implementation 'issues' in the task (i.e. nobody's willingness to radically change large
+bits of it to work around Jasper). Because of this and the fact that JSP pages do not have to be
+portable across implementations—or versions of implementations—this task is better used
+for validating JSP pages before deployment, rather than precompiling them. For the latter, just
+deploy and run your HttpUnit JUnit tests after deployment to compile and test your pages, all in one
+go.</p>
<h3>Parameters</h3>
<p>The Task has the following attributes:</p>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">destdir</td>
- <td valign="top">Where to place the generated files. They are located
- under here according to the given package name.</td>
- <td valign="top" align="center">Yes</td>
+ <td>destdir</td>
+ <td>Where to place the generated files. They are located under here according to the given
+ package name.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">srcdir</td>
- <td valign="top">Where to look for source jsp files.</td>
- <td valign="top" align="center">Yes</td>
+ <td>srcdir</td>
+ <td>Where to look for source JSP files.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">The verbosity integer to pass to the compiler. Default="0"</td>
- <td valign="top" align="center">No</td>
+ <td>verbose</td>
+ <td>The verbosity integer to pass to the compiler.</td>
+ <td>No; default <q>0</q></td>
</tr>
<tr>
- <td valign="top">package</td>
- <td valign="top">Name of the destination package for generated java
- classes.</td>
- <td valign="top" align="center">No</td>
+ <td>package</td>
+ <td>Name of the destination package for generated Java classes.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">compiler</td>
- <td valign="top">class name of a JSP compiler adapter,
- such as "jasper" or "jasper41"</td>
- <td valign="top" align="center">No -defaults to "jasper"</td>
+ <td>compiler</td>
+ <td>class name of a JSP compiler adapter, such as <q>jasper</q> or <q>jasper41</q></td>
+ <td>No; defaults to <q>jasper</q></td>
</tr>
<tr>
- <td valign="top">ieplugin</td>
- <td valign="top">Java Plugin classid for Internet Explorer.</td>
- <td valign="top" align="center">No</td>
+ <td>ieplugin</td>
+ <td>Java Plugin classid for Internet Explorer.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">mapped</td>
- <td valign="top">(boolean) Generate separate write() calls for each HTML
- line in the JSP.</td>
- <td valign="top" align="center">No</td>
+ <td>mapped</td>
+ <td>(boolean) Generate separate <code>write()</code> calls for each HTML line in the JSP.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">The classpath to use to run the jsp compiler.
- This can also be specified
- by the nested element <code>classpath</code>
- <a href="../using.html#path">Path</a>).</td>
- <td valign="top" align="center">No, but it seems to work better when used</td>
+ <td>classpath</td>
+ <td>The classpath to use to run the JSP compiler.</td>
+ <td>No, but it seems to work better when used; can also be specified by the nested
+ element <a href="../using.html#path"><code>classpath</code></a></td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">A <a href="../using.html#references">Reference</a>. As
- per <code>classpath</code></td>
- <td valign="top" align="center">No</td>
+ <td>classpathref</td>
+ <td>A <a href="../using.html#references">Reference</a>. As per <var>classpath</var>.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">flag to control action on compile failures: default=yes</td>
- <td valign="top" align="center">No</td>
+ <td>failonerror</td>
+ <td>flag to control action on compile failures.</td>
+ <td>No; default <q>yes</q></td>
</tr>
<tr>
- <td valign="top">uribase</td>
- <td valign="top">
- The uri context of relative URI
- references in the JSP pages. If it does not
- exist then it is derived from the location of the file
- relative to the declared or derived value of <tt>uriroot.</tt>
- </td>
- <td valign="top" align="center">No</td>
+ <td>uribase</td>
+ <td>The context of relative URI references in JSP.</td>
+ <td>No; derived from the location of the file relative to the declared or derived value
+ of <var>uriroot</var></td>
</tr>
<tr>
- <td valign="top">uriroot</td>
- <td valign="top">
- The root directory that uri files should be resolved
- against.
- </td>
- <td valign="top" align="center">No</td>
+ <td>uriroot</td>
+ <td>The root directory that URIs should be resolved against.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">compiler</td>
- <td valign="top">
- Class name of jsp compiler adapter to use. Defaults to
- the standard adapter for Jasper.
- </td>
- <td valign="top" align="center">No</td>
+ <td>compiler</td>
+ <td>Class name of JSP compiler adapter to use.</td>
+ <td>No; defaults to the standard adapter for Jasper</td>
</tr>
<tr>
- <td valign="top">compilerclasspath</td>
- <td valign="top">The classpath used to find the compiler adapter specified
- by the <code>compiler</code> attribute.</td>
- <td valign="top" align="center">No</td>
+ <td>compilerclasspath</td>
+ <td>The classpath used to find the compiler adapter specified by the <var>compiler</var>
+ attribute.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">webinc</td>
- <td valign="top">Output file name for the fraction of web.xml that lists servlets.</td>
- <td valign="top" align="center">No</td>
+ <td>webinc</td>
+ <td>Output file name for the fraction of <samp>web.xml</samp> that lists servlets.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">webxml</td>
- <td valign="top">File name for web.xml to be generated</td>
- <td valign="top" align="center">No</td>
+ <td>webxml</td>
+ <td>File name for <samp>web.xml</samp> to be generated</td>
+ <td>No</td>
</tr>
</table>
-<p>The <tt>mapped</tt> option will, if set to true, split the JSP text content into a
-one line per call format. There are comments above and below the mapped
-write calls to localize where in the JSP file each line of text comes
-from. This can lead to a minor performance degradation (but it is bound
-by a linear complexity). Without this options all adjacent writes are
-concatenated into a single write.</p>
+<p>The <var>mapped</var> option will, if set to <q>true</q>, split the JSP text content into a one
+line per call format. There are comments above and below the mapped write calls to localize where
+in the JSP file each line of text comes from. This can lead to a minor performance degradation (but
+it is bound by a linear complexity). Without this option all adjacent writes are concatenated into
+a single write.</p>
-<p>The <tt>ieplugin</tt> option is used by the <tt><jsp:plugin></tt> tags.
-If the Java Plug-in COM Class-ID you want to use changes then it can be
-specified here. This should not need to be altered.</p>
+<p>The <var>ieplugin</var> option is used by the <code><jsp:plugin></code> tags. If the Java
+Plug-in COM Class-ID you want to use changes then it can be specified here. This should not need to
+be altered.</p>
-<p><tt>uriroot</tt> specifies the root of the web
-application. This is where all absolute uris will be resolved from.
-If it is not specified then the first JSP page will be used to derive
-it. To derive it each parent directory of the first JSP page is
-searched for a <tt>WEB-INF</tt> directory, and the directory closest to
-the JSP page that has one will be used. If none can be found then the
-directory Jasperc was called from will be used. This only affects pages
-translated from an explicitly declared JSP file - including references
-to taglibs</p>
+<p><var>uriroot</var> specifies the root of the web application. This is where all absolute URIs
+will be resolved from. If it is not specified then the first JSP page will be used to derive it.
+To derive it each parent directory of the first JSP page is searched for a <samp>WEB-INF</samp>
+directory, and the directory closest to the JSP page that has one will be used. If none can be
+found then the directory Jasperc was called from will be used. This only affects pages translated
+from an explicitly declared JSP file—including references to taglibs.</p>
-<p><tt>uribase</tt> is used to establish the uri context of
-relative URI references in the JSP pages. If it does not exist then it
-is derived from the location of the file relative to the declared or
-derived value of <tt>uriroot</tt>. This only affects pages
-translated from an explicitly declared JSP file.</p>
+<p><var>uribase</var> is used to establish the context of relative URI references in the JSP pages.
+If it does not exist then it is derived from the location of the file relative to the declared or
+derived value of <var>uriroot</var>. This only affects pages translated from an explicitly declared
+JSP file.</p>
<h3>Parameters specified as nested elements</h3>
-<p>
-This task is a <a href="../dirtasks.html">directory based task</a>, like
-<strong>javac</strong>, so the jsp files to be compiled are located as java
-files are by <strong>javac</strong>. That is, elements such as <tt>includes</tt> and
-<tt>excludes</tt> can be used directly inside the task declaration.
-</p>
+<p>This task is a <a href="../dirtasks.html">directory based task</a>, like <code>javac</code>, so
+the <samp>.jsp</samp> files to be compiled are located as <samp>.java</samp> files are
+by <code>javac</code>. That is, elements such as <code>includes</code> and <code>excludes</code> can
+be used directly inside the task declaration.</p>
-<p>
-Elements specific to the jspc task are:
-</p>
+<p>Elements specific to the <code>jspc</code> task are:</p>
<h4>classpath</h4>
-The classpath used to compile the JSP pages, specified as for any other
-classpath.
+<p>The classpath used to compile the JSP pages, specified as for any other classpath.</p>
<h4>classpathref</h4>
-a reference to an existing classpath
+<p>a reference to an existing classpath</p>
<h4>webapp</h4>
-Instructions to jasper to build an entire web application.
-The base directory must have a WEB-INF subdirectory beneath it.
-When used, the task hands off all dependency checking to the compiler.
-<table>
+<p>Instructions to Jasper to build an entire web application. The base directory must have
+a <samp>WEB-INF</samp> subdirectory beneath it. When used, the task hands off all dependency
+checking to the compiler.</p>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">basedir</td>
- <td valign="top">the base directory of the web application</td>
- <td valign="top" align="center">Yes</td>
+ <td>basedir</td>
+ <td>the base directory of the web application</td>
+ <td>Yes</td>
</tr>
</table>
<h3>Example</h3>
@@ -262,50 +220,39 @@ When used, the task hands off all dependency checking to the compiler.
compiler="jasper41"
verbose="9">
<include name="**/*.jsp"/>
-</jspc>
-</pre>
-Build all jsp pages under src/war into the destination /gensrc, in a
-package hierarchy beginning with com.i3sp.jsp.
+</jspc></pre>
+<p>Build all <samp>.jsp</samp> files under <samp>src/war</samp> into the
+destination <samp>/gensrc</samp>, in a package hierarchy beginning
+with <samp>com.i3sp.jsp</samp>.</p>
<pre>
-<jspc
- destdir="interim"
+<jspc destdir="interim"
verbose="1"
srcdir="src"
compiler="jasper41"
package="com.i3sp.jsp">
<include name="**/*.jsp"/>
</jspc>
-<depend
- srcdir="interim"
+<depend srcdir="interim"
destdir="build"
cache="build/dependencies"
classpath="lib/taglibs.jar"/>
-<javac
- srcdir="interim"
+<javac srcdir="interim"
destdir="build"
classpath="lib/taglibs.jar"
- debug="on"/>
-</pre>
-Generate jsp pages then javac them down to
-bytecodes. Include lib/taglib jar in the java compilation.
-Dependency checking is used to scrub the
-java files if class dependencies indicate it is needed.
+ debug="on"/></pre>
+<p>Generate <samp>.java</samp> files from <samp>.jsp</samp> files then <code>javac</code> them down
+to bytecodes. Include <samp>lib/taglibs.jar</samp> in the Java compilation. Dependency checking is
+used to scrub the <samp>.java</samp> files if class dependencies indicate it is needed.</p>
<h4>Notes</h4>
-<p>
-Using the <code>package</code> attribute it is possible to identify the resulting
-java files and thus do full dependency checking - this task should only rebuild
-java files if their jsp file has been modified. However, this only works
-with some versions of jasper. By default the checking supports tomcat 4.0.x
-with the "jasper" compiler, set the compiler to "jasper41" for the tomcat4.1.x
-dependency checking.
-Even when it does work, changes in
-.TLD imports or in compile time includes do not get picked up.
-</p>
-<p>
-Jasper generates JSP pages against the JSP1.2 specification -a copy of
-version 2.3 of the servlet specification is needed on the classpath to
-compile the Java code.
-</p>
+<p>Using the <var>package</var> attribute it is possible to identify the
+resulting <samp>.java</samp> files and thus do full dependency checking—this task should only
+rebuild <samp>.java</samp> files if their <samp>.jsp</samp> file has been modified. However, this
+only works with some versions of Jasper. By default the checking supports Tomcat 4.0.x with
+the <q>jasper</q> compiler, set the compiler to <q>jasper41</q> for the Tomcat 4.1.x dependency
+checking. Even when it does work, changes in <samp>.tld</samp> imports or in compile time includes
+do not get picked up.</p>
+<p>Jasper generates JSP pages against the JSP 1.2 specification—a copy of version 2.3 of the
+servlet specification is needed on the classpath to compile the Java code.</p>
</body>
</html>