http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/input.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/input.html b/manual/Tasks/input.html index b04affc..e0139c3 100644 --- a/manual/Tasks/input.html +++ b/manual/Tasks/input.html @@ -24,11 +24,11 @@ <body> -<h2><a name="input">Input</a></h2> +<h2 id="input">Input</h2> <h3>Description</h3> <p>Allows user interaction during the build process by prompting for -input. To do so, it uses the configured +input. To do so, it uses the configured <a href="../inputhandler.html">InputHandler</a>.</p> <p>The prompt can be set via the message attribute or as character @@ -42,7 +42,7 @@ one of the predefined.</p> user. This property can then be used during the following build run. Input behaves according to <a href="property.html">property task</a> which means that existing properties cannot be overridden. -Since Apache Ant 1.6, <code><input></code> will not prompt for input if +<em>Since Apache Ant 1.6</em>, <code><input></code> will not prompt for input if a property should be set by the task that has already been set in the project (and the task wouldn't have any effect).</p> @@ -50,8 +50,8 @@ project (and the task wouldn't have any effect).</p> characters to the console, this is a critical security defect, we must fix it immediately, etc, etc. This problem was due to the lack in early versions of Java of a (fully functional) facility for handling secure console input. -In Java 1.6 that shortcoming in Java's API was addressed and Ant versions 1.7.1 -and 1.8 have added support for Java 1.6's secure console input feature +In Java 6 that shortcoming in Java's API was addressed and Ant versions 1.7.1 +and 1.8 have added support for Java 6 secure console input feature (see <a href="#handler.type">handler type</a>).</p> <p> @@ -60,7 +60,7 @@ type it in. For this situation, place the password in a (secured) property file and load in before the input task.</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -101,16 +101,16 @@ file and load in before the input task.</p> <h4>Handler</h4> <p>Since <b>Ant 1.7</b>, a nested <handler> element can be used to specify an InputHandler, so that different InputHandlers may be used -among different Input tasks. +among different Input tasks.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <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"><a name="handler.type" />type</td> + <tr id="handler.type"> + <td valign="top">type</td> <td valign="top">one of "default","propertyfile", "greedy", or "secure" (since Ant 1.8). </td> <td align="center" valign="top" rowspan="3">One of these</td> @@ -142,7 +142,7 @@ among different Input tasks. <td valign="top">No</td> </tr> </table> -<br /> +<p> The classpath can also be specified by means of one or more nested <classpath> elements.</p> @@ -157,8 +157,7 @@ implementation you use.</p> continue..." and pause the build run until return key is pressed (again, the concrete behavior is implementation dependent).</p> <pre> <input - message="Press Return key to continue..." - /></pre> + message="Press Return key to continue..."/></pre> <p>Will display the message "Press Return key to continue..." and pause the build run until return key is pressed (see above).</p> @@ -166,8 +165,7 @@ continue..." and pause the build run until return key is pressed <input message="All data is going to be deleted from DB continue (y/n)?" validargs="y,n" - addproperty="do.delete" - /> + addproperty="do.delete"/> <condition property="do.abort"> <equals arg1="n" arg2="${do.delete}"/> </condition> @@ -179,20 +177,17 @@ exit build with following message "Build aborted by user.".</p> <pre> <input message="Please enter db-username:" - addproperty="db.user" - /></pre> + addproperty="db.user"/></pre> <p>Will display the message "Please enter db-username:" and set the property <code>db.user</code> to the value entered by the user.</p> <pre> <input message="Please enter db-username:" addproperty="db.user" - defaultvalue="Scott-Tiger" - /></pre> + defaultvalue="Scott-Tiger"/></pre> <p>Same as above, but will set <code>db.user</code> to the value <i>Scott- Tiger</i> if the user enters no value (simply types <return>).</p> - </body> </html>
http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jar.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jar.html b/manual/Tasks/jar.html index 6920eff..5ec3cfe 100644 --- a/manual/Tasks/jar.html +++ b/manual/Tasks/jar.html @@ -24,7 +24,7 @@ <body> -<h2><a name="jar">Jar</a></h2> +<h2 id="jar">Jar</h2> <h3>Description</h3> <p>Jars a set of files.</p> <p>The <i>basedir</i> attribute is the reference directory from where to jar.</p> @@ -91,12 +91,12 @@ to a value other than its default, <code>"add"</code>.</b></p> <p>To cryptographically sign your JAR file, use the <a href="signjar.html">SignJar task</a> on the JAR that you create from this task.</p> <p>For creating a simple version of a <a target="_blank" href="http://openjdk.java.net/jeps/238";>JEP-238 multi release jar</a>, -you don't need any special tools. Just set the required manifest entry and place the files where required, as you could see -in the <a href="#jep238-example">JEP238-example</a>. If you want to tune this kind of jar, e.g. decreasing the size by deleting -'same' classes from the versions-branches, you have to do more ...</p> +you don't need any special tools. Just set the required manifest entry and place the files where required, as you could see +in the <a href="#jep238-example">JEP238-example</a>. If you want to tune this kind of jar, e.g. decreasing the size by deleting +'same' classes from the versions-branches, you have to do more ...</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -203,9 +203,9 @@ in the <a href="#jep238-example">JEP238-example</a>. If you want to tune this ki </tr> <tr> <td valign="top">index</td> - <td valign="top">whether to create an <A - HREF="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index";>index - list</A> to speed up classloading. This is a JDK 1.3+ specific + <td valign="top">whether to create an <a + href="http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html#JAR_Index";>index + list</a> to speed up classloading. This is a JDK 1.3+ specific feature. Unless you specify additional jars with nested <a href="#indexjars"><code>indexjars</code></a> elements, only the contents of this jar will be included in the index. Defaults to @@ -263,7 +263,7 @@ in the <a href="#jep238-example">JEP238-example</a>. If you want to tune this ki <li><b>ignore</b> = logs a message on verbose level (default)</li> </ul> <em>Since Ant 1.7.1</em></td> - <td valign="top" align="center">No, defaults to <tt>ignore</tt>. </td> + <td valign="top" align="center">No, defaults to <tt>ignore</tt>.</td> </tr> <tr> <td valign="top">preserve0permissions</td> @@ -365,9 +365,9 @@ If the manifest values have changed the jar will be updated or rebuilt, as appropriate. </p> -<a name="indexjars"><h4>indexjars</h4></a> +<h4 id="indexjars">indexjars</h4> -<p><em>since ant 1.6.2</em></p> +<p><em>since Ant 1.6.2</em></p> <p>The nested <code>indexjars</code> element specifies a <a href="../using.html#path">PATH like structure</a>. Its content is @@ -393,9 +393,9 @@ depend on your manifest:</p> the <code>indexmetainf</code> attribute has been set to <code>true</code>.</p> -<a name="service"><h4>service</h4></a> +<h4 id="service">service</h4> -<p><em>since ant 1.7.0</em></p> +<p><em>since Ant 1.7.0</em></p> <p> The nested <code>service</code> element specifies a service. @@ -413,7 +413,7 @@ depend on your manifest:</p> "provider" nested elements. </p> <p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -439,8 +439,8 @@ depend on your manifest:</p> If a JAR file has more that one implementation of the service, a number of nested <provider> elements may be used. </p> - - + + <h3>Examples</h3> <h4>Simple</h4> @@ -453,8 +453,7 @@ called <code>app.jar</code> in the <code>${dist}/lib</code> directory.</p> <blockquote><pre> <jar destfile="${dist}/lib/app.jar" basedir="${build}/classes" - excludes="**/Test.class" - /></pre></blockquote> + excludes="**/Test.class"/></pre></blockquote> <p>jars all files in the <code>${build}/classes</code> directory into a file called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Files with the name <code>Test.class</code> are excluded.</p> @@ -462,8 +461,7 @@ with the name <code>Test.class</code> are excluded.</p> <blockquote><pre> <jar destfile="${dist}/lib/app.jar" basedir="${build}/classes" includes="mypackage/test/**" - excludes="**/Test.class" - /></pre></blockquote> + excludes="**/Test.class"/></pre></blockquote> <p>jars all files in the <code>${build}/classes</code> directory into a file called <code>app.jar</code> in the <code>${dist}/lib</code> directory. Only files under the directory <code>mypackage/test</code> are used, and files with @@ -472,8 +470,7 @@ the name <code>Test.class</code> are excluded.</p> <h4>Multiple filesets</h4> <blockquote><pre> <jar destfile="${dist}/lib/app.jar"> <fileset dir="${build}/classes" - excludes="**/Test.class" - /> + excludes="**/Test.class"/> <fileset dir="${src}/resources"/> </jar></pre></blockquote> <p>jars all files in the <code>${build}/classes</code> directory and also @@ -542,7 +539,7 @@ by Java).</p> </jar></pre></blockquote> <p> This is an example of an inline manifest specification including the version of the build -program (Implementation-Version). Note that the Built-By attribute will take the value of the Ant +program (Implementation-Version). Note that the Built-By attribute will take the value of the Ant property ${user.name}. The manifest produced by the above would look like this: </p> @@ -562,7 +559,7 @@ Sealed: false</code></pre></blockquote> <p> The following shows how to create a jar file specifying a service - with an implementation of the JDK6 scripting interface: + with an implementation of the JDK 6 scripting interface: </p> <blockquote><pre><jar destfile="pinky.jar"> <fileset dir="build/classes"/> @@ -575,7 +572,7 @@ Sealed: false</code></pre></blockquote> <p> The following shows how to create a jar file specifing a service - with two implementations of the JDK6 scripting interface: + with two implementations of the JDK 6 scripting interface: </p> <blockquote><pre> <jar destfile="pinkyandbrain.jar"> @@ -588,22 +585,21 @@ Sealed: false</code></pre></blockquote> </pre></blockquote> -<a name="jep238-example"/> -<h4>JEP238 example: a Multi-Release JAR Files</h4> +<h4 id="jep238-example">JEP238 example: a Multi-Release JAR Files</h4> <p> Here we want to create a <i>Multi-Release JAR File</i> according the specification <a target="_blank" href="http://openjdk.java.net/jeps/238";>JEP-238</a>. - It defines on top of a JAR the possibility to place additional or overwriting classes - in a jar, which are available according to the Java version you run.<br> - Basically it sais, that you have to set the manifest entry <tt>Multi-Release: true</tt> - and place all additional or overwriting classes in - <tt>META-INF/versions/<i>number</i>/package-structure</tt>, e.g. + It defines on top of a JAR the possibility to place additional or overwriting classes + in a jar, which are available according to the Java version you run.<br> + Basically it sais, that you have to set the manifest entry <tt>Multi-Release: true</tt> + and place all additional or overwriting classes in + <tt>META-INF/versions/<i>number</i>/package-structure</tt>, e.g. <tt>META-INF/versions/9/org/apache/ant/MyClass.class</tt> </p> <p> In this example we expect that the normal classes are compiled into - <code>${java.classes}</code> and the Java9 classes are compiled into - <code>${java9.classes}</code>. + <code>${java.classes}</code> and the Java 9 classes are compiled into + <code>${java9.classes}</code>. </p> <blockquote><pre> <jar destfile="mrjar.jar"> @@ -612,9 +608,9 @@ Sealed: false</code></pre></blockquote> <attribute name="Multi-Release" value="true"/> </manifest> <!-- directory structure according to the spec ... --> - <!-- ... default classes loadable by old (<Java9) versions --> + <!-- ... default classes loadable by old (<Java 9) versions --> <fileset dir="${java.classes}"/> - <!-- ... per release classes, require Java9+ for loadable via standard ClassLoader --> + <!-- ... per release classes, require Java 9+ for loadable via standard ClassLoader --> <zipfileset prefix="META-INF/versions/9/" dir="${java9.classes}"/> </jar> </pre></blockquote> http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jarlib-available.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jarlib-available.html b/manual/Tasks/jarlib-available.html index adb732f..6169855 100644 --- a/manual/Tasks/jarlib-available.html +++ b/manual/Tasks/jarlib-available.html @@ -24,7 +24,7 @@ <body> -<h2><a name="jarlib-available">jarlib-available</a></h2> +<h2 id="jarlib-available">jarlib-available</h2> <h3>Description</h3> <p>Check whether an extension is present in a fileset or an extensionSet. If the extension is present then a property is set.</p> @@ -39,7 +39,7 @@ Java Standard Edition package, in file Extension and ExtensionSet documentation</a> for further details</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -127,8 +127,5 @@ sets of files to check for extension.</p> </jarlib-available> </pre> - - </body> </html> - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jarlib-display.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jarlib-display.html b/manual/Tasks/jarlib-display.html index 0ddbaa3..1c9d139 100644 --- a/manual/Tasks/jarlib-display.html +++ b/manual/Tasks/jarlib-display.html @@ -24,7 +24,7 @@ <body> -<h2><a name="jarlib-display">jarlib-display</a></h2> +<h2 id="jarlib-display">jarlib-display</h2> <h3>Description</h3> <p>Display the "Optional Package" and "Package Specification" information contained within the specified jars.</p> @@ -39,7 +39,7 @@ Java Standard Edition package, in file Extension and ExtensionSet documentation</a> for further details</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -73,8 +73,5 @@ Extension and ExtensionSet documentation</a> for further details</p> </jarlib-display> </pre> - - </body> </html> - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jarlib-manifest.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jarlib-manifest.html b/manual/Tasks/jarlib-manifest.html index 019b554..e2f5bda 100644 --- a/manual/Tasks/jarlib-manifest.html +++ b/manual/Tasks/jarlib-manifest.html @@ -24,7 +24,7 @@ <body> -<h2><a name="jarlib-manifest">jarlib-manifest</a></h2> +<h2 id="jarlib-manifest">jarlib-manifest</h2> <h3>Description</h3> <p>Task to generate a manifest that declares all the dependencies in manifest. The dependencies are determined by looking in the @@ -41,7 +41,7 @@ Java Standard Edition package, in file Extension and ExtensionSet documentation</a> for further details</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -116,8 +116,5 @@ Extension and ExtensionSet documentation</a> for further details</p> </jarlib-manifest> </pre> - - </body> </html> - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jarlib-resolve.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jarlib-resolve.html b/manual/Tasks/jarlib-resolve.html index 2ef4f87..cfb5f5b 100644 --- a/manual/Tasks/jarlib-resolve.html +++ b/manual/Tasks/jarlib-resolve.html @@ -24,7 +24,7 @@ <body> -<h2><a name="jarlib-resolve">jarlib-resolve</a></h2> +<h2 id="jarlib-resolve">jarlib-resolve</h2> <h3>Description</h3> <p>Try to locate a jar to satisfy an extension and place location of jar into property. The task allows you to @@ -38,13 +38,13 @@ works with extensions as defined by the "Optional Package" specification. For more information about optional packages, see the document <em>Optional Package Versioning</em> in the documentation bundle for your -Java2 Standard Edition package, in file +Java Standard Edition package, in file <code>guide/extensions/versioning.html</code> or the online <a target="_blank" href="http://docs.oracle.com/javase/7/docs/technotes/guides/extensions/versioning.html";> Extension and ExtensionSet documentation</a> for further details</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -76,7 +76,7 @@ Extension and ExtensionSet documentation</a> for further details</p> <h4>location</h4> <p>The location sub element allows you to look for a library in a location relative to project directory.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -92,7 +92,7 @@ Extension and ExtensionSet documentation</a> for further details</p> <h4>url</h4> <p>The url resolver allows you to download a library from a URL to a local file.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -119,7 +119,7 @@ Extension and ExtensionSet documentation</a> for further details</p> <h4>ant</h4> <p>The ant resolver allows you to run an Apache Ant build file to generate a library.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -204,8 +204,5 @@ Extension and ExtensionSet documentation</a> for further details</p> </jarlib-resolve> </pre> - - </body> </html> - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/java.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/java.html b/manual/Tasks/java.html index 36d50ce..880243d 100644 --- a/manual/Tasks/java.html +++ b/manual/Tasks/java.html @@ -24,7 +24,7 @@ <body> -<h2><a name="java">Java</a></h2> +<h2 id="java">Java</h2> <h3>Description</h3> <p>Executes a Java class within the running (Apache Ant) VM or forks another VM if specified.</p> @@ -36,8 +36,7 @@ JVM. sending input to it via the <code>input</code> and <code>inputstring</code> attributes.</p> -<h4><a name="background">Running Ant as a background process on - Unix(-like) systems</a></h4> +<h4 id="background">Running Ant as a background process on Unix(-like) systems</h4> <p>If you run Ant as a background process (like <code>ant &</code>) and use the <code><java></code> task with <code>spawn</code> @@ -47,14 +46,14 @@ attributes.</p> standard input.</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <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"><a name="classname">classname</a></td> + <tr id="classname"> + <td valign="top">classname</td> <td valign="top">the Java class to execute.</td> <td align="center" valign="top">Either <tt>jar</tt>, <tt>classname</tt> or <tt>module</tt></td> </tr> @@ -92,7 +91,7 @@ attributes.</p> </tr> <tr> <td valign="top">spawn</td> - <td valign="top">if enabled allows to start a process which will outlive ant.<br> + <td valign="top">if enabled allows to start a process which will outlive Ant.<br> Requires fork=true, and not compatible with timeout, input, output, error, result attributes.<br> (disabled by default)</td> @@ -166,7 +165,7 @@ attributes.</p> <tr> <td valign="top">error</td> <td valign="top">The file to which the standard error of the command should be - redirected. </td> + redirected.</td> <td align="center" valign="top">No</td> </tr> <tr> @@ -287,7 +286,7 @@ and treated like indicated in <i>failonerror</i>.</p> <p>Note:<br> If you do not specify permissions, a set of default permissions will be added to your Java invocation to make -sure that the ant run will continue or terminated as indicated by +sure that the Ant run will continue or terminated as indicated by <i>failonerror</i>. All permissions not granted per default will be checked by whatever security manager was already in place. exitVM will be disallowed. @@ -306,20 +305,20 @@ subelement.</p> <p><em>since Ant 1.6.</em></p> -<a name="redirector"><h4>redirector</h4></a> -<i><b>Since Ant 1.6.2</b></i> +<h4 id="redirector">redirector</h4> +<em>Since Ant 1.6.2</em> <p>A nested <a href="../Types/redirector.html">I/O Redirector</a> can be specified. In general, the attributes of the redirector behave as the corresponding attributes available at the task level. The most notable peculiarity stems from the retention of the <code><java></code> attributes for backwards compatibility. Any file mapping is done -using a <CODE>null</CODE> sourcefile; therefore not all +using a <code>null</code> sourcefile; therefore not all <a href="../Types/mapper.html">Mapper</a> types will return results. When no results are returned, redirection specifications will fall back to the task level attributes. In practice this means that defaults can be specified for input, output, and error output files. </p> -<a name="failonerror"><h3>Errors and return codes</h3></a> +<h3 id="failonerror">Errors and return codes</h3> By default the return code of a <code><java></code> is ignored. Alternatively, you can set <code>resultproperty</code> to the name of a property and have it assigned to the result code (barring immutability, @@ -327,22 +326,21 @@ of course). When you set <code>failonerror="true"</code>, the only possible value for <code>resultproperty</code> is 0. Any non-zero response is treated as an error and would mean the build exits. -<p> Similarly, if <code>failonerror="false"</code> and <code>fork="false"</code> -, then <code><java></code> <b>must</b> return 0 otherwise the build will +<p>Similarly, if <code>failonerror="false"</code> and <code>fork="false"</code>, +then <code><java></code> <b>must</b> return 0 otherwise the build will exit, as the class was run by the build JVM.</p> -<a name="modulepath"><h4>modulepath</h4> -<i><b>Since Ant 1.9.7</b></i> +<h4 id="modulepath">modulepath</h4> +<em>Since Ant 1.9.7</em> <p><code>Java</code>'s <i>modulepath</i> attribute is a <a href="../using.html#path">PATH like structure</a> and can also be set via a nested <i>modulepath</i> element.</p> -<a name="upgrademodulepath"><h4>upgrademodulepath</h4> -<i><b>Since Ant 1.9.7</b></i> +<h4 id="upgrademodulepath">upgrademodulepath</h4> +<em>Since Ant 1.9.7</em> <p>The location of modules that replace upgradeable modules in the runtime image can be specified using this <a href="../using.html#path">PATH like structure</a>.</p> - <h3>JAR file execution</h3> <p>The parameter of the <tt>jar</tt> attribute is of type <tt>File</tt>; @@ -351,9 +349,9 @@ base directory of the project, <i>not</i> the directory in which the Java task is run. If you need to locate a JAR file relative to the directory the task will be run in, you need to explicitly create the full path to the JAR file.</p> -<p>When using the <tt>jar</tt> attribute, all classpath settings are +<p>When using the <tt>jar</tt> attribute, all classpath settings are ignored according to <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/java.html";>Oracle's -specification</a>. +specification</a>. <h3>Examples</h3> http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/javac.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/javac.html b/manual/Tasks/javac.html index 3662402..045e1a3 100644 --- a/manual/Tasks/javac.html +++ b/manual/Tasks/javac.html @@ -14,7 +14,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -<html lang="en-us"> +<html> <head> <meta http-equiv="Content-Language" content="en-us"> @@ -24,7 +24,7 @@ <body> -<h2><a name="javac">Javac</a></h2> +<h2 id="javac">Javac</h2> <h3>Description</h3> <p>Compiles a Java source tree.</p> <p>The source and destination directory will be recursively scanned for Java @@ -57,7 +57,7 @@ element(s), or by using wildcard patterns. See the section on <a href="../dirtasks.html#directorybasedtasks">directory-based tasks</a>, for information on how the inclusion/exclusion of files works, and how to write wildcard patterns.</p> -<p>It is possible to use different compilers. This can be specified by +<p id="compilervalues">It is possible to use different compilers. This can be specified by either setting the global <code>build.compiler</code> property, which will affect all <code><javac></code> tasks throughout the build, by setting the <code>compiler</code> attribute, specific to the current @@ -65,9 +65,9 @@ setting the <code>compiler</code> attribute, specific to the current <a href="typedef.html">typedef</a>fed or <a href="componentdef.html">componentdef</a>fed type that implements <code>org.apache.tools.ant.taskdefs.compilers.CompilerAdapter</code>. -<a name="compilervalues">Valid values for either the +Valid values for either the <code>build.compiler</code> property or the <code>compiler</code> -attribute are:</a></p> +attribute are:</p> <ul> <li><code>classic</code> (the standard compiler of JDK 1.1/1.2) – <code>javac1.1</code> and @@ -106,7 +106,7 @@ classname in the <code>build.compiler</code> property or the </p> <p>The fork attribute overrides the <code>build.compiler</code> property or <code>compiler</code> attribute setting and -expects a JDK1.1 or higher to be set in <code>JAVA_HOME</code>. +expects a JDK 1.1 or higher to be set in <code>JAVA_HOME</code>. </p> <p>You can also use the <code>compiler</code> attribute to tell Ant which JDK version it shall assume when it puts together the command @@ -136,7 +136,7 @@ invoking the compiler.</p> corresponding <code>.java</code> file the file will not get compiled even if a native header file generated for it would be outdated.</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -299,7 +299,8 @@ invoking the compiler.</p> <td align="center" valign="top">No</td> </tr> <tr> - <td valign="top">depend</td> <td valign="top">Enables dependency-tracking + <td valign="top">depend</td> + <td valign="top">Enables dependency-tracking for compilers that support this (<code>jikes</code> and <code>classic</code>).</td> <td align="center" valign="top">No</td> @@ -424,7 +425,7 @@ invoking the compiler.</p> <tr> <td valign="top">updatedProperty</td> <td valign="top"> - The property to set (to the value "true") + The property to set (to the value "true") if compilation has taken place and has been successful. <em>Since Ant 1.7.1</em>. @@ -568,7 +569,7 @@ are specified like <a href="../using.html#arg">Command-line Arguments</a> but have an additional attribute that can be used to enable arguments only if a given compiler implementation will be used.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td width="12%" valign="top"><b>Attribute</b></td> <td width="78%" valign="top"><b>Description</b></td> @@ -630,8 +631,7 @@ used.</p> destdir="${build}" classpath="xyz.jar" debug="on" - source="1.4" - /></pre> + source="1.4"/></pre> <p>compiles all <code>.java</code> files under the <code>${src}</code> directory, and stores the <code>.class</code> files in the <code>${build}</code> directory. @@ -643,8 +643,7 @@ so you can use <code>assert</code> statements.</p> destdir="${build}" fork="true" source="1.2" - target="1.2" - /></pre> + target="1.2"/></pre> <p>compiles all <code>.java</code> files under the <code>${src}</code> directory, and stores the <code>.class</code> files in the <code>${build}</code> directory. This will fork off the javac @@ -655,8 +654,7 @@ the class files should be runnable under JDK 1.2+ as well.</p> <pre> <javac srcdir="${src}" destdir="${build}" fork="java$$javac.exe" - source="1.5" - /></pre> + source="1.5"/></pre> <p>compiles all <code>.java</code> files under the <code>${src}</code> directory, and stores the <code>.class</code> files in the <code>${build}</code> directory. This will fork off the javac @@ -669,8 +667,7 @@ The source level is 1.5, so you can use generics.</p> includes="mypackage/p1/**,mypackage/p2/**" excludes="mypackage/p1/testpackage/**" classpath="xyz.jar" - debug="on" - /></pre> + debug="on"/></pre> <p>compiles <code>.java</code> files under the <code>${src}</code> directory, and stores the <code>.class</code> files in the <code>${build}</code> directory. @@ -686,8 +683,7 @@ so the actual values used will depend on which JDK you ran Ant with.</p> includes="mypackage/p1/**,mypackage/p2/**" excludes="mypackage/p1/testpackage/**" classpath="xyz.jar" - debug="on" - /></pre> + debug="on"/></pre> <p>is the same as the previous example, with the addition of a second source path, defined by @@ -715,10 +711,9 @@ Java VM of a different version:</p> destdir="${build}" fork="yes" executable="/opt/java/jdk1.1/bin/javac" - compiler="javac1.1" - /></pre> + compiler="javac1.1"/></pre> -<p><a name="srcdirnote"><b>Note:</b></a> +<p id="srcdirnote"><b>Note:</b> If you wish to compile only source files located in certain packages below a common root, use the <code>include</code>/<code>exclude</code> attributes or <code><include></code>/<code><exclude></code> nested elements @@ -732,13 +727,13 @@ for additional information.</p> <p> If you wish to compile only files explicitly specified and disable javac's default searching mechanism then you can unset the sourcepath -attribute: +attribute:</p> <pre> <javac sourcepath="" srcdir="${src}" destdir="${build}" > <include name="**/*.java"/> <exclude name="**/Example.java"/> </javac></pre> -That way the javac will compile all java source files under "${src}" +<p>That way the javac will compile all java source files under "${src}" directory but skip the examples. The compiler will even produce errors if some of the non-example files refers to them. </p> @@ -746,14 +741,12 @@ the non-example files refers to them. <p> If you wish to compile with a special JDK (another than the one Ant is currently using), set the <code>executable</code> and <code>fork</code> attribute. Using <code>taskname</code> -could show in the log, that these settings are fix. -<pre> <javac srcdir="" +could show in the log, that these settings are fix.</p> +<pre> <javac srcdir="" destdir="" - executable="path-to-java14-home/bin/javac" + executable="path-to-java14-home/bin/javac" fork="true" - taskname="javac1.4" /></pre> -</p> - + taskname="javac1.4"/></pre> <p><b>Note:</b> If you are using Ant on Windows and a new DOS window pops up for every use of an external compiler, this may be a problem of the JDK you are @@ -762,13 +755,12 @@ using. This problem may occur with all JDKs < 1.2.</p> <p> If you want to activate other compiler options like <i>lint</i> you could use -the <tt><compilerarg></tt> element: +the <tt><compilerarg></tt> element:</p> <pre> <javac srcdir="${src.dir}" destdir="${classes.dir}" classpathref="libraries"> <compilerarg value="-Xlint"/> - </javac> </pre> -</p> + </javac></pre> <p>If you want to use a custom CompilerAdapter <code>org.example.MyAdapter</code> you can either @@ -776,8 +768,7 @@ the <tt><compilerarg></tt> element: <pre> <javac srcdir="${src.dir}" destdir="${classes.dir}" - compiler="org.example.MyAdapter"/> -</pre> + compiler="org.example.MyAdapter"/></pre> <p>or a define a type and nest this into the task like in:</p> <pre> <componentdef classname="org.example.MyAdapter" @@ -794,8 +785,7 @@ the <tt><compilerarg></tt> element: destdir="${build}" includeantruntime="false" modulepath="modules" - source="9" - /></pre> + source="9"/></pre> <p>compiles all <code>.java</code> files in a single module under the <code>${src}</code> directory, and stores the <code>.class</code> files in the <code>${build}</code> directory. The compilation uses application modules located in <code>modules</code> folder.The source level is <code>9</code> to enable modules.</p> @@ -804,8 +794,7 @@ the <tt><compilerarg></tt> element: destdir="${build}" includeantruntime="false" modulepath="modules" - source="9" - /></pre> + source="9"/></pre> <p>compiles all <code>.java</code> files in <code>gen/classes</code>, <code>lin32/classes</code> and <code>lin64/classes</code> in all source modules under the <code>${src}</code> directory. Generates module directories in the <code>${build}</code> directory. Each generated module directory under @@ -831,7 +820,7 @@ interpreted as anything other than false. By default, <code>build.compiler.warnings</code> is <code>true</code>, while all others are <code>false</code>.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Property</b></td> <td valign="top"><b>Description</b></td> @@ -893,7 +882,7 @@ while all others are <code>false</code>.</p> <code>build.compiler.jvc.extensions</code> to false before invoking <code><javac></code>.</p> -<h3><a name="bootstrap">Bootstrap Options</h3> +<h3 id="bootstrap">Bootstrap Options</h3> <p> The Sun javac compiler has a <em>bootclasspath</em> command line option - this corresponds to the "bootclasspath" attribute/element @@ -913,9 +902,6 @@ while all others are <code>false</code>.</p> </javac> </pre> - -</p> - <h3>OpenJDK Notes</h3> <p> The <a href="https://openjdk.dev.java.net/";>openjdk</a> @@ -945,7 +931,7 @@ while all others are <code>false</code>.</p> <h3>Note on package-info.java</h3> <p> - <code>package-info.java</code> files were introduced in Java5 to + <code>package-info.java</code> files were introduced in Java 5 to allow package level annotations. On compilation, if the java file does not contain runtime annotations, there will be no .class file for the java file. Up to <b>Ant 1.7.1</b>, when the <javac> http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/javacc.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/javacc.html b/manual/Tasks/javacc.html index 3c0dcfa..0dba9cd 100644 --- a/manual/Tasks/javacc.html +++ b/manual/Tasks/javacc.html @@ -24,10 +24,10 @@ <body> -<h2><a name="javacc">JavaCC</a></h2> +<h2 id="javacc">JavaCC</h2> <h3>Description</h3> <p> - Invokes the <a HREF="http://javacc.dev.java.net/"; target="_top">JavaCC</a> compiler + Invokes the <a href="http://javacc.dev.java.net/"; target="_top">JavaCC</a> compiler compiler on a grammar file. </p> <p> @@ -48,7 +48,7 @@ </p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -194,8 +194,7 @@ target="src/Parser.jj" outputdirectory="build/src" javacchome="c:/program files/JavaCC" - static="true" -/> + static="true"/> </pre></blockquote> <p> This invokes JavaCC on grammar file src/Parser.jj, writing the generated @@ -203,8 +202,5 @@ invoking JavaCC. </p> - </body> </html> - - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/javadoc.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/javadoc.html b/manual/Tasks/javadoc.html index 430435f..390d893 100644 --- a/manual/Tasks/javadoc.html +++ b/manual/Tasks/javadoc.html @@ -24,7 +24,7 @@ <body> -<h2><a name="javadoc">Javadoc/<i>Javadoc2</i></a></h2> +<h2 id="javadoc">Javadoc/<i>Javadoc2</i></h2> <h3>Description</h3> <p>Generates code documentation using the javadoc tool.</p> <p>The source directory will be recursively scanned for Java source files to process @@ -81,7 +81,7 @@ to <javadoc> using <tt>classpath</tt>, <tt>classpathref</tt> attributes or with the exclude patterns of the packageset (and vice versa).</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -523,8 +523,8 @@ to <javadoc> using <tt>classpath</tt>, <tt>classpathref</tt> attributes or order to mitigate CVE-2013-1571. Defaults to true. <em>Since Ant 1.9.2</em><br> There is a frame injection attack possible in javadocs generated by Oracle - JDKs prior to Java7 Update 25 (<a href="http://www.oracle.com/technetwork/java/javase/7u25-relnotes-1955741.html#jpi-upt"; target="_blank">details</a>). - When this flag is set to true, Ant will check whether the docs are vulnerable + JDKs prior to Java 7 update 25 (<a href="http://www.oracle.com/technetwork/java/javase/7u25-relnotes-1955741.html#jpi-upt"; target="_blank">details</a>). + When this flag is set to true, Ant will check whether the docs are vulnerable and will try to fix them. </td> <td align="center" valign="top">1.4</td> @@ -532,7 +532,7 @@ to <javadoc> using <tt>classpath</tt>, <tt>classpathref</tt> attributes or </tr> </table> -<h4><a name="groupattribute">Format of the group attribute</a></h4> +<h4 id="groupattribute">Format of the group attribute</h4> <p>The arguments are comma-delimited. Each single argument is 2 space-delimited strings, where the first one is the group's title and the second one a colon delimited list of packages.</p> @@ -588,7 +588,7 @@ javadoc as source files.</p> <p>Same as one entry in the list given by <code>packagenames</code>.</p> <h5>Parameters</h5> -<table width="90%" border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -611,7 +611,7 @@ Same as for <code>package</code>. <p>Same as one entry in the list given by <code>sourcefiles</code>.</p> <h5>Parameters</h5> -<table width="90%" border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -651,7 +651,7 @@ syntax (or both at once), but with the nested elements you can easily specify multiple occurrences of the arguments.</p> <h5>Parameters</h5> -<table width="90%" border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -692,7 +692,7 @@ specify multiple occurrences of the arguments.</p> </tr> </table> -<h4><a name="groupelement">group</a></h4> +<h4 id="groupelement">group</h4> <p>Separates packages on the overview page into whatever groups you specify, one group per table. This performs the same role as the group attribute. You can use either syntax (or both at once), but with the @@ -700,7 +700,7 @@ nested elements you can easily specify multiple occurrences of the arguments.</p> <h5>Parameters</h5> -<table width="90%" border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -745,14 +745,14 @@ of the doclet element is shown below:</p> </javadoc> </pre> -<h4><a name="tagelement">tag</a></h4> +<h4 id="tagelement">tag</h4> <p>If you want to specify a standard tag using a nested tag element because you want to determine the order the tags are output, you must not set the description attribute for those tags.</p> <h5>Parameters</h5> -<table width="90%" border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -803,12 +803,12 @@ the javadoc program. </tr> </table> -<h4><a name="tagletelement">taglet</a></h4> +<h4 id="tagletelement">taglet</h4> <p>The taglet nested element is used to specify custom <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html";>taglets</a> beyond <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags"; target="_blank">the default taglets</a>.</p> <h5>Parameters</h5> -<table width="90%" border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -908,8 +908,5 @@ arguments</a>. <em>Since Ant 1.6</em></p> <link href="http://docs.oracle.com/javase/7/docs/api/"/> </javadoc></pre> - - </body> </html> - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/javah.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/javah.html b/manual/Tasks/javah.html index 088b6e8..82de03b 100644 --- a/manual/Tasks/javah.html +++ b/manual/Tasks/javah.html @@ -24,13 +24,13 @@ <body> -<h2><a name="javah">Javah</a></h2> +<h2 id="javah">Javah</h2> <h3>Description</h3> <p>Generates JNI headers from a Java class.</p> -<p> When this task executes, it will generate the C header and source files that +<p>When this task executes, it will generate the C header and source files that are needed to implement native methods. JNI operates differently depending on -whether <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javah.html";>JDK1.2+</a> -or <a href="http://java.sun.com/products/jdk/1.1/docs/tooldocs/win32/javah.html";>pre-JDK1.2</a> +whether <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javah.html";>JDK 1.2+</a> +or <a href="http://java.sun.com/products/jdk/1.1/docs/tooldocs/win32/javah.html";>pre-1.2 JDK</a> systems are used.</p> <p>If you are building with Java 8 or above consider @@ -39,12 +39,13 @@ systems are used.</p> generate the native header files with a single step.</p> <p><b>Note</b> the <code>javah</code> has been deprecated as of Java 9 - and removed as of Java 10. Trying to use it with Java10 will + and removed as of Java 10. Trying to use it with Java 10 will fail.</p> -<p>It is possible to use different compilers. This can be selected -with the <code>implementation</code> attribute or a nested element. <a -name="implementationvalues">Here are the choices of the attribute</a>:</p> +<p id="implementationvalues">It is possible to use different +compilers. This can be selected with the <code>implementation</code> +attribute or a nested element. Here are the choices of the +attribute:</p> <ul> <li>default - the default compiler for the platform.</li> <li>sun (the standard compiler of the JDK)</li> @@ -64,7 +65,7 @@ name="implementationvalues">Here are the choices of the attribute</a>:</p> breaking the amount of classes to compile into smaller chunks.</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -88,13 +89,13 @@ name="implementationvalues">Here are the choices of the attribute</a>:</p> </tr> <tr> <td valign="top">force</td> - <td valign="top">specifies that output files should always be written (JDK1.2 only)</td> + <td valign="top">specifies that output files should always be written (JDK 1.2 only)</td> <td valign="top" align="center">No</td> </tr> <tr> <td valign="top">old</td> - <td valign="top">specifies that old JDK1.0-style header files should be generated - (otherwise output file contain JNI-style native method function prototypes) (JDK1.2 only)</td> + <td valign="top">specifies that old JDK 1.0-style header files should be generated + (otherwise output file contain JNI-style native method function prototypes) (JDK 1.2 only)</td> <td valign="top" align="center">No</td> </tr> <tr> @@ -143,7 +144,7 @@ specified like <a href="../using.html#arg">Command-line Arguments</a> but have an additional attribute that can be used to enable arguments only if a given compiler implementation will be used.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td width="12%" valign="top"><b>Attribute</b></td> <td width="78%" valign="top"><b>Description</b></td> @@ -201,7 +202,7 @@ only if a given compiler implementation will be used.</p> <h3>Examples</h3> <pre> <javah destdir="c" class="org.foo.bar.Wibble"/></pre> -<p>makes a JNI header of the named class, using the JDK1.2 JNI model. Assuming +<p>makes a JNI header of the named class, using the JDK 1.2 JNI model. Assuming the directory 'c' already exists, the file <tt>org_foo_bar_Wibble.h</tt> is created there. If this file already exists, it is left unchanged.</p> <pre> <javah outputFile="wibble.h"> @@ -251,5 +252,4 @@ describe its progress.</p> nested elements of its own.</p> </body> - </html> http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jdepend.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jdepend.html b/manual/Tasks/jdepend.html index 7a9639d..9b30e81 100644 --- a/manual/Tasks/jdepend.html +++ b/manual/Tasks/jdepend.html @@ -14,27 +14,24 @@ See the License for the specific language governing permissions and limitations under the License. --> -<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> - <html> <head> <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> -<title>JDepend Task</title> - <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>JDepend Task</title> <meta http-equiv="Content-Language" content="en-us"> </head> <body> -<h2><a NAME="JDepend"></a>JDepend</h2> +<h2 id="jdepend">JDepend</h2> <h3>Description</h3> -<P>Invokes the <a href="http://www.clarkware.com/software/JDepend.html";>JDepend</a> parser.</P> +<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". +<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> +effectively manage and control package dependencies."</p> <p>Source file directories are defined by nested <code><sourcespath></code>; Class file directories are defined @@ -43,68 +40,68 @@ 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> The task requires at least the JDepend 1.2 version. </p> +<p>The task requires at least the JDepend 1.2 version.</p> <h3>Parameters</h3> -<table BORDER=1 CELLSPACING=0 CELLPADDING=2 > +<table> <tr> - <td VALIGN=TOP><b>Attribute</b></td> - <td VALIGN=TOP><b>Description</b></td> - <td ALIGN=CENTER VALIGN=TOP><b>Required</b></td> + <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>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 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> </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 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> </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 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> </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 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> </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 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> </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 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> </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 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> </tr> <tr> - <td VALIGN=TOP>includeruntime</td> - <td VALIGN=TOP>Implicitly add the classes required to run jdepend + <td valign="top">includeruntime</td> + <td valign="top">Implicitly add the classes required to run jdepend in forked mode. (Ignored if fork is disabled). Since Apache Ant 1.6.</td> - <td ALIGN=CENTER VALIGN=TOP>No, default is "no".</td> + <td align="center" valign="top">No, default is "no".</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 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> </tr> </table> -<h3><a name="nested">Nested Elements</a></h3> +<h3 id="nested">Nested Elements</h3> <p><code>jdepend</code> supports four nested elements: -<code><classpath>, <classespath> </code> and +<code><classpath>, <classespath></code> and <code><sourcespath></code>, that represent <a href="../using.html#path">PATH like structures</a>, and <code><exclude></code>.</p> @@ -127,7 +124,6 @@ to ignore (requires JDepend 2.5 or above).</p> <pathelement location="build"/> </classespath> </jdepend> - </pre> </blockquote> @@ -152,7 +148,7 @@ classpath reference.</p> <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 -classpath is defined using nested elements. </p> +classpath is defined using nested elements.</p> <blockquote> <pre> @@ -170,8 +166,5 @@ classpath is defined using nested elements. </p> files to analyze, and will ignore all classes in the java.* and javax.* packages.</p> - </body> </html> - - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jjdoc.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jjdoc.html b/manual/Tasks/jjdoc.html index 52b9225..f3721b5 100644 --- a/manual/Tasks/jjdoc.html +++ b/manual/Tasks/jjdoc.html @@ -14,18 +14,15 @@ See the License for the specific language governing permissions and limitations under the License. --> -<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> <html> <head> - <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us"> <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> <title>JJDoc Task</title> </head> <body> -<h2> -<a NAME="jjtree"></a>JJDoc</h2> +<h2 id="jjtree">JJDoc</h2> <p><em>Since Apache Ant 1.6</em></p> <h3>Description</h3> @@ -36,7 +33,7 @@ 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 +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> @@ -45,55 +42,55 @@ generated BNF documentation file.</p> <h3>Parameters</h3> -<table BORDER CELLSPACING=0 CELLPADDING=2 > +<table> <tr> -<td VALIGN=TOP><b>Attribute</b></td> +<td valign="top"><b>Attribute</b></td> -<td VALIGN=TOP><b>Description</b></td> +<td valign="top"><b>Description</b></td> -<td ALIGN=CENTER VALIGN=TOP><b>Required</b></td> +<td align="center" valign="top"><b>Required</b></td> </tr> <tr> -<td VALIGN=TOP>target</td> +<td valign="top">target</td> -<td VALIGN=TOP>The javacc grammar file to process.</td> +<td valign="top">The javacc grammar file to process.</td> -<td ALIGN=CENTER VALIGN=TOP>Yes</td> +<td align="center" valign="top">Yes</td> </tr> <tr> -<td VALIGN=TOP>javacchome</td> +<td valign="top">javacchome</td> -<td VALIGN=TOP>The directory containing the JavaCC distribution.</td> +<td valign="top">The directory containing the JavaCC distribution.</td> -<td ALIGN=CENTER VALIGN=TOP>Yes</td> +<td align="center" valign="top">Yes</td> </tr> <tr> -<td VALIGN=TOP>outputfile</td> +<td valign="top">outputfile</td> -<td VALIGN=TOP>The file to write the generated BNF documentation file to. If not set, +<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 align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>text</td> +<td valign="top">text</td> -<td VALIGN=TOP>Sets the TEXT BNF documentation option. This is a boolean +<td valign="top">Sets the TEXT BNF documentation option. This is a boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>onetable</td> +<td valign="top">onetable</td> -<td VALIGN=TOP>Sets the ONE_TABLE BNF documentation option. This is a boolean option.</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 align="center" valign="top">No</td> </tr> <tr> @@ -108,16 +105,13 @@ option.</td> Example</h3> <blockquote> -<pre><jjdoc - target="src/Parser.jj" +<pre><jjdoc + target="src/Parser.jj" outputfile="doc/ParserBNF.html" - javacchome="c:/program files/JavaCC" -/></pre> + javacchome="c:/program files/JavaCC"/></pre> </blockquote> This invokes JJDoc on grammar file src/Parser.jj, writing the generated BNF documentation file, ParserBNF.html, file to doc. -<br> </body> </html> - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jjtree.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jjtree.html b/manual/Tasks/jjtree.html index 7fbb2a9..70529bb 100644 --- a/manual/Tasks/jjtree.html +++ b/manual/Tasks/jjtree.html @@ -14,21 +14,17 @@ See the License for the specific language governing permissions and limitations under the License. --> -<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> <html> <head> - <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us"> <link rel="stylesheet" type="text/css" href="../stylesheets/style.css"> <title>JJTree Task</title> </head> <body> -<h2> -<a NAME="jjtree"></a>JJTree</h2> +<h2 id="jjtree">JJTree</h2> -<h3> -Description</h3> +<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 @@ -49,143 +45,143 @@ generated JavaCC file.</p> <h3>Parameters</h3> -<table BORDER CELLSPACING=0 CELLPADDING=2 > +<table> <tr> -<td VALIGN=TOP><b>Attribute</b></td> +<td valign="top"><b>Attribute</b></td> -<td VALIGN=TOP><b>Description</b></td> +<td valign="top"><b>Description</b></td> -<td ALIGN=CENTER VALIGN=TOP><b>Required</b></td> +<td align="center" valign="top"><b>Required</b></td> </tr> <tr> -<td VALIGN=TOP>target</td> +<td valign="top">target</td> -<td VALIGN=TOP>The jjtree grammar file to process.</td> +<td valign="top">The jjtree grammar file to process.</td> -<td ALIGN=CENTER VALIGN=TOP>Yes</td> +<td align="center" valign="top">Yes</td> </tr> <tr> -<td VALIGN=TOP>javacchome</td> +<td valign="top">javacchome</td> -<td VALIGN=TOP>The directory containing the JavaCC distribution.</td> +<td valign="top">The directory containing the JavaCC distribution.</td> -<td ALIGN=CENTER VALIGN=TOP>Yes</td> +<td align="center" valign="top">Yes</td> </tr> <tr> -<td VALIGN=TOP>outputdirectory</td> +<td valign="top">outputdirectory</td> -<td VALIGN=TOP>The directory to write the generated JavaCC grammar and node files to. +<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 align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>outputfile</td> +<td valign="top">outputfile</td> -<td VALIGN=TOP>The file to write the generated JavaCC grammar file +<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 align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>buildnodefiles</td> +<td valign="top">buildnodefiles</td> -<td VALIGN=TOP>Sets the BUILD_NODE_FILES grammar option. This is a boolean +<td valign="top">Sets the BUILD_NODE_FILES grammar option. This is a boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>multi</td> +<td valign="top">multi</td> -<td VALIGN=TOP>Sets the MULTI grammar option. This is a boolean option.</td> +<td valign="top">Sets the MULTI grammar option. This is a boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>nodedefaultvoid</td> +<td valign="top">nodedefaultvoid</td> -<td VALIGN=TOP>Sets the NODE_DEFAULT_VOID grammar option. This is a boolean +<td valign="top">Sets the NODE_DEFAULT_VOID grammar option. This is a boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>nodefactory</td> +<td valign="top">nodefactory</td> -<td VALIGN=TOP>Sets the NODE_FACTORY grammar option. This is boolean option.</td> +<td valign="top">Sets the NODE_FACTORY grammar option. This is boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>nodescopehook</td> +<td valign="top">nodescopehook</td> -<td VALIGN=TOP>Sets the NODE_SCOPE_HOOK grammar option. This is a boolean +<td valign="top">Sets the NODE_SCOPE_HOOK grammar option. This is a boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>nodeusesparser</td> +<td valign="top">nodeusesparser</td> -<td VALIGN=TOP>Sets the NODE_USES_PARSER grammar option. This is a boolean +<td valign="top">Sets the NODE_USES_PARSER grammar option. This is a boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>static</td> +<td valign="top">static</td> -<td VALIGN=TOP>Sets the STATIC grammar option. This is a boolean option.</td> +<td valign="top">Sets the STATIC grammar option. This is a boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>visitor</td> +<td valign="top">visitor</td> -<td VALIGN=TOP>Sets the VISITOR grammar option. This is a boolean option.</td> +<td valign="top">Sets the VISITOR grammar option. This is a boolean option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>nodepackage</td> +<td valign="top">nodepackage</td> -<td VALIGN=TOP>Sets the NODE_PACKAGE grammar option. This is a string option.</td> +<td valign="top">Sets the NODE_PACKAGE grammar option. This is a string option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>visitorexception</td> +<td valign="top">visitorexception</td> -<td VALIGN=TOP>Sets the VISITOR_EXCEPTION grammar option. This is a string +<td valign="top">Sets the VISITOR_EXCEPTION grammar option. This is a string option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> -<td VALIGN=TOP>nodeprefix</td> +<td valign="top">nodeprefix</td> -<td VALIGN=TOP>Sets the NODE_PREFIX grammar option. This is a string option.</td> +<td valign="top">Sets the NODE_PREFIX grammar option. This is a string option.</td> -<td ALIGN=CENTER VALIGN=TOP>No</td> +<td align="center" valign="top">No</td> </tr> <tr> @@ -196,16 +192,14 @@ option.</td> </tr> </table> -<h3> -Example</h3> +<h3>Example</h3> <blockquote> <pre><jjtree - target="src/Parser.jjt" + target="src/Parser.jjt" outputdirectory="build/src" - javacchome="c:/program files/JavaCC" - nodeusesparser="true" -/></pre> + javacchome="c:/program files/JavaCC" + nodeusesparser="true"/></pre> </blockquote> 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 @@ -214,7 +208,7 @@ is set to true when invoking JJTree. <h3>Comparison output locations between command line JJTree and different Ant taskdef versions</h3> -<table cellpadding="3" border="1"> +<table> <tr> <td><b>Command Line JJTree options</b> <br> <i>and Generated Files</i> (working directory: <code>/tmp</code>)</td> @@ -541,23 +535,17 @@ is set to true when invoking JJTree. </tr> </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. +<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 +<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> -<br> - - - - </body> </html> - http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jlink.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jlink.html b/manual/Tasks/jlink.html index 45ef961..0937d1d 100644 --- a/manual/Tasks/jlink.html +++ b/manual/Tasks/jlink.html @@ -21,7 +21,7 @@ </head> <body> -<h2><a name="jlink">Jlink</a></h2> +<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 @@ -31,32 +31,32 @@ <h3><b>Description:</b></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 +<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 +However, jlink provides options for controlling the way entries from input files -are added to the output file. Specifically, capabilities for merging +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 +<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 +pathelement) <i>and</i> the mergefile ends in ".zip" or ".jar", -entries in the mergefile will be merged into the outfile. A file with +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 +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 +Directories specified in either the mergefiles or addfiles element are added to the -output file as you would expect: all files in subdirectories are +output file as you would expect: all files in subdirectories are recursively added to -the output file with appropriate prefixes in the output file +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 +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> @@ -66,11 +66,11 @@ 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. +<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>, +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 +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. @@ -85,7 +85,7 @@ relative to the <i>base</i> directory.</p> <h3>Parameters:</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -98,7 +98,7 @@ relative to the <i>base</i> directory.</p> </tr> <tr> <td valign="top">compress</td> - <td valign="top">whether or not the output should be compressed. + <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> @@ -107,7 +107,7 @@ relative to the <i>base</i> directory.</p> <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">At least one of + <td valign="middle" align="center" rowspan="2">At least one of mergefiles or addfiles</td> </tr> <tr> @@ -118,7 +118,7 @@ mergefiles or addfiles</td> <h3>Examples</h3> -<p>The following will merge the entries in mergefoo.jar and mergebar.jar +<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> <pre> @@ -148,9 +148,9 @@ 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 +<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 +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> <pre> @@ -171,7 +171,5 @@ namely bar.class and barnone/myClass.zip</p> </jlink> </pre> - </body> - </html> http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/jspc.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/jspc.html b/manual/Tasks/jspc.html index 1e84ace..678d02d 100644 --- a/manual/Tasks/jspc.html +++ b/manual/Tasks/jspc.html @@ -80,7 +80,7 @@ and test your pages, all in one go. <h3>Parameters</h3> <p>The Task has the following attributes:</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -242,7 +242,7 @@ a reference to an existing classpath 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 border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/junit.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/junit.html b/manual/Tasks/junit.html index a6879a8..d4b594d 100644 --- a/manual/Tasks/junit.html +++ b/manual/Tasks/junit.html @@ -21,7 +21,7 @@ </head> <body> -<h2><a name="junit">JUnit</a></h2> +<h2 id="junit">JUnit</h2> <h3>Description</h3> <p>This task runs tests from the JUnit testing framework. The latest @@ -71,7 +71,7 @@ FAQ</a> for details. elements</a>).</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td width="12%" valign="top"><b>Attribute</b></td> <td width="78%" valign="top"><b>Description</b></td> @@ -152,7 +152,7 @@ elements</a>).</p> <tr> <td valign="top">maxmemory</td> <td valign="top">Maximum amount of memory to allocate to the forked VM. - Ignored if <code>fork</code> is disabled. <strong>Note</strong>: + Ignored if <code>fork</code> is disabled. <strong>Note</strong>: If you get <code>java.lang.OutOfMemoryError: Java heap space</code> in some of your tests then you need to raise the size like <code>maxmemory="128m"</code></td> @@ -234,7 +234,7 @@ elements</a>).</p> formatter output to find the failing tests. <em>since Ant 1.8.0</em></td> <td align="center" valign="top">No</td> - </tr> + </tr> <tr> <td valign="top">enableTestListenerEvents</td> <td valign="top">Whether Ant should send fine grained information @@ -268,21 +268,21 @@ clean up, and still fail the build in the event of a failure.</p> stack traces before reporting them. It works with both the plain and XML formatters. It filters out any lines that begin with the following string patterns:<pre> - "junit.framework.TestCase" - "junit.framework.TestResult" - "junit.framework.TestSuite" - "junit.framework.Assert." - "junit.swingui.TestRunner" - "junit.awtui.TestRunner" - "junit.textui.TestRunner" - "java.lang.reflect.Method.invoke(" - "sun.reflect." - "org.apache.tools.ant." - "org.junit." - "junit.framework.JUnit4TestAdapter" - " more"</pre> - -<h3><a name="nested">Nested Elements</a></h3> + "junit.framework.TestCase" + "junit.framework.TestResult" + "junit.framework.TestSuite" + "junit.framework.Assert." + "junit.swingui.TestRunner" + "junit.awtui.TestRunner" + "junit.textui.TestRunner" + "java.lang.reflect.Method.invoke(" + "sun.reflect." + "org.apache.tools.ant." + "org.junit." + "junit.framework.JUnit4TestAdapter" + " more"</pre> + +<h3 id="nested">Nested Elements</h3> <p>The <code><junit></code> task supports a nested <code><classpath></code> @@ -353,20 +353,20 @@ support it (i.e. Java 1.1).</p> <p><em>since Ant 1.6</em>.</p> <h4>permissions</h4> -<p>Security permissions can be revoked and granted during the execution of the +<p>Security permissions can be revoked and granted during the execution of the class via a nested <i>permissions</i> element. For more information please see <a href="../Types/permissions.html">permissions</a></p> <p>Settings will be ignored if fork is enabled.</p> <p><em>since Ant 1.6</em>.</p> - + <h4>assertions</h4> <p>You can control enablement of Java 1.4 assertions with an <a href="../Types/assertions.html"><tt><assertions></tt></a> subelement.</p> - + <p>Assertion statements are currently ignored in non-forked mode.</p> <p><em>since Ant 1.6.</em></p> @@ -407,14 +407,14 @@ can be specified.</p> that your tests have written as some characters are illegal in XML documents and will be dropped.</p> -<p>The fourth formatter named <code>failure</code> (since Ant 1.8.0) +<p>The fourth formatter named <code>failure</code> (since Ant 1.8.0) collects all failing <code>testXXX()</code> methods and creates a new <code>TestCase</code> which delegates only these failing methods. The name and the location can be specified via Java System property or Ant property -<code>ant.junit.failureCollector</code>. The value has to point to the directory and +<code>ant.junit.failureCollector</code>. The value has to point to the directory and the name of the resulting class (without suffix). It defaults to <i>java-tmp-dir</i>/FailedTests.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td width="12%" valign="top"><b>Attribute</b></td> <td width="78%" valign="top"><b>Description</b></td> @@ -450,14 +450,14 @@ the name of the resulting class (without suffix). It defaults to <i>java-tmp-dir <td valign="top">unless</td> <td valign="top">Only use formatter <a href="../properties.html#if+unless">if the named property is <b>not</b> set</a>.</td> <td align="center">No; default is <code>true</code>.</td> - </tr> + </tr> </table> <h4>test</h4> <p>Defines a single test class.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td width="12%" valign="top"><b>Attribute</b></td> <td width="78%" valign="top"><b>Description</b></td> @@ -487,7 +487,7 @@ the name of the resulting class (without suffix). It defaults to <i>java-tmp-dir is specified, then no test method from the suite will be executed.</p> </td> <td align="center">No; default is to run all test methods in the suite.</td> - </tr> + </tr> <tr> <td valign="top">fork</td> <td valign="top">Run the tests in a separate VM. @@ -581,7 +581,7 @@ generates a test class name for each resource that ends in prior to Ant 1.7 only <code><fileset></code> has been supported.</p> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td width="12%" valign="top"><b>Attribute</b></td> <td width="78%" valign="top"><b>Description</b></td> @@ -697,8 +697,7 @@ supported.</p> <p>to your <code>junit</code> task.</p> -<h3><a name="enabletestlistenerevents"><code>ant.junit.enabletestlistenerevents</code></a> - magic property</h3> +<h3 id="enabletestlistenerevents"><code>ant.junit.enabletestlistenerevents</code> magic property</h3> <p><em>Since Ant 1.8.2</em> the <code>enableTestListenerEvents</code> attribute of the task controls whether fine grained logging messages @@ -760,7 +759,7 @@ stopped if the test fails.</p> <p>Runs <code>my.test.TestCase</code> in the same VM, ignoring the given CLASSPATH; only a warning is printed if this test fails. In addition to the plain text test results, for this test a XML result -will be output to <code>result.xml</code>. +will be output to <code>result.xml</code>. Then, for each matching file in the directory defined for <code>${src.tests}</code> a test is run in a separate VM. If a test fails, the build process is @@ -776,7 +775,7 @@ aborted. Results are collected in files named <delete> <fileset dir="${collector.dir}" includes="${collector.class}*.class"/> </delete> - <!-- compile the FailedTests class if present --> + <!-- compile the FailedTests class if present --> <javac srcdir="${collector.dir}" destdir="${collector.dir}"/> <available file="${collector.dir}/${collector.class}.class" property="hasFailingTests"/> <junit haltonerror="false" haltonfailure="false"> @@ -802,8 +801,8 @@ aborted. Results are collected in files named </pre> <p>On the first run all tests are collected via the <code><batchtest/></code> element. Its <code>plain</code> formatter shows the output on the console. The -<code>failure</code> formatter creates a java source file in -<code>${build.dir}/failingTests/FailedTests.java</code> which extends +<code>failure</code> formatter creates a java source file in +<code>${build.dir}/failingTests/FailedTests.java</code> which extends <code>junit.framework.TestCase</code> and returns from a <code>suite()</code> method a test suite for the failing tests. <br/> On a second run the collector class exists and instead of the <code><batchtest/></code> http://git-wip-us.apache.org/repos/asf/ant/blob/a04350e0/manual/Tasks/junitreport.html ---------------------------------------------------------------------- diff --git a/manual/Tasks/junitreport.html b/manual/Tasks/junitreport.html index fea85e5..c0219be 100644 --- a/manual/Tasks/junitreport.html +++ b/manual/Tasks/junitreport.html @@ -22,7 +22,7 @@ <body> -<h2><a name="junitreport">JUnitReport</a></h2> +<h2 id="junitreport">JUnitReport</h2> <h3>Description</h3> Merge the individual XML files generated by the JUnit task and eventually apply a stylesheet on the resulting merged document to provide a browsable report of @@ -39,10 +39,10 @@ href="http://xml.apache.org/xalan-j/";>Xalan 2.4.1+ or Xalan XSLTC</a> (JDK 1.4 contains a version of Xalan-J 2.x while JDK 1.5 ships with a version of XSLTC). Starting from JDK 1.4.2-01 it ships with a bundled Xalan-J 2.4.1+, meaning that JDK version prior to 1.4.2-01 won't work -out of the box. The table below summarize the compatibility status. +out of the box. The table below summarize the compatibility status. </p> -<table border="1" cellpadding="2" cellspacing="0"> -<tr><th>Xalan</th><th>Sun JDK Bundle</th><th>Status<th></tr> +<table> +<tr><th>Xalan</th><th>Sun JDK Bundle</th><th>Status<th></tr> <tr><td>2.4.1+</td><td>JDK 1.4.2-01+</td><td>OK</td></tr> <tr><td>XSLTC</td><td>JDK 1.5.x</td><td>OK</td></tr> <tr><td>2.x</td><td>JDK 1.4.x</td><td>DEPRECATED<br><i>Use ${ant.home}/etc/junit-frames-xalan1.xsl @@ -52,11 +52,11 @@ out of the box. The table below summarize the compatibility status. <p>With Ant 1.6.2 we had to decide between supporting Xalan-J 1/Xalan J 2.4.1- and Xalan 2.4.1+/XSLTC, since there was no way to support both couples at the same time.</p> -<p>With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not +<p>With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not available anymore for quite some time.</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td width="12%" valign="top"><b>Attribute</b></td> <td width="78%" valign="top"><b>Description</b></td> @@ -75,7 +75,7 @@ available anymore for quite some time.</p> <td align="center" valign="top">No. Default to current directory</td> </tr> </table> -<h3><a name="nested">Nested Elements</a></h3> +<h3 id="nested">Nested Elements</h3> <h4>fileset</h4> <p><code>junitreport</code> collects individual xml files generated by the JUnit task using the nested <a href="../Types/fileset.html"><code><FileSet></code></a> @@ -83,7 +83,7 @@ element.</p> <h4>report</h4> <p>Generate a browsable report based on the document created by the merge.</p> <h3>Parameters</h3> -<table border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td width="12%" valign="top"><b>Attribute</b></td> <td width="78%" valign="top"><b>Description</b></td> @@ -113,7 +113,7 @@ element.</p> <td align="center" valign="top">No. Default to current directory</td> </tr> </table> -<p> Ant assumes the following concerning the <tt>frames</tt> and <tt>noframes</tt> formats :</p> +<p>Ant assumes the following concerning the <tt>frames</tt> and <tt>noframes</tt> formats:</p> <p>The <tt>frames</tt> format uses a stylesheet which is generating output <em>only</em> by redirecting.</p> <p>The @@ -126,7 +126,7 @@ file called <tt>junit-noframes.html</tt>.</p> <em>Since Ant 1.7</em>the report tag supports nested param tags. These tags can pass XSL parameters to the stylesheet. <h3>Parameters</h3> -<table width="60%" border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -156,7 +156,7 @@ These tags can pass XSL parameters to the stylesheet. </table> <p>The built-in stylesheets support the following parameters:</p> -<table width="60%" border="1" cellpadding="2" cellspacing="0"> +<table> <tr> <td valign="top"><b>XSL-Parameter</b></td> <td valign="top"><b>Description</b></td> @@ -212,5 +212,4 @@ generate the default framed report in the directory <tt>report/html</tt>.</p> The XSL parameters key1 and key2 will be passed to the XSL transformation.</p> </body> - </html>
