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:56 UTC
[41/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/depend.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/depend.html b/manual/Tasks/depend.html
index 1272e1d..eb547a4 100644
--- a/manual/Tasks/depend.html
+++ b/manual/Tasks/depend.html
@@ -26,199 +26,170 @@
<h2>Depend</h2>
-A task to manage Java class file dependencies.
+<p>A task to manage Java class file dependencies.</p>
<h3>Description</h3>
-<p>
-The depend task works by determining which classes are out of date with
-respect to their source and then removing the class files of any other
-classes which depend on the out-of-date classes.
-</p>
-
-<p>
-To determine the class dependencies, the depend task analyzes the class
-files of all class files passed to it. Depend does not parse your source code in
-any way but relies upon the class references encoded into the class files by the
-compiler. This is generally faster than parsing the Java source.</p>
-
-<p>
-To learn more about how this information is obtained from the class files,
-please refer to <a href="http://docs.oracle.com/javase/specs/">the Java
-Virtual Machine Specification</a>
-</p>
-
-<p>
-Since a class' dependencies only change when the class itself changes, the
-depend task is able to cache dependency information. Only those class files
-which have changed will have their dependency information re-analysed. Note that
-if you change a class' dependencies by changing the source, it will be
-recompiled anyway. You can examine the dependency files created to understand
-the dependencies of your classes. Please do not rely, however, on the format of
-the information, as it may change in a later release.
-</p>
-
-<p>
-Once depend discovers all of the class dependencies, it "inverts"
-this relation to determine, for each class, which other classes are dependent
-upon it. This "affects" list is used to discover which classes are
-invalidated by the out of date class. The class files of the invalidated
-classes are removed, triggering the compilation of the affected classes.
-</p>
-
-<p>
-The depend task supports an attribute, "closure" which controls
-whether depend will only consider direct class-class relationships or whether it
-will also consider transitive, indirect relationships. For example, say there
-are three classes, A, which depends on B, which in-turn depend on C. Now say
-that class C is out of date. Without closure, only class B would be removed by
-depend. With closure set, class A would also be removed. Normally direct
-relationships are sufficient - it is unusual for a class to depend on another
-without having a direct relationship. With closure set, you will notice that
-depend typically removes far more class files.
-</p>
-
-<p>The classpath attribute for <code><depend></code> is optional. If it is present,
-depend will check class dependencies against classes and jars on this classpath.
-Any classes which depend on an element from this classpath and which are older
-than that element will be deleted. A typical example where you would use this
-facility would be where you are building a utility jar and want to make sure
-classes which are out of date with respect to this jar are rebuilt. You should
-<b>not</b> include jars in this classpath which you do not expect to change,
-such as the JDK runtime jar or third party jars, since doing so will just slow
-down the dependency check. This means that if you do use a classpath for the
-depend task it may be different from the classpath necessary to actually
-compile your code.</p>
+<p>The <code>depend</code> task works by determining which classes are out of date with respect to
+their source and then removing the class files of any other classes which depend on the out-of-date
+classes.</p>
+
+<p>To determine the class dependencies, the <code>depend</code> task analyzes the class files of all
+class files passed to it. The task does not parse your source code in any way but relies upon the
+class references encoded into the class files by the compiler. This is generally faster than parsing
+the Java source files.</p>
+
+<p>To learn more about how this information is obtained from the class files, please refer
+to <a href="https://docs.oracle.com/javase/specs/">the Java Virtual Machine Specification</a></p>
+
+<p>Since a class' dependencies only change when the class itself changes, the
+<code>depend</code> task is able to cache dependency information. Only those class files which have
+changed will have their dependency information re-analysed. Note that if you change a class'
+dependencies by changing the source, it will be recompiled anyway. You can examine the dependency
+files created to understand the dependencies of your classes. Please do not rely, however, on the
+format of the information, as it may change in a later release.</p>
+
+<p>Once <code>depend</code> discovers all of the class dependencies, it "inverts" this
+relation to determine, for each class, which other classes are dependent upon it. This
+"affects" list is used to discover which classes are invalidated by the out of date
+class. The class files of the invalidated classes are removed, triggering the compilation of the
+affected classes.</p>
+
+<p>The <code>depend</code> task supports an attribute, <var>closure</var> which controls
+whether <code>depend</code> will only consider direct class-class relationships or whether it will
+also consider transitive, indirect relationships. For example, say there are three classes, A, which
+depends on B, which in-turn depend on C. Now say that class C is out of
+date. Without <var>closure</var>, only class B would be removed
+by <code>depend</code>. With <var>closure</var> set, class A would also be removed. Normally direct
+relationships are sufficient—it is unusual for a class to depend on another without having a
+direct relationship. With <var>closure</var> set, you will notice that <code>depend</code> typically
+removes far more class files.</p>
+
+<p>The <var>classpath</var> attribute for <code><depend></code> is optional. If it is
+present, <code>depend</code> will check class dependencies against classes and jars on this
+classpath. Any classes which depend on an element from this classpath and which are older than that
+element will be deleted. A typical example where you would use this facility would be where you are
+building a utility jar and want to make sure classes which are out of date with respect to this jar
+are rebuilt. You should <strong>not</strong> include jars in this classpath which you do not expect
+to change, such as the JDK runtime jar or third party jars, since doing so will just slow down the
+dependency check. This means that if you do use a classpath for the <code>depend</code> task it may
+be different from the classpath necessary to actually compile your code.</p>
<h3>Performance</h3>
-<p>
-The performance of the depend task is dependent on a
-number of factors such as class relationship complexity and how many class files
-are out of date. The decision about whether it is cheaper to just recompile all
-classes or to use the depend task will depend on the size of your project and
-how interrelated your classes are.
-</p>
+<p>The performance of the <code>depend</code> task is dependent on a number of factors such as class
+relationship complexity and how many class files are out of date. The decision about whether it is
+cheaper to just recompile all classes or to use the <code>depend</code> task will depend on the size
+of your project and how interrelated your classes are.</p>
<h3>Limitations</h3>
-<p>
-There are some source dependencies which depend will not detect.
-</p>
+<p>There are some source dependencies which <code>depend</code> will not detect.</p>
<ul>
-<li>If the Java compiler optimizes away a class relationship,
- there can be a source dependency without a class dependency.</li>
-
-<li>Non public classes cause two problems. Firstly depend cannot relate
- the class file to a source file. In the future this may be addressed
- using the source file attribute in the classfile. Secondly, neither
- depend nor the compiler tasks can detect when a non public class is
- missing. Inner classes are handled by the depend task.</li>
+<li>If the Java compiler optimizes away a class relationship, there can be a source dependency
+without a class dependency.</li>
+
+<li>Non public classes cause two problems. Firstly depend cannot relate the class file to a source
+file. In the future this may be addressed using the source file attribute in the
+classfile. Secondly, neither <code>depend</code> nor the compiler tasks can detect when a non public
+class is missing. Inner classes are handled by the <code>depend</code> task.</li>
</ul>
-The most obvious example of these limitations is that the task can't tell
-which classes to recompile when a constant primitive data type exported
-by other classes is changed. For example, a change in the definition of
-something like
+<p>The most obvious example of these limitations is that the task can't tell which classes to
+recompile when a constant primitive data type exported by other classes is changed. For example, a
+change in the definition of something like</p>
<pre>
public final class Constants {
- public final static boolean DEBUG=false;
-}
-</pre> will not be picked up by other classes.
+ public final static boolean DEBUG=false;
+}</pre>
+<p>will not be picked up by other classes.</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">srcDir</td>
- <td valign="top">This is the directory where the source exists. depend
-will examine this to determine which classes are out of date. If you use multiple
-source directories you can pass this attribute a path of source directories.</td>
- <td valign="top" align="center">Yes</td>
+ <td>srcDir</td>
+ <td>This is the directory where the source exists. <code>depend</code> will examine this to
+ determine which classes are out of date. If you use multiple source directories you can pass
+ this attribute a path of source directories.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">destDir</td>
- <td valign="top">This is the root directory of the class files which
-will be analysed. If this is not present, the srcdir is used.</td>
- <td valign="top" align="center">No</td>
+ <td>destDir</td>
+ <td>This is the root directory of the class files which will be analysed.</td>
+ <td>No; defaults to <var>srcdir</var></td>
</tr>
<tr>
- <td valign="top">cache</td>
- <td valign="top">This is a directory in which depend can store and
-retrieve dependency information. If this is not present, depend will not
-use a cache</td>
- <td valign="top" align="center">No</td>
+ <td>cache</td>
+ <td>This is a directory in which <code>depend</code> can store and retrieve dependency
+ information.</td>
+ <td>No; defaults to no cache</td>
</tr>
<tr>
- <td valign="top">closure</td>
- <td valign="top">This attribute controls whether depend only removes
-classes which directly depend on out of date classes. If this is set to true,
-depend will traverse the class dependency graph deleting all affected
-classes. Defaults to false</td>
- <td valign="top" align="center">No</td>
+ <td>closure</td>
+ <td>This attribute controls whether <code>depend</code> only removes classes which directly
+ depend on out of date classes. If this is set to <q>true</q>, <code>depend</code> will
+ traverse the class dependency graph deleting all affected classes.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">dump</td>
- <td valign="top">If true the dependency information will be written to the debug level log</td>
- <td valign="top" align="center">No</td>
+ <td>dump</td>
+ <td>If true the dependency information will be written to the debug level log</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">The classpath containing jars and classes for which <code><depend></code> should also
- check dependencies</td>
- <td valign="top" align="center">No</td>
+ <td>classpath</td>
+ <td>The classpath containing jars and classes for which <code><depend></code> should also
+ check dependencies</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">warnOnRmiStubs</td>
- <td valign="top">Flag to disable warnings about files that look like rmic generated stub/skeleton
- classes and have no .java source. Useful when doing RMI development.</td>
- <td valign="top" align="center">No, default=true</td>
+ <td>warnOnRmiStubs</td>
+ <td>Flag to disable warnings about files that look like <code>rmic</code> generated
+ stub/skeleton classes and have no <samp>.java</samp> source. Useful when doing RMI
+ development.</td>
+ <td>No; default <q>true</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
-<p>The <code>depend</code> task's <code>classpath</code> attribute is a
-<a href="../using.html#path">PATH-like structure</a> and can also be set
-via a nested <code><classpath></code> element.</p>
-
-<p>Additionally,
-this task forms an implicit
-<a href="../Types/fileset.html">FileSet</a>
-and supports most attributes of
-<code><fileset></code> (<code>dir</code> becomes <code>srcdir</code>),
-as well as the nested <code><include></code>,
-<code><exclude></code>, and <code><patternset></code> elements.
+<p>The <code>depend</code> task's <var>classpath</var> attribute is
+a <a href="../using.html#path">path-like structure</a> and can also be set via a
+nested <code><classpath></code> element.</p>
+
+<p>Additionally, this task forms an implicit <a href="../Types/fileset.html">FileSet</a> and
+supports most attributes of <code><fileset></code> (<var>dir</var> becomes <var>srcdir</var>),
+as well as the nested <code><include></code>, <code><exclude></code>,
+and <code><patternset></code> elements.</p>
<h3>Examples</h3>
-<pre><depend srcdir="${java.dir}"
+<pre>
+<depend srcdir="${java.dir}"
destdir="${build.classes}"
cache="depcache"
closure="yes"/></pre>
-<p>removes any classes in the <code>${build.classes}</code> directory
-that depend on out-of-date classes. Classes are considered out-of-date with
-respect to the source in the <code>${java.dir}</code> directory, using the same
-mechanism as the <code><javac></code> task. In this example, the
-<code><depend></code> task caches its dependency
-information in the <code>depcache</code> directory.
-</p>
+<p>removes any classes in the <samp>${build.classes}</samp> directory that depend on out-of-date
+classes. Classes are considered out-of-date with respect to the source in
+the <samp>${java.dir}</samp> directory, using the same mechanism as the <code><javac></code>
+task. In this example, the <code><depend></code> task caches its dependency information in
+the <samp>depcache</samp> directory.</p>
<pre>
<depend srcdir="${java.dir}" destdir="${build.classes}"
cache="depcache" closure="yes">
<include name="**/*.java"/>
<excludesfile name="${java.dir}/build_excludes"/>
-</depend>
-</pre>
-<p>does the same as the previous example, but explicitly includes all
-<code>.java</code> files, except those that match the list given
-in <code>${java.dir}/build_excludes</code>.</p>
+</depend></pre>
+
+<p>does the same as the previous example, but explicitly includes all <samp>.java</samp> files,
+except those that match the list given in <samp>${java.dir}/build_excludes</samp>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/dependset.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/dependset.html b/manual/Tasks/dependset.html
index 90aa2da..7f422f5 100644
--- a/manual/Tasks/dependset.html
+++ b/manual/Tasks/dependset.html
@@ -30,46 +30,35 @@ A task to manage arbitrary dependencies between resources.
<h3>Description</h3>
-<p>
-The dependset task compares a set of sources with a set of target
-files. If any of the sources has been modified more recently than
-any of the target files, all of the target files are removed.
-</p>
-<p>
-Sources and target files are specified via nested
-<a href="../Types/resources.html#collection">Resource Collection</a>s;
-sources can be resources of any type, while targets are restricted to files
-only. At least one set of sources and one set of targets is required.
-</p>
-<p>
-Use a FileSet when you want to use wildcard include or exclude
-patterns and don't care about missing files. Use a FileList when you
-want to consider the non-existence of a file as if it were out of
-date. If there are any non-existing files in any source or target
-FileList, all target files will be removed.
-</p>
-<p>
-DependSet is useful to capture dependencies that are not or cannot be
-determined algorithmically. For example, the <code><style></code> task only
-compares the source XML file and XSLT stylesheet against the target
-file to determined whether to restyle the source. Using dependset you
-can extend this dependency checking to include a DTD or XSD file as
-well as other stylesheets imported by the main stylesheet.
-</p>
+<p>The <code>dependset</code> task compares a set of sources with a set of target files. If any of
+the sources has been modified more recently than any of the target files, all of the target files
+are removed.</p>
+<p>Sources and target files are specified via
+nested <a href="../Types/resources.html#collection">Resource Collection</a>s; sources can be
+resources of any type, while targets are restricted to files only. At least one set of sources and
+one set of targets is required.</p>
+<p>Use a FileSet when you want to use wildcard include or exclude patterns and don't care about
+missing files. Use a FileList when you want to consider the non-existence of a file as if it were
+out of date. If there are any non-existing files in any source or target FileList, all target files
+will be removed.</p>
+<p>DependSet is useful to capture dependencies that are not or cannot be determined algorithmically.
+For example, the <code><style></code> task only compares the source XML file and XSLT
+stylesheet against the target file to determined whether to restyle the source.
+Using <code>dependset</code> you can extend this dependency checking to include a DTD or XSD file as
+well as other stylesheets imported by the main stylesheet.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td valign="top" align="center"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">Makes the task list all deleted targets files
- and the reason why they get deleted.</td>
- <td align="center" valign="top">No</td>
+ <td>verbose</td>
+ <td>Makes the task list all deleted targets files and the reason why they get deleted.</td>
+ <td>No</td>
</tr>
</table>
@@ -77,92 +66,75 @@ well as other stylesheets imported by the main stylesheet.
<h4>sources</h4>
-<p>The <code><sources></code> element is a
-<a href="../Types/resources.html#union">Union</a> into which
-arbitrary resource collections can be nested. <em>Since Apache Ant 1.7</em>
+<p>The <code><sources></code> element is a <a href="../Types/resources.html#union">Union</a>
+into which arbitrary resource collections can be nested. <em>Since Apache Ant 1.7</em>
</p>
<h4>srcfileset</h4>
-<p>
-The nested <code><srcfileset></code> element specifies a <a
-href="../Types/fileset.html">FileSet</a>. All files included in
-this fileset will be compared against all files included in all of the
-<code><targetfileset></code> filesets and <code><targetfilelist></code>
-filelists. Multiple <code><srcfileset></code> filesets may be specified.
-</p>
+<p>The nested <code><srcfileset></code> element specifies
+a <a href="../Types/fileset.html">FileSet</a>. All files included in this fileset will be compared
+against all files included in all of the <code><targetfileset></code> filesets
+and <code><targetfilelist></code> filelists. Multiple <code><srcfileset></code>
+filesets may be specified.</p>
<h4>srcfilelist</h4>
-<p>
-The nested <code><srcfilelist></code> element specifies a <a
-href="../Types/filelist.html">FileList</a>. All files included in
-this filelist will be compared against all files included in all of the
-<code><targetfileset></code> filesets and <code><targetfilelist></code>
-filelists. Multiple <code><srcfilelist></code> filelists may be specified.
-</p>
+<p>The nested <code><srcfilelist></code> element specifies
+a <a href="../Types/filelist.html">FileList</a>. All files included in this filelist will be
+compared against all files included in all of the <code><targetfileset></code> filesets
+and <code><targetfilelist></code> filelists. Multiple <code><srcfilelist></code>
+filelists may be specified.</p>
<h4>targets</h4>
-<p>The <code><targets></code> element is a
-<a href="../using.html#path">Path</a> and thus can
-include any filesystem-based resource. <em>Since Ant 1.7</em>
-</p>
+<p>The <code><targets></code> element is a <a href="../using.html#path">Path</a> and thus can
+include any filesystem-based resource. <em>Since Ant 1.7</em></p>
<h4>targetfileset</h4>
-<p>
-The nested <code><targetfileset></code> element specifies a <a
-href="../Types/fileset.html">FileSet</a>. All files included in
-this fileset will be compared against all files included in all of the
-<code><srcfileset></code> filesets and <code><sourcefilelist></code>
-filelists, and if any are older, they are all deleted.
-Multiple <code><targetfileset></code> filesets may be specified.
-</p>
+<p>The nested <code><targetfileset></code> element specifies
+a <a href="../Types/fileset.html">FileSet</a>. All files included in this fileset will be compared
+against all files included in all of the <code><srcfileset></code> filesets
+and <code><sourcefilelist></code> filelists, and if any are older, they are all deleted.
+Multiple <code><targetfileset></code> filesets may be specified.</p>
<h4>targetfilelist</h4>
-<p>
-The nested <code><targetfilelist></code> element specifies a <a
-href="../Types/filelist.html">FileList</a>. All files included in
-this filelist will be compared against all files included in all of the
-<code><srcfileset></code> filesets and <code><sourcefilelist></code>
-filelists, and if any are older, they are all deleted.
-Multiple <code><targetfilelist></code> filelists may be specified.
-</p>
+<p>The nested <code><targetfilelist></code> element specifies
+a <a href="../Types/filelist.html">FileList</a>. All files included in this filelist will be
+compared against all files included in all of the <code><srcfileset></code> filesets
+and <code><sourcefilelist></code> filelists, and if any are older, they are all deleted.
+Multiple <code><targetfilelist></code> filelists may be specified.</p>
<h3>Examples</h3>
<pre>
- <dependset>
- <srcfilelist
- dir = "${dtd.dir}"
- files = "paper.dtd,common.dtd"/>
- <srcfilelist
- dir = "${xsl.dir}"
- files = "common.xsl"/>
- <srcfilelist
- dir = "${basedir}"
- files = "build.xml"/>
- <targetfileset
- dir = "${output.dir}"
- includes = "**/*.html"/>
- </dependset></pre>
-
-<p>
-In this example derived HTML files in the ${output.dir} directory
-will be removed if any are out-of-date with respect to:</p>
+<dependset>
+ <srcfilelist
+ dir = "${dtd.dir}"
+ files = "paper.dtd,common.dtd"/>
+ <srcfilelist
+ dir = "${xsl.dir}"
+ files = "common.xsl"/>
+ <srcfilelist
+ dir = "${basedir}"
+ files = "build.xml"/>
+ <targetfileset
+ dir = "${output.dir}"
+ includes = "**/*.html"/>
+</dependset></pre>
+
+<p>In this example derived HTML files in the ${output.dir} directory will be removed if any are
+out-of-date with respect to:</p>
<ol>
-<li>the DTD of their source XML files</li>
-<li>a common DTD (imported by the main DTD)</li>
-<li>a subordinate XSLT stylesheet (imported by the main stylesheet), or</li>
-<li>the buildfile</li>
+ <li>the DTD of their source XML files</li>
+ <li>a common DTD (imported by the main DTD)</li>
+ <li>a subordinate XSLT stylesheet (imported by the main stylesheet), or</li>
+ <li>the buildfile</li>
</ol>
-<p>
-If any of the sources in the above example does not exist, all
-target files will also be removed. To ignore missing sources instead,
-use filesets instead of filelists for the sources.
-</p>
+<p>If any of the sources in the above example does not exist, all target files will also be removed.
+To ignore missing sources instead, use filesets instead of filelists for the sources.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/diagnostics.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/diagnostics.html b/manual/Tasks/diagnostics.html
index 57d08db..686f9bc 100644
--- a/manual/Tasks/diagnostics.html
+++ b/manual/Tasks/diagnostics.html
@@ -26,22 +26,16 @@
<h2 id="diagnostics">Diagnostics</h2>
<h3>Description</h3>
-<p>
-Runs Apache Ant's <code>-diagnostics</code> code inside Ant itself. This is good for
-debugging Ant's configuration under an IDE.
-<em>Since Ant 1.7.0</em>
-</p>
+<p>Runs Apache Ant's <code>-diagnostics</code> code inside Ant itself. This is good for debugging
+Ant's configuration under an IDE. <em>Since Ant 1.7.0</em></p>
<h3>Examples</h3>
<pre>
- <target name="diagnostics" description="diagnostics">
- <diagnostics/>
- </target>
-</pre>
-<p>
- Prints out the current diagnostics dump.
-</p>
+<target name="diagnostics" description="diagnostics">
+ <diagnostics/>
+</target></pre>
+<p>Prints out the current diagnostics dump.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/dirname.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/dirname.html b/manual/Tasks/dirname.html
index 3a7b75a..17671c4 100644
--- a/manual/Tasks/dirname.html
+++ b/manual/Tasks/dirname.html
@@ -26,46 +26,39 @@
<h2 id="echo">Dirname</h2>
<h3>Description</h3>
-<p>
-Task to determine the directory path of a specified file.
-</p>
-<p>
-When this task executes, it will set the specified property to the
-value of the specified file (or directory) up to, but not including,
-the last path element. If the specified file is a path that ends in a
-filename, the filename will be dropped. If the specified file is just
-a filename, the directory will be the current directory.
-</p>
- <p>
- <strong>Note</strong>: This is not the same as the UNIX dirname command, which is
- defined as "strip non-directory suffix from filename". <dirname>
- determines the full directory path of the specified file.
- </p>
+<p>Task to determine the directory path of a specified file.</p>
+<p>When this task executes, it will set the specified property to the value of the specified file
+(or directory) up to, but not including, the last path element. If the specified file is a path that
+ends in a filename, the filename will be dropped. If the specified file is just a filename, the
+directory will be the current directory.</p>
+<p><strong>Note</strong>: This is not the same as the UNIX <code>dirname</code> command, which is
+defined as "strip non-directory suffix from filename". <code><dirname></code> determines the
+full directory path of the specified 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">file</td>
- <td valign="top">The path to take the dirname of.</td>
- <td valign="top" align="center">Yes</td>
+ <td>file</td>
+ <td>The path to take the dirname of.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">property</td>
- <td valign="top">The name of the property to set.</td>
- <td valign="top" align="center">Yes</td>
+ <td>property</td>
+ <td>The name of the property to set.</td>
+ <td>Yes</td>
</tr>
</table>
<h3>Examples</h3>
-<pre> <dirname property="antfile.dir" file="${ant.file}"/></pre>
-will set <code>antfile.dir</code> to the directory path for
-<code>${ant.file}</code>.
-<pre> <dirname property="foo.dirname" file="foo.txt"/></pre>
-will set <code>foo.dirname</code> to the project's basedir.
+<pre><dirname property="antfile.dir" file="${ant.file}"/></pre>
+<p>will set <code>antfile.dir</code> to the directory path for <samp>${ant.file}</samp>.</p>
+
+<pre><dirname property="foo.dirname" file="foo.txt"/></pre>
+<p>will set <code>foo.dirname</code> to the project's <var>basedir</var>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/ear.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/ear.html b/manual/Tasks/ear.html
index a7b2462..688b5f6 100644
--- a/manual/Tasks/ear.html
+++ b/manual/Tasks/ear.html
@@ -26,273 +26,240 @@
<h2 id="ear">Ear</h2>
<h3>Description</h3>
-<p>An extension of the <a href="jar.html">Jar</a> task with special
-treatment for files that should end up in an Enterprise Application archive.</p>
-<p>(The Ear task is a shortcut for specifying the particular layout of a EAR file.
-The same thing can be accomplished by using the <i>prefix</i> and <i>fullpath</i>
-attributes of zipfilesets in a Zip or Jar task.)</p>
-<p>The extended zipfileset element from the zip task (with attributes <i>prefix</i>, <i>fullpath</i>, and <i>src</i>) is available in the Ear task.</p>
+<p>An extension of the <a href="jar.html">Jar</a> task with special treatment for files that should
+end up in an Enterprise Application archive.</p>
+<p>(The <code>Ear</code> task is a shortcut for specifying the particular layout of a EAR file. The
+same thing can be accomplished by using the <var>prefix</var> and <var>fullpath</var> attributes of
+zipfilesets in a <code>Zip</code> or <code>Jar</code> task.)</p>
+<p>The extended zipfileset element from the <code>Zip</code> task (with
+attributes <var>prefix</var>, <var>fullpath</var>, and <var>src</var>) is available in
+the <code>Ear</code> task.</p>
-<p><b>Please note that the zip format allows multiple files of the same
-fully-qualified name to exist within a single archive. This has been
-documented as causing various problems for unsuspecting users. If you wish
-to avoid this behavior you must set the <code>duplicate</code> attribute
-to a value other than its default, <code>"add"</code>.</b></p>
+<p><strong>Please note that the zip format allows multiple files of the same fully-qualified name to
+exist within a single archive. This has been documented as causing various problems for
+unsuspecting users. If you wish to avoid this behavior you must set the <var>duplicate</var>
+attribute to a value other than its default, <q>add</q>.</strong></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">destfile</td>
- <td valign="top">the EAR file to create.</td>
- <td valign="top" align="center">Yes</td>
+ <td>destfile</td>
+ <td>the EAR file to create.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">appxml</td>
- <td valign="top">The deployment descriptor to use (META-INF/application.xml).</td>
- <td valign="top" align="center">Yes, unless update is set to true</td>
+ <td>appxml</td>
+ <td>The deployment descriptor to use (<samp>META-INF/application.xml</samp>).</td>
+ <td>Yes, unless <var>update</var> is set to <q>true</q></td>
</tr>
<tr>
- <td valign="top">basedir</td>
- <td valign="top">the directory from which to jar the files.</td>
- <td valign="top" align="center">No</td>
+ <td>basedir</td>
+ <td>the directory from which to jar the files.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">compress</td>
- <td valign="top">Not only store data but also compress them,
- defaults to true. Unless you set the <em>keepcompression</em>
- attribute to false, this will apply to the entire archive, not
- only the files you've added while updating.</td>
- <td align="center" valign="top">No</td>
+ <td>compress</td>
+ <td>Not only store data but also compress them. Unless you set the <var>keepcompression</var>
+ attribute to <q>false</q>, this will apply to the entire archive, not only the files you've
+ added while updating.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">keepcompression</td>
- <td valign="top">For entries coming from existing archives (like
- nested <em>zipfileset</em>s or while updating the archive), keep
- the compression as it has been originally instead of using the
- <em>compress</em> attribute. Defaults to false. <em>Since Apache Ant
- 1.6</em></td>
- <td align="center" valign="top">No</td>
+ <td>keepcompression</td>
+ <td>For entries coming from existing archives (like nested <code>zipfileset</code>s or while
+ updating the archive), keep the compression as it has been originally instead of using the
+ <var>compress</var> attribute. <em>Since Apache Ant 1.6</em></td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">The character encoding to use for filenames
- inside the archive. Defaults to UTF8. <strong>It is not
- recommended to change this value as the created archive will most
- likely be unreadable for Java otherwise.</strong>
- <br/>See also the <a href="zip.html#encoding">discussion in the
- zip task page</a></td>
- <td align="center" valign="top">No</td>
+ <td>encoding</td>
+ <td>The character encoding to use for filenames inside the archive. <strong>It is not
+ recommended to change this value as the created archive will most likely be unreadable for
+ Java otherwise.</strong> <br/>See also the <a href="zip.html#encoding">discussion in the zip
+ task page</a></td>
+ <td>No; defaults to <q>UTF8</q></td>
</tr>
<tr>
- <td valign="top">filesonly</td>
- <td valign="top">Store only file entries, defaults to false</td>
- <td align="center" valign="top">No</td>
+ <td>filesonly</td>
+ <td>Store only file entries.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">includes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- included. All files are included when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>includes</td>
+ <td>comma- or space-separated list of patterns of files that must be included.</td>
+ <td>No; defaults to all (<q>**</q>)</td>
</tr>
<tr>
- <td valign="top">includesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an include pattern</td>
- <td valign="top" align="center">No</td>
+ <td>includesfile</td>
+ <td>name of a file. Each line of this file is taken to be an include pattern.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">excludes</td>
- <td valign="top">comma- or space-separated list of patterns of files that must be
- excluded. No files (except default excludes) are excluded when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>excludes</td>
+ <td>comma- or space-separated list of patterns of files that must be excluded.</td>
+ <td>No; defaults to default excludes or none if <var>defaultexcludes</var> is <q>no</q></td>
</tr>
<tr>
- <td valign="top">excludesfile</td>
- <td valign="top">the name of a file. Each line of this file is
- taken to be an exclude pattern</td>
- <td valign="top" align="center">No</td>
+ <td>excludesfile</td>
+ <td>name of a file. Each line of this file is taken to be an exclude pattern.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top">indicates whether default excludes should be used or not
- ("yes"/"no"). Default excludes are used when omitted.</td>
- <td valign="top" align="center">No</td>
+ <td>defaultexcludes</td>
+ <td>indicates whether default excludes should be used or not (<q>yes|no</q>).</td>
+ <td>No; defaults to <q>yes</q></td>
</tr>
<tr>
- <td valign="top">manifest</td>
- <td valign="top">the manifest file to use.</td>
- <td valign="top" align="center">No</td>
+ <td>manifest</td>
+ <td>the manifest file to use.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">filesetmanifest</td>
- <td valign="top">behavior when a Manifest is found in a zipfileset or zipgroupfileset file is found. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of the manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip".
- </td>
- <td valign="top" align="center">No</td>
+ <td>filesetmanifest</td>
+ <td>behavior when a manifest file is found in a <code>zipfileset</code>
+ or <code>zipgroupfileset</code> file. Valid values are <q>skip</q>, <q>merge</q>,
+ and <q>mergewithoutmain</q>. <q>merge</q> will merge all of the manifests together, and merge
+ this into any other specified manifests. <q>mergewithoutmain</q> merges everything but the Main
+ section of the manifests.</td>
+ <td>No; defaults to <q>skip</q></td>
</tr>
<tr>
- <td valign="top">whenmanifestonly</td>
- <td valign="top">behavior when no files match. Valid values are "fail", "skip", and "create". Default is "create".</td>
- <td valign="top" align="center">No</td>
+ <td>whenmanifestonly</td>
+ <td>behavior when no files match. Valid values are <q>fail</q>, <q>skip</q>,
+ and <q>create</q>.</td>
+ <td>No; defaults to <q>create</q></td>
</tr>
<tr>
- <td valign="top">manifestencoding</td>
- <td valign="top">The encoding used to read the JAR manifest, when a manifest file is specified.</td>
- <td valign="top" align="center">No, defaults to the platform encoding.</td>
+ <td>manifestencoding</td>
+ <td>The encoding used to read the JAR manifest, when a manifest file is specified.</td>
+ <td>No; defaults to default JVM character encoding</td>
</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
- feature. Unless you specify additional jars with nested <a
- href="jar.html#indexjars"><code>indexjars</code></a> elements, only the
- contents of this jar will be included in the index. Defaults to
- false.</td>
- <td valign="top" align="center">No</td>
+ <td>index</td>
+ <td>whether to create
+ an <a href="https://docs.oracle.com/javase/8/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="jar.html#indexjars"><code>indexjars</code></a> elements,
+ only the contents of this jar will be included in the index.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">indexMetaInf</td>
- <td valign="top">whether to include META-INF and its children in
- the index. Doesn't have any effect if <em>index</em> is
- false.<br/>
- Oracle's jar implementation used to skip the META-INF directory and
- Ant followed that example. The behavior has been changed with
- <a href="https://bugs.openjdk.java.net/browse/JDK-4408526">Java
- 5</a>. In order to avoid problems with Ant generated jars on
- Java 1.4 or earlier Ant will not include META-INF unless
- explicitly asked to. Defaults to false<br/>
- <em>Since Ant 1.8.0</em>.</td>
- <td valign="top" align="center">No</td>
+ <td>indexMetaInf</td>
+ <td>whether to include <samp>META-INF</samp> and its children in the index. Doesn't have any
+ effect if <var>index</var> is false.<br/>Oracle's jar implementation used to skip
+ the <samp>META-INF</samp> directory and Ant followed that example. The behavior has been
+ changed with <a href="https://bugs.openjdk.java.net/browse/JDK-4408526">Java 5</a>. In order
+ to avoid problems with Ant generated jars on Java 1.4 or earlier, Ant will not
+ include <samp>META-INF</samp> unless explicitly asked to.<br/><em>Since Ant 1.8.0</em>.</td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">update</td>
- <td valign="top">indicates whether to update or overwrite
- the destination file if it already exists. Default is "false".</td>
- <td valign="top" align="center">No</td>
+ <td>update</td>
+ <td>indicates whether to update or overwrite the destination file if it already exists.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">duplicate</td>
- <td valign="top">behavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". </td>
- <td valign="top" align="center">No</td>
+ <td>duplicate</td>
+ <td>behavior when a duplicate file is found. Valid values are <q>add</q>, <q>preserve</q>,
+ and <q>fail</q>.</td>
+ <td>No; default is <q>add</q></td>
</tr>
<tr>
- <td valign="top">roundup</td>
- <td valign="top">Whether the file modification times will be
- rounded up to the next even number of seconds.<br>
- Zip archives store file modification times with a granularity of
- two seconds, so the times will either be rounded up or down. If
- you round down, the archive will always seem out-of-date when you
- rerun the task, so the default is to round up. Rounding up may
- lead to a different type of problems like JSPs inside a web
- archive that seem to be slightly more recent than precompiled
- pages, rendering precompilation useless.<br>
- Defaults to true. <em>Since Ant 1.6.2</em></td>
- <td align="center" valign="top">No</td>
+ <td>roundup</td>
+ <td>Whether the file modification times will be rounded up to the next even number of
+ seconds.<br/>Zip archives store file modification times with a granularity of 2 seconds, so
+ the times will either be rounded up or down. If you round down, the archive will always seem
+ out-of-date when you rerun the task, so the default is to round up. Rounding up may lead to a
+ different type of problems like JSPs inside a web archive that seem to be slightly more recent
+ than precompiled pages, rendering precompilation useless.<br/><em>Since Ant 1.6.2</em></td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
- <td valign="top">level</td>
- <td valign="top">Non-default level at which file compression should be
- performed. Valid values range from 0 (no compression/fastest) to 9
- (maximum compression/slowest). <em>Since Ant 1.7</em></td>
- <td valign="top" align="center">No</td>
+ <td>level</td>
+ <td>Non-default level at which file compression should be performed. Valid values range
+ from <q>0</q> (no compression/fastest) to <q>9</q> (maximum compression/slowest). <em>Since Ant
+ 1.7</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">preserve0permissions</td>
- <td valign="top">when updating an archive or adding entries from a
- different archive Ant will assume that a Unix permissions value of
- 0 (nobody is allowed to do anything to the file/directory) means
- that the permissions haven't been stored at all rather than real
- permissions and will instead apply its own default values.<br/>
- Set this attribute to true if you really want to preserve the
- original permission field. <em>Since Ant 1.8.0</em>
+ <td>preserve0permissions</td>
+ <td>when updating an archive or adding entries from a different archive Ant will assume that a
+ Unix permissions value of 0 (nobody is allowed to do anything to the file/directory) means
+ that the permissions haven't been stored at all rather than real permissions and will instead
+ apply its own default values.<br/> Set this attribute to <q>true</q> if you really want to
+ preserve the original permission field. <em>Since Ant 1.8.0</em>
</td>
- <td valign="top" align="center">No, default is false</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">useLanguageEncodingFlag</td>
- <td valign="top">Whether to set the language encoding flag if the
- encoding is UTF-8. This setting doesn't have any effect if the
- encoding is not UTF-8.
- <em>Since Ant 1.8.0</em>.
- <br/>See also the <a href="zip.html#encoding">discussion in the
- zip task page</a></td>
- <td valign="top" align="center">No, default is true</td>
+ <td>useLanguageEncodingFlag</td>
+ <td>Whether to set the language encoding flag if the encoding is UTF-8. This setting doesn't
+ have any effect if the encoding is not UTF-8. <em>Since Ant 1.8.0</em>.<br/>See also
+ the <a href="zip.html#encoding">discussion in the zip task page</a></td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">createUnicodeExtraFields</td>
- <td valign="top">Whether to create unicode extra fields to store
- the file names a second time inside the entry's metadata.
- <br>Possible values are "never", "always" and "not-encodeable"
- which will only add Unicode extra fields if the file name cannot
- be encoded using the specified encoding.
- <em>Since Ant 1.8.0</em>.
- <br/>See also the <a href="zip.html#encoding">discussion in the
- zip task page</a></td>
- <td align="center" valign="top">No, default is "never"</td>
+ <td>createUnicodeExtraFields</td>
+ <td>Whether to create Unicode extra fields to store the file names a second time inside the
+ entry's metadata.<br/>Possible values are <q>never</q>, <q>always</q>
+ and <q>not-encodeable</q> which will only add Unicode extra fields if the file name cannot be
+ encoded using the specified encoding. <em>Since Ant 1.8.0</em>. <br/>See also
+ the <a href="zip.html#encoding">discussion in the zip task page</a></td>
+ <td>No; default is <q>never</q></td>
</tr>
<tr>
- <td valign="top">fallbacktoUTF8</td>
- <td valign="top">Whether to use UTF-8 and the language encoding
- flag instead of the specified encoding if a file name cannot be
- encoded using the specified encoding.
- <em>Since Ant 1.8.0</em>.
- <br/>See also the <a href="zip.html#encoding">discussion in the
- zip task page</a></td>
- <td align="center" valign="top">No, default is false</td>
+ <td>fallbacktoUTF8</td>
+ <td>Whether to use UTF-8 and the language encoding flag instead of the specified encoding if a
+ file name cannot be encoded using the specified encoding. <em>Since Ant 1.8.0</em>.<br/>See
+ also the <a href="zip.html#encoding">discussion in the zip task page</a></td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">mergeClassPathAttributes</td>
- <td valign="top">Whether to merge the Class-Path attributes found
- in different manifests (if merging manifests). If false, only
- the attribute of the last merged manifest will be preserved.
- <em>Since Ant 1.8.0</em>.
- <br/>unless you also set flattenAttributes to true this may
- result in manifests containing multiple Class-Path attributes
- which violates the manifest specification.</td>
- <td align="center" valign="top">No, default is false</td>
+ <td>mergeClassPathAttributes</td>
+ <td>Whether to merge the <code>Class-Path</code> attributes found in different manifests (if
+ merging manifests). If <q>false</q>, only the attribute of the last merged manifest will be
+ preserved. <em>Since Ant 1.8.0</em>.<br/>unless you also set <var>flattenAttributes</var>
+ to <q>true</q> this may result in manifests containing multiple <code>Class-Path</code>
+ attributes which violates the manifest specification.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">flattenAttributes</td>
- <td valign="top">Whether to merge attributes occurring more than
- once in a section (this can only happen for the Class-Path
- attribute) into a single attribute.
- <em>Since Ant 1.8.0</em>.</td>
- <td align="center" valign="top">No, default is false</td>
+ <td>flattenAttributes</td>
+ <td>Whether to merge attributes occurring more than once in a section (this can only happen for
+ the <code>Class-Path</code> attribute) into a single attribute. <em>Since Ant
+ 1.8.0</em>.</td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">zip64Mode</td>
- <td valign="top">When to use Zip64 extensions for entries. The
- possible values are "never", "always" and "as-needed".
- <em>Since Ant 1.9.1</em>.
- <br/>See also the <a href="zip.html#zip64">discussion in the
- zip task page</a></td>
- <td align="center" valign="top">No, default is "never"</td>
+ <td>zip64Mode</td>
+ <td>When to use Zip64 extensions for entries. The possible values
+ are <q>never</q>, <q>always</q> and <q>as-needed</q>. <em>Since Ant 1.9.1</em>.<br/>See also
+ the <a href="zip.html#zip64">discussion in the zip task page</a></td>
+ <td>No; default is <q>never</q></td>
</tr>
</table>
<h3>Nested elements</h3>
<h4>metainf</h4>
-<p>The nested <code>metainf</code> element specifies a <a
-href="../Types/fileset.html">FileSet</a>. All files included in this fileset will
-end up in the <code>META-INF</code> directory of the ear file. If this
-fileset includes a file named <code>MANIFEST.MF</code>, the file is
-ignored and you will get a warning.</p>
+<p>The nested <code>metainf</code> element specifies
+a <a href="../Types/fileset.html">FileSet</a>. All files included in this fileset will end up in
+the <samp>META-INF</samp> directory of the ear file. If this fileset includes a file
+named <samp>MANIFEST.MF</samp>, the file is ignored and you will get a warning.</p>
<h4>manifest, indexjars, service</h4>
-These are inherited from <a href="jar.html"><jar></a>
+<p>These are inherited from <a href="jar.html"><jar></a></p>
<h2>Example</h2>
<pre>
- <ear destfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml">
- <fileset dir="${build.dir}" includes="*.jar,*.war"/>
- </ear>
-</pre>
+<ear destfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml">
+ <fileset dir="${build.dir}" includes="*.jar,*.war"/>
+</ear></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/echo.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/echo.html b/manual/Tasks/echo.html
index 49f5bc6..5a0c383 100644
--- a/manual/Tasks/echo.html
+++ b/manual/Tasks/echo.html
@@ -26,161 +26,143 @@
<h2 id="echo">Echo</h2>
<h3>Description</h3>
-<p>Echoes a message to the current loggers and listeners which
-means <tt>System.out</tt> unless overridden. A <tt>level</tt>
-can be specified, which controls at what logging level the message is
-filtered at.
-<p>
-The task can also echo to a file, in which case the option to append rather
-than overwrite the file is available, and the <tt>level</tt> option is
-ignored</p>
+<p>Echoes a message to the current loggers and listeners which means <code>System.out</code> unless
+overridden. A <var>level</var> can be specified, which controls at what logging level the message is
+filtered at.</p>
+<p>The task can also echo to a file, in which case the option to append rather than overwrite the
+file is available, and the <var>level</var> option is ignored</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">message</td>
- <td valign="top">the message to echo.</td>
- <td valign="top" align="center">No. Text may also be included in a
- character section within this element. If neither is included a
- blank line will be emitted in the output.</td>
+ <td>message</td>
+ <td>the message to echo.</td>
+ <td>No; defaults to a blank line unless text is included in a character section within this
+ element</td>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">the file to write the message to.</td>
- <td valign="top" align="center" rowspan="2">No; only one of these may be used.</td>
+ <td>file</td>
+ <td>the file to write the message to.</td>
+ <td rowspan="2">No; only one of these may be used</td>
</tr>
<tr>
- <td valign="top">output</td>
- <td valign="top">the <a href="../Types/resources.html">Resource</a>
+ <td>output</td>
+ <td class="left">the <a href="../Types/resources.html">Resource</a>
to write the message to (see <a href="../develop.html#set-magic">note</a>).
<em>Since Apache Ant 1.8</em></td>
</tr>
<tr>
- <td valign="top">append</td>
- <td valign="top">Append to an existing file (or
- <a href="http://docs.oracle.com/javase/7/docs/api//java/io/FileWriter.html#FileWriter%28java.lang.String,%20boolean%29" target="_blank">
- open a new file / overwrite an existing file</a>)? Default <i>false</i>.
+ <td>append</td>
+ <td>Append to an existing file
+ (or <a href="https://docs.oracle.com/javase/8/docs/api//java/io/FileWriter.html#FileWriter-java.lang.String-boolean-"
+ target="_blank"> open a new file / overwrite an existing file</a>)?
</td>
- <td valign="top" align="center">No; ignored unless <i>output</i> indicates a
- filesystem destination.</td>
+ <td>No; ignored unless <var>output</var> indicates a filesystem destination, default
+ is <q>false</q></td>
</tr>
<tr>
- <td valign="top">level</td>
- <td valign="top">Control the level at which this message is reported.
- One of "error", "warning", "info", "verbose", "debug" (decreasing order)</td>
- <td valign="top" align="center">No - default is "warning".</td>
+ <td>level</td>
+ <td>Control the level at which this message is reported. One
+ of <q>error</q>, <q>warning</q>, <q>info</q>, <q>verbose</q>, <q>debug</q> (decreasing
+ order)</td>
+ <td>No; default is <q>warning</q></td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">encoding to use, default is ""; the local system encoding. <em>since Ant 1.7</em></td>
- <td valign="top" align="center">No</td>
+ <td>encoding</td>
+ <td>encoding to use. <em>since Ant 1.7</em></td>
+ <td>No; defaults to default JVM character encoding</td>
</tr>
<tr>
- <td valign="top">force</td>
- <td valign="top">Overwrite read-only destination
- files. <em>since Ant 1.8.2</em></td>
- <td valign="top" align="center">No; defaults to false.</td>
+ <td>force</td>
+ <td>Overwrite read-only destination files. <em>since Ant 1.8.2</em></td>
+ <td>No; defaults to <q>false</q></td>
</tr>
</table>
<h3>Examples</h3>
-<pre>
-<echo message="Hello, world"/>
-</pre>
-<pre>
-<echo message="Embed a line break:${line.separator}"/>
-</pre>
-<pre>
-<echo>Embed another:${line.separator}</echo>
-</pre>
-<pre>
-<echo>This is a longer message stretching over
+<pre><echo message="Hello, world"/></pre>
+<pre><echo message="Embed a line break:${line.separator}"/></pre>
+<pre><echo>Embed another:${line.separator}</echo></pre>
+<pre><echo>This is a longer message stretching over
two lines.
-</echo>
-</pre>
-<pre>
-<echo>
+</echo></pre>
+<pre><echo>
This is a longer message stretching over
three lines; the first line is a blank
-</echo>
-</pre>
-The newline immediately following the <echo> tag will be part of the output.<br>
-Newlines in character data within the content of an element are not discarded by XML parsers.<br>
-See <a href="http://www.w3.org/TR/2004/REC-xml-20040204/#sec-line-ends">
-W3C Recommendation 04 February 2004 / End of Line handling
-</a> for more details.
+</echo></pre>
+<p>The newline immediately following the <code><echo></code> tag will be part of the
+output. Newlines in character data within the content of an element are not discarded by XML
+parsers.<br/>See <a href="https://www.w3.org/TR/xml/#sec-line-ends">W3C Recommendation 26 November
+2008 / End of Line handling</a> for more details.</p>
<pre><echo message="Deleting drive C:" level="debug"/></pre>
-A message which only appears in <tt>-debug</tt> mode.
+<p>A message which only appears in <code>-debug</code> mode.</p>
<pre><echo level="error">
Imminent failure in the antimatter containment facility.
Please withdraw to safe location at least 50km away.
-</echo>
-</pre>
-A message which appears even in <tt>-quiet</tt> mode.
+</echo></pre>
+<p>A message which appears even in <code>-quiet</code> mode.</p>
<pre><echo file="runner.csh" append="false">#\!/bin/tcsh
java-1.3.1 -mx1024m ${project.entrypoint} $$*
</echo></pre>
-Generate a shell script by echoing to a file.
-Note the use of a double $ symbol to stop Ant
-filtering out the single $ during variable expansion
+<p>Generate a shell script by echoing to a file. Note the use of a double <q>$</q> symbol to stop
+Ant filtering out the single <q>$</q> during variable expansion.</p>
-<p>Depending on the loglevel Ant runs, messages are print out or silently
-ignored:
+<p>Depending on the log level Ant runs at, messages are print out or silently ignored:</p>
<table>
<tr>
- <th>Ant-Statement</th>
- <th>-quiet, -q</th>
- <th><i>no statement</i></th>
- <th>-verbose, -v</th>
- <th>-debug, -d</th>
+ <th>Ant command line</th>
+ <th><code>-quiet</code>, <code>-q</code></th>
+ <th><em>no switch</em></th>
+ <th><code>-verbose</code>, <code>-v</code></th>
+ <th><code>-debug</code>, <code>-d</code></th>
</tr>
<tr>
- <td><pre><echo message="This is error message." level="error" /></pre></td>
- <td align="center">ok</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
+ <td><pre><echo message="This is error message." level="error"/></pre></td>
+ <td>ok</td>
+ <td>ok</td>
+ <td>ok</td>
+ <td>ok</td>
</tr>
<tr>
- <td><pre><echo message="This is warning message." /></pre></td>
- <td align="center">ok</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
+ <td><pre><echo message="This is warning message."/></pre></td>
+ <td>ok</td>
+ <td>ok</td>
+ <td>ok</td>
+ <td>ok</td>
</tr>
<tr>
- <td><pre><echo message="This is warning message." level="warning" /></pre></td>
- <td align="center">ok</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
+ <td><pre><echo message="This is warning message." level="warning"/></pre></td>
+ <td>ok</td>
+ <td>ok</td>
+ <td>ok</td>
+ <td>ok</td>
</tr>
<tr>
- <td><pre><echo message="This is info message." level="info" /></pre></td>
- <td align="center">not logged</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
+ <td><pre><echo message="This is info message." level="info"/></pre></td>
+ <td>not logged</td>
+ <td>ok</td>
+ <td>ok</td>
+ <td>ok</td>
</tr>
<tr>
- <td><pre><echo message="This is verbose message." level="verbose" /></pre></td>
- <td align="center">not logged</td>
- <td align="center">not logged</td>
- <td align="center">ok</td>
- <td align="center">ok</td>
+ <td><pre><echo message="This is verbose message." level="verbose"/></pre></td>
+ <td>not logged</td>
+ <td>not logged</td>
+ <td>ok</td>
+ <td>ok</td>
</tr>
<tr>
- <td><pre><echo message="This is debug message." level="debug" /></pre></td>
- <td align="center">not logged</td>
- <td align="center">not logged</td>
- <td align="center">not logged</td>
- <td align="center">ok</td>
+ <td><pre><echo message="This is debug message." level="debug"/></pre></td>
+ <td>not logged</td>
+ <td>not logged</td>
+ <td>not logged</td>
+ <td>ok</td>
</tr>
</table>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/echoproperties.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/echoproperties.html b/manual/Tasks/echoproperties.html
index bb81568..b30bd86 100644
--- a/manual/Tasks/echoproperties.html
+++ b/manual/Tasks/echoproperties.html
@@ -27,59 +27,50 @@
<h2 id="echoproperties">echoproperties</h2>
<h3>Description</h3>
-<p>Displays all the current properties (or a subset of them specified
-by a nested <code><propertyset></code>) in the project. The
-output can be sent to a file if desired. This task can be used as a
-somewhat contrived means of returning data from an
-<tt><ant></tt> invocation, but is really for debugging build
+<p>Displays all the current properties (or a subset of them specified by a
+nested <code><propertyset></code>) in the project. The output can be sent to a file if
+desired. This task can be used as a somewhat contrived means of returning data from an
+<code>ant</code> invocation, but is really for debugging build
files.</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">destfile</td>
- <td valign="top">If specified, the value indicates the name of the
- file to send the output of the statement to. The generated output file
- is compatible for loading by any Java application as a property file.
- If not specified, then the output will go to the Apache Ant log.</td>
- <td valign="top" align="center">No</td>
+ <td>destfile</td>
+ <td>If specified, the value indicates the name of the file to send the output of the statement
+ to. The generated output file is compatible for loading by any Java application as a property
+ file.</td>
+ <td>No; by default, output to the log</td>
</tr>
<tr>
- <td valign="top">prefix</td>
- <td valign="top">
- a prefix which is used to filter the properties:
- only properties whose names start with this prefix will be echoed.
- </td>
- <td valign="top" align="center">No</td>
+ <td>prefix</td>
+ <td>a prefix which is used to filter the properties: only properties whose names start with this
+ prefix will be echoed.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">regex</td>
- <td valign="top">
- a regular expression which is used to filter the
- properties:
- only those properties whose names match it will be echoed.
- </td>
- <td valign="top" align="center">No</td>
+ <td>regex</td>
+ <td>a regular expression which is used to filter the properties: only those properties whose
+ names match it will be echoed.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">failonerror</td>
- <td valign="top">By default, the "failonerror" attribute is enabled.
- If an error occurs while writing the properties to a file, and this
- attribute is enabled, then a BuildException will be thrown, causing the
- build to fail. If disabled, then IO errors will be reported as a log
- statement, and the build will continue without failure from this task.</td>
- <td valign="top" align="center">No</td>
+ <td>failonerror</td>
+ <td>If an error occurs while writing the properties to a file, and this attribute is enabled,
+ then a BuildException will be thrown, causing the build to fail. If disabled, then IO errors
+ will be reported as a log statement, and the build will continue without failure from this
+ task.</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">format</td>
- <td valign="top">One of <code>text</code> or <code>xml</code>.
- Determines the output format. Defaults to <code>text</code>.</td>
- <td valign="top" align="center">No</td>
+ <td>format</td>
+ <td>One of <q>text</q> or <q>xml</q>. Determines the output format.</td>
+ <td>No; defaults to <q>text</q></td>
</tr>
</table>
@@ -87,12 +78,10 @@ files.</p>
<h4>propertyset</h4>
-<p>You can specify subsets of properties to be echoed with <a
-href="../Types/propertyset.html">propertyset</a>s. Using
-<tt>propertyset</tt>s gives more control on which properties will be
-picked up. The attributes <tt>prefix</tt> and <tt>regex</tt> are just
-shortcuts that use <tt>propertyset</tt>s internally.
-</p>
+<p>You can specify subsets of properties to be echoed
+with <a href="../Types/propertyset.html">propertyset</a>s. Using <code>propertyset</code>s gives
+more control on which properties will be picked up. The attributes <var>prefix</var>
+and <var>regex</var> are just shortcuts that use <code>propertyset</code>s internally.</p>
<p><em>since Ant 1.6</em>.</p>
@@ -100,33 +89,30 @@ shortcuts that use <tt>propertyset</tt>s internally.
<pre><echoproperties/></pre>
<p>Report the current properties to the log.</p>
<pre><echoproperties destfile="my.properties"/></pre>
-<p>Report the current properties to the file "my.properties", and will
-fail the build if the file could not be created or written to.</p>
+<p>Report the current properties to the file <samp>my.properties</samp>, and will fail the build if
+the file could not be created or written to.</p>
<pre><echoproperties destfile="my.properties" failonerror="false"/></pre>
-<p>Report the current properties to the file "my.properties", and will
-log a message if the file could not be created or written to, but will still
-allow the build to continue.</p>
+<p>Report the current properties to the file <samp>my.properties</samp>, and will log a message if
+the file could not be created or written to, but will still allow the build to continue.</p>
<pre><echoproperties prefix="java."/></pre>
-<p>List all properties beginning with "java."</p>
+<p>List all properties beginning with <samp>java.</samp></p>
<pre>
- <echoproperties>
- <propertyset>
- <propertyref prefix="java."/>
- </propertyset>
- </echoproperties>
-</pre>
-<p>This again lists all properties beginning with "java." using a nested
-<tt></propertyset></tt> which is an equivalent but longer way.</p>
+<echoproperties>
+ <propertyset>
+ <propertyref prefix="java."/>
+ </propertyset>
+</echoproperties></pre>
+<p>This again lists all properties beginning with <samp>java.</samp> using a
+nested <code><propertyset/></code> which is an equivalent but longer way.</p>
<pre><echoproperties regex=".*ant.*"/></pre>
-<p>Lists all properties that contain "ant" in their names.
-The equivalent snippet with <tt></propertyset></tt> is:</p>
+<p>Lists all properties that contain <samp>ant</samp> in their names. The equivalent snippet
+with <code><propertyset/></code> is:</p>
<pre>
- <echoproperties>
- <propertyset>
- <propertyref regex=".*ant.*"/>
- </propertyset>
- </echoproperties>
-</pre>
+<echoproperties>
+ <propertyset>
+ <propertyref regex=".*ant.*"/>
+ </propertyset>
+</echoproperties></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/echoxml.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/echoxml.html b/manual/Tasks/echoxml.html
index c0dec59..dd5a63e 100644
--- a/manual/Tasks/echoxml.html
+++ b/manual/Tasks/echoxml.html
@@ -28,35 +28,32 @@
<h3>Description</h3>
<p>Echo nested XML to the console or a file. <em>Since Apache Ant 1.7</em></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">file</td>
- <td valign="top">The file to receive the XML. If omitted nested
- XML will be echoed to the log.</td>
- <td valign="top" align="center">No</td>
+ <td>file</td>
+ <td>The file to receive the XML.</td>
+ <td>No; by default nested XML is echoed to the log</td>
</tr>
<tr>
- <td valign="top">append</td>
- <td valign="top">Whether to append <code>file</code>, if specified.</td>
- <td valign="top" align="center">No</td>
+ <td>append</td>
+ <td>Whether to append <var>file</var>, if specified.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">namespacePolicy</td>
- <td valign="top">Sets the namespace policy as defined
- by <code>org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy</code>.
- Valid values are <code>ignore</code>, <code>elementsOnly</code>, or <code>all</code>.
- <em>Since Apache Ant 1.8</em>
- </td>
- <td valign="top" align="center">No, default <code>ignore</code></td>
+ <td>namespacePolicy</td>
+ <td>Sets the namespace policy as defined
+ by <code>org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy</code>. Valid values
+ are <q>ignore</q>, <q>elementsOnly</q>, or <q>all</q>. <em>Since Apache Ant 1.8</em></td>
+ <td>No; default <q>ignore</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
-Nested XML content is required.
+<p>Nested XML content is required.</p>
<h3>Examples</h3>
<pre><echoxml file="subbuild.xml">
@@ -65,9 +62,8 @@ Nested XML content is required.
<echo>foo</echo>
</target>
</project>
-</echoxml>
-</pre>
-<p>Creates an Ant buildfile, <code>subbuild.xml</code>.</p>
+</echoxml></pre>
+<p>Creates an Ant buildfile, <samp>subbuild.xml</samp>.</p>
</body>
</html>