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:43 UTC
[28/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/pathconvert.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/pathconvert.html b/manual/Tasks/pathconvert.html
index d1485ec..15ed82a 100644
--- a/manual/Tasks/pathconvert.html
+++ b/manual/Tasks/pathconvert.html
@@ -26,197 +26,154 @@
<h2 id="pathconvert">Pathconvert</h2>
<h3>Description</h3>
-<p>Converts nested <a href="../Types/resources.html#collection">
-ResourceCollection</a>s, or a reference to just one, into a path
-form for a particular platform, optionally storing the result into
-a given property. It can also be used when you need
-to convert a Resource Collection into a list, separated by a given
-character, such as a comma or space, or, conversely, e.g. to convert a list
-of files in a FileList into a path.
-</p>
-<p>Nested <code><map></code> elements can be specified to map Windows
-drive letters to Unix paths, and vice-versa.</p>
-<p>More complex transformations can be achieved using a nested
-<a href="../Types/mapper.html"><code><mapper></code></a>
-(<em>since Apache Ant 1.6.2</em>).
-</p>
+<p>Converts nested <a href="../Types/resources.html#collection"> ResourceCollection</a>s, or a
+reference to just one, into a path form for a particular platform, optionally storing the result
+into a given property. It can also be used when you need to convert a Resource Collection into a
+list, separated by a given character, such as a comma or space, or, conversely, e.g. to convert a
+list of files in a FileList into a path.</p>
+<p>Nested <code><map></code> elements can be specified to map Windows drive letters to Unix
+paths, and vice-versa.</p>
+<p>More complex transformations can be achieved using a
+nested <a href="../Types/mapper.html"><code><mapper></code></a> (<em>since Apache Ant
+1.6.2</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">targetos</td>
- <td valign="top">
- The target architecture. Must be one of 'unix', 'windows',
- 'netware', 'tandem' or 'os/2'.
- This is a shorthand mechanism for specifying both
- <code>pathsep</code> and <code>dirsep</code>
- according to the specified target architecture.
- </td>
- <td valign="top" align="center">No</td>
+ <td>targetos</td>
+ <td>The target architecture. Must be one
+ of <q>unix</q>, <q>windows</q>, <q>netware</q>, <q>tandem</q> or <q>os/2</q>. This is a
+ shorthand mechanism for specifying both <var>pathsep</var> and <var>dirsep</var> according
+ to the specified target architecture.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">dirsep</td>
- <td valign="top">
- The character(s) to use as the directory separator in the
- generated paths.
- </td>
- <td valign="top" align="center">No, defaults to current JVM <tt>File.separator</tt></td>
+ <td>dirsep</td>
+ <td>The character(s) to use as the directory separator in the generated paths.</td>
+ <td>No; defaults to current JVM <code>File.separator</code></td>
</tr>
<tr>
- <td valign="top">pathsep</td>
- <td valign="top">
- The character(s) to use as the path-element separator in the
- generated paths.
- </td>
- <td valign="top" align="center">No, defaults to current JVM <tt>File.pathSeparator</tt></td>
+ <td>pathsep</td>
+ <td>The character(s) to use as the path-element separator in the generated paths.</td>
+ <td>No; defaults to current JVM <code>File.pathSeparator</code></td>
</tr>
<tr>
- <td valign="top">property</td>
- <td valign="top">The name of the property in which to place the converted path.</td>
- <td valign="top" align="center">No, result will be logged if unset</td>
+ <td>property</td>
+ <td>The name of the property in which to place the converted path.</td>
+ <td>No, result will be logged if unset</td>
</tr>
<tr>
- <td valign="top">refid</td>
- <td valign="top">What to convert, given as a
- <a href="../using.html#references">reference</a> to a
- <code><path></code>, <code><fileset></code>,
- <code><dirset></code>, or <code><filelist></code>
- defined elsewhere</td>
- <td valign="top" align="center">No; if omitted, a nested
- <code><path></code> element must be supplied.</td>
+ <td>refid</td>
+ <td>What to convert, given as a <a href="../using.html#references">reference</a> to
+ a <code><path></code>, <code><fileset></code>, <code><dirset></code>,
+ or <code><filelist></code> defined elsewhere</td>
+ <td>Yes, unless a nested <code><path></code> element is supplied</td>
</tr>
<tr>
- <td valign="top">setonempty</td>
- <td valign="top">Should the property be set, even if the result
- is the empty string?
- <td valign="top" align="center">No; default is "true".
+ <td>setonempty</td>
+ <td>Should the property be set, even if the result is the empty string?</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">preserveduplicates</td>
- <td valign="top">Whether to preserve duplicate resources. <em>Since Ant 1.8</em></td>
- <td valign="top" align="center">No; default "false".
+ <td>preserveduplicates</td>
+ <td>Whether to preserve duplicate resources. <em>Since Ant 1.8</em></td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>map</h4>
<p>Specifies the mapping of path prefixes between Unix and Windows.</p>
-<table>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">from</td>
- <td valign="top">
- The prefix to match. Note that this value is case-insensitive when
- the build is running on a Windows platform and case-sensitive
- when running on a Unix platform.
- <em>Since Ant 1.7.0</em>, on Windows this value is also insensitive
- to the slash style used for directories, one can use '/' or '\'.
- </td>
- <td valign="top" align="center">Yes</td>
+ <td>from</td>
+ <td>The prefix to match. Note that this value is case-insensitive when the build is running on
+ a Windows platform and case-sensitive when running on a Unix platform. <em>Since Ant
+ 1.7.0</em>, on Windows this value is also insensitive to the slash style used for directories,
+ one can use <q>/</q> or <q>\</q>.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">to</td>
- <td valign="top">The replacement text to use when <code>from</code> is matched.</td>
- <td valign="top" align="center">Yes</td>
+ <td>to</td>
+ <td>The replacement text to use when <var>from</var> is matched.</td>
+ <td>Yes</td>
</tr>
</table>
-<p>Each map element specifies a single replacement map to be applied to the elements of
- the path being processed. If no map entries are specified, then no path prefix mapping
- is performed.
-</p>
-<p><strong>Note</strong>: The map elements are applied in the order specified,
-and only the first matching map element is applied. So, the ordering of
-your map elements can be important, if any <code>from</code> values are
-prefixes of other <code>from</code> values.
-</p>
+<p>Each map element specifies a single replacement map to be applied to the elements of the path
+being processed. If no map entries are specified, then no path prefix mapping is performed.</p>
+<p><strong>Note</strong>: The map elements are applied in the order specified, and only the first
+matching map element is applied. So, the ordering of your map elements can be important, if
+any <var>from</var> values are prefixes of other <var>from</var> values.</p>
<h4>Resource Collections</h4>
-<p>If the <code>refid</code> attribute is not specified, then one or more
- nested <a href="../Types/resources.html#collection">Resource
-Collection</a>s must be supplied.</p>
+<p>If the <var>refid</var> attribute is not specified, then one or more
+nested <a href="../Types/resources.html#collection">Resource Collection</a>s must be supplied.</p>
<h4>mapper</h4>
-<p>A single nested <a href="../Types/mapper.html">
-<code><mapper></code></a> element can be specified
-to perform any of various filename transformations (<em>since Ant 1.6.2</em>).
-</p>
+<p>A single nested <a href="../Types/mapper.html"> <code><mapper></code></a> element can be
+specified to perform any of various filename transformations (<em>since Ant 1.6.2</em>).</p>
<h3>Examples</h3>
-<p>In the examples below, assume that the <code>${wl.home}</code> property
-has the value
-<code>d:\weblogic</code>, and <code>${wl.home.unix}</code> has the value
-<code>/weblogic</code>.</p>
+<p>In the examples below, assume that the <samp>${wl.home}</samp> property has the
+value <samp>d:\weblogic</samp>, and <samp>${wl.home.unix}</samp> has the
+value <samp>/weblogic</samp>.</p>
<h4>Example 1</h4>
<pre>
- <path id="wl.path">
- <pathelement location="${wl.home}/lib/weblogicaux.jar"/>
- <pathelement location="${wl.home}/classes"/>
- <pathelement location="${wl.home}/mssqlserver4/classes"/>
- <pathelement location="c:\winnt\System32"/>
- </path>
+<path id="wl.path">
+ <pathelement location="${wl.home}/lib/weblogicaux.jar"/>
+ <pathelement location="${wl.home}/classes"/>
+ <pathelement location="${wl.home}/mssqlserver4/classes"/>
+ <pathelement location="c:\winnt\System32"/>
+</path>
- <pathconvert targetos="unix" property="wl.path.unix" refid="wl.path">
- <map from="${wl.home}" to="${wl.home.unix}"/>
- <map from="c:" to=""/>
- </pathconvert>
-</pre>
-<p>
-will generate the path shown below and store it in the property named <code>wl.path.unix</code>.
-</p>
-<pre>
-/weblogic/lib/weblogicaux.jar:/weblogic/classes:/weblogic/mssqlserver4/classes:/WINNT/SYSTEM32
-</pre>
+<pathconvert targetos="unix" property="wl.path.unix" refid="wl.path">
+ <map from="${wl.home}" to="${wl.home.unix}"/>
+ <map from="c:" to=""/>
+</pathconvert></pre>
+<p>will generate the path shown below and store it in the property
+named <code>wl.path.unix</code>.</p>
+<pre>/weblogic/lib/weblogicaux.jar:/weblogic/classes:/weblogic/mssqlserver4/classes:/WINNT/SYSTEM32</pre>
<h4>Example 2</h4>
-Given a FileList defined as:
-<pre>
- <filelist id="custom_tasks.jars"
- dir="${env.HOME}/ant/lib"
- files="njavac.jar,xproperty.jar"/>
-</pre>
-then:
+<p>Given a FileList defined as:</p>
<pre>
- <pathconvert targetos="unix" property="custom_tasks.jars" refid="custom_tasks.jars">
- <map from="${env.HOME}" to="/usr/local"/>
- </pathconvert>
-</pre>
-will convert the list of files to the following Unix path:
+<filelist id="custom_tasks.jars"
+ dir="${env.HOME}/ant/lib"
+ files="njavac.jar,xproperty.jar"/></pre>
+<p>then:</p>
<pre>
-/usr/local/ant/lib/njavac.jar:/usr/local/ant/lib/xproperty.jar
-</pre>
+<pathconvert targetos="unix" property="custom_tasks.jars" refid="custom_tasks.jars">
+ <map from="${env.HOME}" to="/usr/local"/>
+</pathconvert></pre>
+<p>will convert the list of files to the following Unix path:</p>
+<pre>/usr/local/ant/lib/njavac.jar:/usr/local/ant/lib/xproperty.jar</pre>
<h4>Example 3</h4>
<pre>
- <fileset dir="${src.dir}" id="src.files">
- <include name="**/*.java"/>
- </fileset>
+<fileset dir="${src.dir}" id="src.files">
+ <include name="**/*.java"/>
+</fileset>
- <pathconvert pathsep="," property="javafiles" refid="src.files"/>
-</pre>
+<pathconvert pathsep="," property="javafiles" refid="src.files"/></pre>
<p>This example takes the set of files determined by the fileset (all files ending
-in <tt>.java</tt>), joins them together separated by commas, and places the resulting
-list into the property <tt>javafiles</tt>. The directory separator is not specified, so
-it defaults to the appropriate character for the current platform. Such a list could
-then be used in another task, like <tt>javadoc</tt>, that requires a comma separated
-list of files.
-</p>
+in <samp>.java</samp>), joins them together separated by commas, and places the resulting list into
+the property <code>javafiles</code>. The directory separator is not specified, so it defaults to
+the appropriate character for the current platform. Such a list could then be used in another task,
+like <code>javadoc</code>, that requires a comma separated list of files.</p>
<h4>Example 4</h4>
<pre>
- <pathconvert property="prop" dirsep="|">
- <map from="${basedir}/abc/" to=''/>
- <path location="abc/def/ghi"/>
- </pathconvert>
-</pre>
- <p>
- This example sets the property "prop" to "def|ghi" on
- Windows and on Unix.
- </p>
+<pathconvert property="prop" dirsep="|">
+ <map from="${basedir}/abc/" to=""/>
+ <path location="abc/def/ghi"/>
+</pathconvert></pre>
+<p>This example sets the property <code>prop</code> to <q>def|ghi</q> on Windows and on Unix.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/presetdef.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/presetdef.html b/manual/Tasks/presetdef.html
index 8becea2..d5c984d 100644
--- a/manual/Tasks/presetdef.html
+++ b/manual/Tasks/presetdef.html
@@ -26,72 +26,55 @@
<h2 id="presetdef">PreSetDef</h2>
<h3>Description</h3>
- <p>
- The preset definition generates a new definition
- based on a current definition with some attributes
- or elements preset.
- </p>
- <p>
- <em>since Apache Ant 1.6</em>
- </p>
- <p>
- The resolution of properties in any of the attributes or
- nested text takes place with the definition is used and <em>not</em>
- when the preset definition is defined.
- </p>
+ <p>The preset definition generates a new definition based on a current definition with some
+ attributes or elements preset.</p>
+ <p><em>since Apache Ant 1.6</em></p>
+ <p>The resolution of properties in any of the attributes or nested text takes place with the
+ definition is used and <em>not</em> when the preset definition is defined.</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">name</td>
- <td valign="top">the name of the new definition</td>
- <td valign="top" align="center">Yes</td>
+ <td>name</td>
+ <td>the name of the new definition</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">uri</td>
- <td valign="top">
- The uri that this definition should live in.
- </td>
- <td valign="top" align="center">No</td>
+ <td>uri</td>
+ <td>The URI that this definition should live in.</td>
+ <td>No</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>another type with attributes or elements set</h4>
- <p>The <code><presetdef></code> task takes one nested element as a parameter.
- This nested element can be any other type or task. The attributes
- and elements that need to be preset are placed here.
- </p>
+ <p>The <code><presetdef></code> task takes one nested element as a parameter. This nested
+ element can be any other type or task. The attributes and elements that need to be preset are
+ placed here.</p>
<h3>Examples</h3>
- The following fragment defines a javac task with the debug, deprecation
- srcdir and destdir
- attributes set. It also has a src element to source files from a generated
- directory.
-<pre class="code">
+ <p>The following fragment defines a <code>javac</code> task with
+ the <var>debug</var>, <var>deprecation</var>, <var>srcdir</var> and <var>destdir</var>
+ attributes set. It also has a <code>src</code> element to source files from a generated
+ directory.</p>
+ <pre class="code">
<presetdef name="my.javac">
<javac debug="${debug}" deprecation="${deprecation}"
srcdir="${src.dir}" destdir="${classes.dir}">
<src path="${gen.dir}"/>
</javac>
-</presetdef>
-</pre>
- This can be used as a normal javac task - example:
-<pre class="code">
-<my.javac/>
-</pre>
- The attributes specified in the preset task may be overridden - i.e.
- they may be seen as optional attributes - example:
-<pre class="code">
-<my.javac srcdir="${test.src}" deprecation="no"/>
-</pre>
- One may put a presetdef definition in an antlib.
- For example suppose the jar file antgoodies.jar has
- the antlib.xml as follows:
-<pre class="code">
+</presetdef></pre>
+ <p>This can be used as a normal <code>javac</code> task—for example:</p>
+ <pre class="code"><my.javac/></pre>
+ <p>The attributes specified in the preset task may be overridden—i.e. they may be seen as
+ optional attributes—for example:</p>
+ <pre class="code"><my.javac srcdir="${test.src}" deprecation="no"/></pre>
+ <p>One may put a <code>presetdef</code> definition in an antlib. For example suppose the jar
+ file <samp>antgoodies.jar</samp> has the <samp>antlib.xml</samp> as follows:</p>
+ <pre class="code">
<antlib>
<taskdef resource="com/acme/antgoodies/tasks.properties"/>
<!-- Implement the common use of the javac command -->
@@ -99,10 +82,9 @@
<javac deprecation="${deprecation}" debug="${debug}"
srcdir="src" destdir="classes"/>
</presetdef>
-</antlib>
-</pre>
- One may then use this in a build file as follows:
-<pre class="code">
+</antlib></pre>
+ <p>One may then use this in a build file as follows:</p>
+ <pre class="code">
<project default="example" xmlns:antgoodies="antlib:com.acme.antgoodies">
<target name="example">
<!-- Compile source -->
@@ -110,13 +92,9 @@
<!-- Compile test code -->
<antgoodies:javac srcdir="src/test"/>
</target>
-</project>
-</pre>
- <p>
- The following is an example of evaluation of properties when the
- definition is used:
- </p>
-<pre class="code">
+</project></pre>
+ <p>The following is an example of evaluation of properties when the definition is used:</p>
+ <pre class="code">
<target name="defineandcall">
<presetdef name="showmessage">
<echo>message is '${message}'</echo>
@@ -130,34 +108,26 @@
</target>
<target name="called">
<showmessage/>
-</target>
-</pre>
- <p>
- The command ant defineandcall results in the output:
- </p>
-<pre class="code">
+</target></pre>
+ <p>The command <code>ant defineandcall</code> results in the output:</p>
+ <pre class="code">
defineandcall:
[showmessage] message is '${message}'
[showmessage] message is 'Message 1'
called:
-[showmessage] message is 'Message 2'
-</pre>
-<p>
-It is possible to use a trick to evaluate properties when the definition is
-<em>made</em> rather than used. This can be useful if you do not expect some
-properties to be available in child builds run with
-<code><ant ... inheritall="false"></code>:
-</p>
-<pre class="code">
+[showmessage] message is 'Message 2'</pre>
+ <p>It is possible to use a trick to evaluate properties when the definition is <em>made</em>
+ rather than used. This can be useful if you do not expect some properties to be available in
+ child builds run with <code><ant ... inheritall="false"></code>:</p>
+ <pre class="code">
<macrodef name="showmessage-presetdef">
<attribute name="messageval"/>
<presetdef name="showmessage">
<echo>message is '@{messageval}'</echo>
</presetdef>
</macrodef>
-<showmessage-presetdef messageval="${message}"/>
-</pre>
+<showmessage-presetdef messageval="${message}"/></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/projecthelper.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/projecthelper.html b/manual/Tasks/projecthelper.html
index 986bf76..fc4b02c 100644
--- a/manual/Tasks/projecthelper.html
+++ b/manual/Tasks/projecthelper.html
@@ -26,29 +26,26 @@
<h2>ProjectHelper</h2>
<h3>Description</h3>
-<p>This task is provided for the purpose of allowing the user to install a different
-ProjectHelper at runtime.
-</p>
-<p>The helpers will be added after all the already registered helpers, but before
-the default one (ProjectHelper2)
-</p>
-<p>See the description of Apache Ant's
-<a href="../projecthelper.html">Project Helper</a> for more information.
-</p>
+<p>This task is provided for the purpose of allowing the user to install a different ProjectHelper
+at runtime.</p>
+<p>The helpers will be added after all the already registered helpers, but before the default one
+(<code>ProjectHelper2</code>)</p>
+<p>See the description of Apache Ant's <a href="../projecthelper.html">Project Helper</a> for more
+information.</p>
<p><em>Since Ant 1.8.2</em></p>
<h3>Parameters specified as nested elements</h3>
-You may specify many configured <code>org.apache.tools.ant.ProjectHelper</code> instances.
+<p>You may specify many configured <code>org.apache.tools.ant.ProjectHelper</code> instances.</p>
<h3>Example</h3>
-<p>Install a custom ProjectHelper implementation
- (assuming <code>MyProjectHelper extends ProjectHelper</code>):</p>
+<p>Install a custom ProjectHelper implementation (assuming <code>MyProjectHelper extends
+ProjectHelper</code>):</p>
<pre>
<typedef classname="org.example.MyProjectHelper"
- name="myprojecthelper"/>
+ name="myprojecthelper"/>
<projecthelper>
<myprojecthelper/>
</projecthelper>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/property.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/property.html b/manual/Tasks/property.html
index 31733c6..cedc323 100644
--- a/manual/Tasks/property.html
+++ b/manual/Tasks/property.html
@@ -26,276 +26,247 @@
<h2 id="property">Property</h2>
<h3>Description</h3>
-<p>Sets a <a href="../using.html#properties">property</a>
-(by name and value), or set of properties (from file or
-resource) in the project. Properties are case sensitive.</p>
- Properties are immutable: whoever sets a property first freezes it for the
- rest of the build; they are most definitely not variables.
+<p>Sets a <a href="../using.html#properties">property</a> (by name and value), or set of properties
+(from file or resource) in the project. Properties are case sensitive.</p>
+<p>Properties are immutable: whoever sets a property first freezes it for the rest of the build;
+they are most definitely not variables.</p>
<p>There are seven ways to set properties:</p>
<ul>
- <li>By supplying both the <i>name</i> and one of <i>value</i> or <i>location</i> attribute.</li>
- <li>By supplying the <i>name</i> and nested text.</li>
- <li>By supplying both the <i>name</i> and <i>refid</i> attribute.</li>
- <li>By setting the <i>file</i> attribute with the filename of the property
- file to load. This property file has the format as defined by the file used
- in the class java.util.Properties, with the same rules about how
- non-ISO8859-1 characters must be escaped.</li>
- <li>By setting the <i>url</i> attribute with the url from which to load the
- properties. This url must be directed to a file that has the format as defined
- by the file used in the class java.util.Properties.</li>
- <li>By setting the <i>resource</i> attribute with the resource name of the
- property file to load. A resource is a property file on the current
- classpath, or on the specified classpath.</li>
- <li>By setting the <i>environment</i> attribute with a prefix to use.
- Properties will be defined for every environment variable by
- prefixing the supplied name and a period to the name of the variable.</li>
+ <li>By supplying both the <var>name</var> and one of <var>value</var> or <var>location</var>
+ attributes.</li>
+ <li>By supplying the <var>name</var> and nested text.</li>
+ <li>By supplying both the <var>name</var> and <var>refid</var> attributes.</li>
+ <li>By setting the <var>file</var> attribute with the filename of the property file to load. This
+ property file has the format as defined by the file used in the
+ class <code>java.util.Properties</code>, with the same rules about how non-ISO-8859-1 characters
+ must be escaped.</li>
+ <li>By setting the <var>url</var> attribute with the URL from which to load the properties. This
+ URL must be directed to a file that has the format as defined by the file used in the
+ class <code>java.util.Properties</code>.</li>
+ <li>By setting the <var>resource</var> attribute with the resource name of the property file to
+ load. A resource is a property file on the current classpath, or on the specified
+ classpath.</li>
+ <li>By setting the <var>environment</var> attribute with a prefix to use. Properties will be
+ defined for every environment variable by prefixing the supplied name and a period to the name
+ of the variable.</li>
</ul>
-<p>Although combinations of these ways are possible, only one should be used
-at a time. Problems might occur with the order in which properties are set, for
-instance.</p>
-<p>The value part of the properties being set, might contain references to other
-properties. These references are resolved at the time these properties are set.
-This also holds for properties loaded from a property file.</p>
-<p>A list of predefined properties can be found <a
-href="../properties.html#built-in-props">here</a>.</p>
-<p><em>Since Apache Ant 1.8.0</em>, it is possible to load properties defined in xml
-according to <a href="http://java.sun.com/dtd/properties.dtd">Suns DTD</a>,
-if Java 5+ is present. For this the name of the file, resource or url has
-to end with <tt>.xml</tt>.</p>
+<p>Although combinations of these ways are possible, only one should be used at a time. Problems
+might occur with the order in which properties are set, for instance.</p>
+<p>The value part of the properties being set might contain references to other properties. These
+references are resolved at the time these properties are set. This also holds for properties loaded
+from a property file.</p>
+<p>A list of predefined properties can be
+found <a href="../properties.html#built-in-props">here</a>.</p>
+<p><em>Since Apache Ant 1.8.0</em>, it is possible to load properties defined in XML according
+to <a href="http://java.sun.com/dtd/properties.dtd">Sun DTD</a>, when running on Java 5+. For this
+the name of the file, resource or url has to end with <samp>.xml</samp>.</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">name</td>
- <td valign="top">the name of the property to set.</td>
- <td valign="top" align="center">No</td>
+ <td>name</td>
+ <td>the name of the property to set.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">the value of the property.</td>
- <td valign="middle" align="center" rowspan="3">One of these or
- nested text, when using the name attribute</td>
+ <td>value</td>
+ <td>the value of the property.</td>
+ <td rowspan="3">One of these or nested text, when the <var>name</var> attribute is set</td>
</tr>
<tr>
- <td valign="top">location</td>
- <td valign="top">Sets the property to the absolute filename of the
- given file. If the value of this attribute is an absolute path, it
- is left unchanged (with / and \ characters converted to the
- current platforms conventions). Otherwise it is taken as a path
- relative to the project's basedir and expanded.</td>
+ <td>location</td>
+ <td class="left">Sets the property to the absolute filename of the given file. If the value of
+ this attribute is an absolute path, it is left unchanged (with <q>/</q> and <q>\</q>
+ characters converted to the current platforms conventions). Otherwise it is taken as a path
+ relative to the project's <var>basedir</var> and expanded.</td>
</tr>
<tr>
- <td valign="top">refid</td>
- <td valign="top"><a href="../using.html#references">Reference</a> to an object
- defined elsewhere. Only yields reasonable results for references
- to <a href="../using.html#path">PATH like structures</a> or properties.</td>
+ <td>refid</td>
+ <td class="left"><a href="../using.html#references">Reference</a> to an object defined
+ elsewhere. Only yields reasonable results for references
+ to <a href="../using.html#path">path-like structures</a> or properties.</td>
</tr>
<tr>
- <td valign="top">resource</td>
- <td valign="top"> the name of the classpath resource containing
- properties settings in properties file format.</td>
- <td valign="middle" align="center" rowspan="4">One of these, when
- <b>not</b> using the name attribute</td>
+ <td>resource</td>
+ <td>the name of the classpath resource containing properties settings in properties file
+ format.</td>
+ <td rowspan="4">One of these, <strong>unless</strong> the <var>name</var> attribute is set</td>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">the location of the properties file to load.</td>
+ <td>file</td>
+ <td class="left">the location of the properties file to load.</td>
</tr>
<tr>
- <td valign="top">url</td>
- <td valign="top">a url containing properties-format settings.</td>
+ <td>url</td>
+ <td class="left">a URL containing properties-format settings.</td>
</tr>
<tr>
- <td valign="top">environment</td>
- <td valign="top">the prefix to use when retrieving environment variables. Thus
- if you specify environment="myenv" you will be able to access OS-specific
- environment variables via property names "myenv.PATH" or
- "myenv.TERM". Note that if you supply a property name with a final
- "." it will not be doubled; i.e. environment="myenv." will still
- allow access of environment variables through "myenv.PATH" and
- "myenv.TERM". This functionality is currently only implemented
- on <a href="#notes-env">select platforms</a>. Feel free to send patches to increase the
- number of platforms on which this functionality is supported ;).<br>
- Note also that properties are case-sensitive, even if the
- environment variables on your operating system are not; e.g. Windows 2000's
- system path variable is set to an Ant property named "env.Path"
- rather than "env.PATH".</td>
+ <td>environment</td>
+ <td class="left">the prefix to use when retrieving environment variables. Thus if you
+ specify <var>environment</var>=<q>myenv</q> you will be able to access OS-specific environment
+ variables via property names <code>myenv.PATH</code> or <code>myenv.TERM</code>. Note that if
+ you supply a property <var>name</var> with a final <q>.</q> it will not be doubled;
+ i.e. <var>environment</var>=<q>myenv.</q> will still allow access of environment variables
+ through <code>myenv.PATH</code> and <code>myenv.TERM</code>. This functionality is currently
+ only implemented on <a href="#notes-env">select platforms</a>. Feel free to send patches to
+ increase the number of platforms on which this functionality is supported ;-).<br/>Note also
+ that properties are case-sensitive, even if the environment variables on your operating system
+ are not; e.g. Windows 2000 or later system path variable is set to an Ant property
+ named <code>env.Path</code> rather than <code>env.PATH</code>.</td>
</tr>
<tr>
- <td valign="top">classpath</td>
- <td valign="top">the classpath to use when looking up a resource.</td>
- <td align="center" valign="top">No</td>
+ <td>classpath</td>
+ <td>the classpath to use when looking up a resource.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">classpathref</td>
- <td valign="top">the classpath to use when looking up a resource,
- given as <a href="../using.html#references">reference</a> to a <code><path></code> defined
+ <td>classpathref</td>
+ <td>the classpath to use when looking up a resource, given
+ as <a href="../using.html#references">reference</a> to a <code><path></code> defined
elsewhere..</td>
- <td align="center" valign="top">No</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">prefix</td>
- <td valign="top">Prefix to apply to properties loaded using <code>file</code>,
- <code>resource</code>, or <code>url</code>.
- A "." is appended to the prefix if not specified.</td>
- <td align="center" valign="top">No</td>
+ <td>prefix</td>
+ <td>Prefix to apply to properties loaded using <var>file</var>, <var>resource</var>,
+ or <var>url</var>. A <q>.</q> is appended to the prefix if not specified.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">prefixValues</td>
- <td valign="top">Whether to apply the prefix when expanding the
- right hand side of properties loaded using <code>file</code>,
- <code>resource</code>, or <code>url</code>.
- <em>Since Ant 1.8.2</em></td>
- <td align="center" valign="top">No (default=<tt>false</tt>)</td>
+ <td>prefixValues</td>
+ <td>Whether to apply the prefix when expanding the right hand side of properties loaded
+ using <var>file</var>, <var>resource</var>, or <var>url</var>. <em>Since Ant 1.8.2</em></td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">relative</td>
- <td valign="top">If set to <tt>true</tt> the relative path
- to <tt>basedir</tt> is set. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No (default=<tt>false</tt>)</td>
+ <td>relative</td>
+ <td>If set to <q>true</q> the relative path to <var>basedir</var> is set. <em>Since Ant
+ 1.8.0</em></td>
+ <td>No; default is <q>false</q></td>
</tr>
<tr>
- <td valign="top">basedir</td>
- <td valign="top">The basedir to calculate the relative path
- from. <em>Since Ant 1.8.0</em></td>
- <td align="center" valign="top">No (default=<tt>${basedir}</tt>)</td>
+ <td>basedir</td>
+ <td>The <var>basedir</var> to calculate the relative path from. <em>Since Ant 1.8.0</em></td>
+ <td>No; default is project's <var>basedir</var></td>
</tr>
</table>
<h4>OpenVMS Users</h4>
-<p>With the <code>environment</code> attribute this task will load all defined
-logicals on an OpenVMS system. Logicals with multiple equivalence names get
-mapped to a property whose value is a comma separated list of all equivalence
-names. If a logical is defined in multiple tables, only the most local
-definition is available (the table priority order being PROCESS, JOB, GROUP,
-SYSTEM).
-</p>
+<p>With the <var>environment</var> attribute this task will load all defined logicals on an OpenVMS
+system. Logicals with multiple equivalence names get mapped to a property whose value is a comma
+separated list of all equivalence names. If a logical is defined in multiple tables, only the most
+local definition is available (the table priority order being PROCESS, JOB, GROUP, SYSTEM).</p>
<h4>Any OS except OpenVMS</h4>
-<p><em>Since Ant 1.8.2</em>, if Ant detects it is running on a Java 5
- or newer VM, Ant will use <code>System.getenv</code> rather than
- its own OS dependent native implementation. For some OSes this
- causes minor differences when compared to older versions of Ant.
- For a full list
- see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=49366">Bugzilla
- Issue 49366</a>. In particular:</p>
+<p><em>Since Ant 1.8.2</em>, if Ant detects it is running on a Java 5 or newer, Ant will
+use <code>System.getenv()</code> rather than its own OS dependent native implementation. For some
+OSes this causes minor differences when compared to older versions of Ant. For a full list
+see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=49366">Bugzilla Issue 49366</a>. In
+particular:</p>
<ul>
- <li>On Windows, Ant will now return additional "environment
- variables" that correspond to the drive specific current working
- directories when Ant is run from the command line. The keys of
+ <li>On Windows, Ant will now return additional "environment variables" that correspond to the
+ drive specific current working directories when Ant is run from the command line. The keys of
these variables starts with an equals sign.</li>
- <li>Some users reported that some Cygwin specific variables (in
- particular PROMPT) was no longer present.</li>
- <li>On OS/2, Ant no longer returns the BEGINLIBPATH variable.</li>
+ <li>Some users reported that some Cygwin specific variables (in particular <code>PROMPT</code>)
+ was no longer present.</li>
+ <li>On OS/2, Ant no longer returns the <code>BEGINLIBPATH</code> variable.</li>
</ul>
<h3>Parameters specified as nested elements</h3>
<h4>classpath</h4>
-<p><code>Property</code>'s <i>classpath</i> attribute is a <a
-href="../using.html#path">PATH like structure</a> and can also be set via a nested
-<i>classpath</i> element.</p>
+<p><code>Property</code>'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>
<h3>Examples</h3>
-<pre> <property name="foo.dist" value="dist"/></pre>
-<p>sets the property <code>foo.dist</code> to the value "dist".</p>
+<pre><property name="foo.dist" value="dist"/></pre>
+<p>sets the property <code>foo.dist</code> to the value <q>dist</q>.</p>
-<pre> <property name="foo.dist">dist</property></pre>
-<p>sets the property <code>foo.dist</code> to the value "dist".</p>
+<pre><property name="foo.dist">dist</property></pre>
+<p>sets the property <code>foo.dist</code> to the value <q>dist</q>.</p>
-<pre> <property file="foo.properties"/></pre>
-<p>reads a set of properties from a file called "foo.properties".</p>
+<pre><property file="foo.properties"/></pre>
+<p>reads a set of properties from a file called <samp>foo.properties</samp>.</p>
-<pre> <property url="http://www.mysite.com/bla/props/foo.properties"/></pre>
-<p>reads a set of properties from the address "http://www.mysite.com/bla/props/foo.properties".</p>
+<pre><property url="http://www.mysite.com/bla/props/foo.properties"/></pre>
+<p>reads a set of properties from the
+address <samp>http://www.mysite.com/bla/props/foo.properties</samp>.</p>
-<pre> <property resource="foo.properties"/></pre>
-<p>reads a set of properties from a resource called "foo.properties".</p>
-<p>Note that you can reference a global properties file for all of your Ant
-builds using the following:</p>
+<pre><property resource="foo.properties"/></pre>
+<p>reads a set of properties from a resource called <samp>foo.properties</samp>.</p>
+<p>Note that you can reference a global properties file for all of your Ant builds using the
+following:</p>
-<pre> <property file="${user.home}/.ant-global.properties"/></pre>
-<p>since the "user.home" property is defined by the Java virtual machine
-to be your home directory. Where the "user.home" property resolves to in
-the file system depends on the operating system version and the JVM implementation.
-On Unix based systems, this will map to the user's home directory. On modern Windows
-variants, this will most likely resolve to the user's directory in the "Documents
-and Settings" or "Users" folder. Older windows variants such as Windows 98/ME are less
-predictable, as are other operating system/JVM combinations.</p>
+<pre><property file="${user.home}/.ant-global.properties"/></pre>
+<p>since the <code>user.home</code> property is defined by JVM to be your home directory. Where
+the <code>user.home</code> property resolves to in the file system depends on the operating system
+version and the JVM implementation. On Unix based systems, this will map to the user's home
+directory. On modern Windows variants, this will most likely resolve to the user's directory in
+the <samp>Documents and Settings</samp> or <samp>Users</samp> folder. Older Windows variants such as
+Windows 98/ME are less predictable, as are other operating system/JVM combinations.</p>
<pre>
- <property environment="env"/>
- <echo message="Number of Processors = ${env.NUMBER_OF_PROCESSORS}"/>
- <echo message="ANT_HOME is set to = ${env.ANT_HOME}"/>
-</pre>
-<p>reads the system environment variables and stores them in properties, prefixed with "env".
-Note that this only works on <em>select</em> operating systems.
-Two of the values are shown being echoed.
+<property environment="env"/>
+<echo message="Number of Processors = ${env.NUMBER_OF_PROCESSORS}"/>
+<echo message="ANT_HOME is set to = ${env.ANT_HOME}"/></pre>
+<p>reads the system environment variables and stores them in properties, prefixed with <q>env</q>.
+Note that this only works on <em>select</em> operating systems. Two of the values are shown being
+echoed.
</p>
<pre>
- <property environment="env"/>
- <property file="${user.name}.properties"/>
- <property file="${env.STAGE}.properties"/>
- <property file="build.properties"/>
-</pre>
-<p>This buildfile uses the properties defined in <tt>build.properties</tt>. Regarding to the
-environment variable <tt>STAGE</tt> some or all values could be overwritten, e.g. having
-<tt>STAGE=test</tt> and a <tt>test.properties</tt> you have special values for that (like another
-name for the test server). Finally all these values could be overwritten by personal settings with
-a file per user.</p>
-
-<pre>
- <property name="foo" location="my/file.txt" relative="true" basedir=".."/>
-</pre>
-<p>Stores the relative path in <tt>foo</tt>: projectbasedir/my/file.txt</p>
+<property environment="env"/>
+<property file="${user.name}.properties"/>
+<property file="${env.STAGE}.properties"/>
+<property file="build.properties"/></pre>
+<p>This buildfile uses the properties defined in <samp>build.properties</samp>. Regarding to the
+environment variable <code>STAGE</code> some or all values could be overwritten,
+e.g. having <code>STAGE=test</code> and a <samp>test.properties</samp> you have special values for
+that (like another name for the test server). Finally all these values could be overwritten by
+personal settings with a file per user.</p>
-<pre>
- <property name="foo" location="my/file.txt" relative="true" basedir="cvs"/>
-</pre>
-<p>Stores the relative path in <tt>foo</tt>: ../my/file.txt</p>
+<pre><property name="foo" location="my/file.txt" relative="true" basedir=".."/></pre>
+<p>Stores the relative path in <code>foo</code>: <samp>../my/file.txt</samp></p>
+<pre><property name="foo" location="my/file.txt" relative="true" basedir="cvs"/></pre>
+<p>Stores the relative path in <code>foo</code>: <samp>cvs/my/file.txt</samp></p>
<h3>Property Files</h3>
-As stated, this task will load in a properties file stored in the file
-system, or as a resource on a classpath. Here are some interesting facts
-about this feature
+<p>As stated, this task will load in a properties file stored in the file system, or as a resource
+on a classpath. Here are some interesting facts about this feature</p>
<ol>
-<li>If the file is not there, nothing is printed except at -verbose log
-level. This lets you have optional configuration files for every
-project, that team members can customize.
-<li>The rules for this format match <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Properties.html#load%28java.io.InputStream%29">java.util.Properties</a>.</li>
-<li>Trailing spaces are not stripped. It may have been what you wanted.</li>
-<li>Want unusual characters? Escape them \u0456 or \" style.</li>
-<li>Ant Properties are expanded in the file</li>
-<li>If you want to expand properties defined inside the same file and
- you use the prefix attribute of the task, you must use the same
- prefix when expanding the properties or
- set <code>prefixValues</code> to true.</li>
+ <li>If the file is not there, nothing is printed except at <code>-verbose</code> log level. This
+ lets you have optional configuration files for every project, that team members can customize.
+ <li>The rules for this format
+ match <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html#load-java.io.InputStream-">java.util.Properties</a>.</li>
+ <li>Trailing spaces are not stripped. It may have been what you wanted.</li>
+ <li>Want unusual characters? Escape them <code>\u0456</code> or <code>\"</code> style.</li>
+ <li>Ant Properties are expanded in the file</li>
+ <li>If you want to expand properties defined inside the same file and you use
+ the <var>prefix</var> attribute of the task, you must use the same prefix when expanding the
+ properties or set <var>prefixValues</var> to <q>true</q>.</li>
</ol>
-In-file property expansion is very cool. Learn to use it.
-<p>
-Example:
+<p>In-file property expansion is very cool. Learn to use it.</p>
+<p>Example:</p>
<pre>
build.compiler=jikes
deploy.server=lucky
deploy.port=8080
-deploy.url=http://${deploy.server}:${deploy.port}/
-</pre>
+deploy.url=http://${deploy.server}:${deploy.port}/</pre>
<h3 id="notes-env">Notes about environment variables</h3>
-<p>
- Ant runs on Java 1.2 therefore it cannot use Java 5 features for accessing environment
- variables. So it starts a command in a new process which prints the environment variables,
- analyzes the output and creates the properties.<br>
- There are commands for the following operating systems implemented in
- <a href="https://git-wip-us.apache.org/repos/asf?p=ant.git;a=blob;f=src/main/org/apache/tools/ant/taskdefs/Execute.java;hb=24e5a0e881dba01a6f012c4a271b743946412a0d">
- Execute.java</a> (method <tt>getProcEnvCommand()</tt>):
+<p>Ant runs on Java 1.2 therefore it cannot use Java 5 features for accessing environment
+variables. So it starts a command in a new process which prints the environment variables, analyzes
+the output and creates the properties.<br/> There are commands for the following operating systems
+implemented
+in <a href="https://git-wip-us.apache.org/repos/asf?p=ant.git;a=blob;f=src/main/org/apache/tools/ant/taskdefs/Execute.java;hb=refs/heads/master">Execute.java</a>
+(method <code>getProcEnvCommand()</code>):
</p>
<table>
<tr>
@@ -304,38 +275,38 @@ deploy.url=http://${deploy.server}:${deploy.port}/
</tr>
<tr>
<td>os/2</td>
- <td>cmd /c set</td>
+ <td><code>cmd /c set</code></td>
</tr>
<tr>
- <td colspan="2"> windows</td>
+ <td colspan="2">windows</td>
</tr>
<tr>
<td>* win9x</td>
- <td>command.com /c set</td>
+ <td><code>command.com /c set</code></td>
</tr>
<tr>
<td>* other</td>
- <td>cmd /c set</td>
+ <td><code>cmd /c set</code></td>
</tr>
<tr>
<td>z/os</td>
- <td>/bin/env <b>OR</b> /usr/bin/env <b>OR</b> env <i>(depending on read rights)</i></td>
+ <td><code>/bin/env</code> <strong>OR</strong> <code>/usr/bin/env</code> <strong>OR</strong> <code>env</code> (<em>depending on read rights</em>)</td>
</tr>
<tr>
<td>unix</td>
- <td>/bin/env <b>OR</b> /usr/bin/env <b>OR</b> env <i>(depending on read rights)</i></td>
+ <td><code>/bin/env</code> <strong>OR</strong> <code>/usr/bin/env</code> <strong>OR</strong> <code>env</code> (<em>depending on read rights</em>)</td>
</tr>
<tr>
<td>netware</td>
- <td>env</td>
+ <td><code>env</code></td>
</tr>
<tr>
<td>os/400</td>
- <td>env</td>
+ <td><code>env</code></td>
</tr>
<tr>
<td>openvms</td>
- <td>show logical</td>
+ <td><code>show logical</code></td>
</tr>
</table>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/propertyfile.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/propertyfile.html b/manual/Tasks/propertyfile.html
index 49444b7..10470b2 100644
--- a/manual/Tasks/propertyfile.html
+++ b/manual/Tasks/propertyfile.html
@@ -26,139 +26,138 @@
<h1>PropertyFile</h1>
<hr/>
<h2 id="introduction">Introduction</h2>
-<p>Apache Ant provides an optional task for editing property files. This is
-very useful when wanting to make unattended modifications to
-configuration files for application servers and
-applications. Currently, the task maintains a working property file
-with the ability to add properties or make changes to existing
-ones. <em>Since Ant 1.8.0</em> comments and layout of the original properties
-file are preserved.</p>
-
-<p><em>Since Ant 1.8.2</em> the linefeed-style of the original file
- will be preserved as well, as long as style used to be consistent.
- In general, linefeeds of the updated file will be the same as the
- first linefeed found when reading it.</p>
+<p>Apache Ant provides an optional task for editing property files. This is very useful when wanting
+to make unattended modifications to configuration files for application servers and
+applications. Currently, the task maintains a working property file with the ability to add
+properties or make changes to existing ones. <em>Since Ant 1.8.0</em> comments and layout of the
+original properties file are preserved.</p>
+
+<p><em>Since Ant 1.8.2</em> the linefeed-style of the original file will be preserved as well, as
+long as style used to be consistent. In general, linefeeds of the updated file will be the same as
+the first linefeed found when reading it.</p>
<hr/>
+
<h2 id="proptask">PropertyFile Task</h2>
<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"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">file</td>
- <td valign="top">Location of the property file to be edited</td>
- <td valign="top">Yes</td>
+ <td>file</td>
+ <td>Location of the property file to be edited</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">comment</td>
- <td valign="top">Header for the file itself</td>
- <td valign="top">no</td>
+ <td>comment</td>
+ <td>Header for the file itself</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">jdkproperties</td>
- <td valign="top">Use java.lang.Properties, which will
- lose comments and layout of file (default is 'false'). <em>since
+ <td>jdkproperties</td>
+ <td>Use <code>java.lang.Properties</code>, which will lose comments and layout of file. <em>since
Ant 1.8.0</em></td>
- <td valign="top">no</td>
+ <td>No; default is <q>false</q></td>
</tr>
</table>
-<p>The boolean attribute 'jdkproperties' is provided to recover the
-previous behaviour of the task, in which the layout and any comments
-in the properties file were lost by the task.</p>
+<p>The boolean attribute <var>jdkproperties</var> is provided to recover the previous behaviour of
+the task, in which the layout and any comments in the properties file were lost by the task.</p>
<h3>Parameters specified as nested elements</h3>
<h4 id="entryElement">Entry</h4>
-<p>Use nested <code><entry></code>
-elements to specify actual modifications to the property file itself.</p>
-<table>
+<p>Use nested <code><entry></code> elements to specify actual modifications to the property
+file itself.</p>
+<table class="attr">
<tr>
- <td valign="top"><b>Attribute</b></td>
- <td valign="top"><b>Description</b></td>
- <td align="center" valign="top"><b>Required</b></td>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
</tr>
<tr>
- <td valign="top">key</td>
- <td valign="top">Name of the property name/value pair</td>
- <td valign="top" align="center">Yes</td>
+ <td>key</td>
+ <td>Name of the property name/value pair</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">value</td>
- <td valign="top">Value to set (=), to add (+) or subtract (-)</td>
- <td valign="top" align="center" rowspan="2">At least one must be specified, if <i>operation</i> is not <i>delete</i></td>
+ <td>value</td>
+ <td>Value to set (<q>=</q>), to add (<q>+</q>) or subtract (<q>-</q>)</td>
+ <td rowspan="2">At least one must be specified, if <var>operation</var> is not <q>del</q></td>
</tr>
<tr>
- <td valign="top">default</td>
- <td valign="top">Initial value to set for a property if it is not
- already defined in the property file.<br>
- For type date, an additional keyword is allowed: "now"</td>
- </tr>
+ <td>default</td>
+ <td class="left">Initial value to set for a property if it is not already defined in the
+ property file.<br/>For type <var>date</var>, an additional keyword is
+ allowed: <q>now</q></td></tr>
<tr>
- <td valign="top">type</td>
- <td valign="top">Regard the value as : int, date or string (default)</td>
- <td valign="top" align="center">No</td>
+ <td>type</td>
+ <td>Regard the value as: <q>int</q>, <q>date</q> or <q>string</q> (default)</td>
+ <td>No; defaults to <q>string</q></td>
</tr>
<tr>
- <td valign="top">operation</td>
- <td valign="top">One of the following operations:<br><br>
- <b>for all datatypes:</b><ul>
- <li>"del" : deletes an entry</li>
- <li>"+" : adds a value to the existing value</li>
- <li>"=" : sets a value instead of the existing value (default)</li>
- </ul><br><b>for date and int only:</b><ul>
- <li>"-" : subtracts a value from the existing value</li>
- </ul>
+ <td>operation</td>
+ <td>One of the following operations:<br><br>
+ <strong>for all datatypes:</strong>
+ <ul>
+ <li><q>del</q> : deletes an entry</li>
+ <li><q>+</q> : adds a value to the existing value</li>
+ <li><q>=</q> : sets a value instead of the existing value (default)</li>
+ </ul>
+ <strong>for <var>date</var> and <var>int</var> only:</strong>
+ <ul>
+ <li><q>-</q> : subtracts a value from the existing value</li>
+ </ul>
</td>
- <td valign="top" align="center">No</td>
+ <td>No; defaults to <q>=</q></td>
</tr>
<tr>
- <td valign="top">pattern</td>
- <td valign="top">For int and date type only. If present, Values will
- be parsed and formatted accordingly.</td>
- <td valign="top" align="center">No</td>
+ <td>pattern</td>
+ <td>For <var>int</var> and <var>date</var> type only. If present, values will be parsed and
+ formatted accordingly.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">unit</td>
- <td valign="top">The unit of the value to be applied to date +/- operations.
- Valid Values are:
- <ul>
- <li>millisecond</li>
- <li>second</li>
- <li>minute</li>
- <li>hour</li>
- <li>day (default)</li>
- <li>week</li>
- <li>month</li>
- <li>year</li>
- </ul>
- This only applies to date types using a +/- operation.
+ <td>unit</td>
+ <td>The unit of the value to be applied to <var>date</var> <q>+</q>/<q>-</q> operations. Valid
+ Values are:
+ <ul>
+ <li><q>millisecond</q></li>
+ <li><q>second</q></li>
+ <li><q>minute</q></li>
+ <li><q>hour</q></li>
+ <li><q>day</q> (default)</li>
+ <li><q>week</q></li>
+ <li><q>month</q></li>
+ <li><q>year</q></li>
+ </ul>
+ This only applies to <var>date</var> types using a <q>+</q>/<q>-</q> operation.
</td>
- <td align="center" valign="top">No</td>
+ <td>No; defaults to <q>day</q></td>
</tr>
</table>
-<p>The rules used when setting a property value are shown below. The
-operation occurs <b>after</b> these rules are considered.</p>
+<p>The rules used when setting a property value are shown below. The operation
+occurs <strong>after</strong> these rules are considered.</p>
<ul>
- <li>If only value is specified, the property is set to it regardless of its
- previous value.</li>
- <li>If only default is specified and the property previously existed in the
- property file, it is unchanged.</li>
- <li>If only default is specified and the property did not exist in the
- property file, the property is set to default.</li>
- <li>If value and default are both specified and the property previously
- existed in the property file, the property is set to value.</li>
- <li>If value and default are both specified and the property did not exist in
- the property file, the property is set to default.</li>
+ <li>If only <var>value</var> is specified, the property is set to it regardless of its previous
+ value.</li>
+ <li>If only <var>default</var> is specified and the property previously existed in the property
+ file, it is unchanged.</li>
+ <li>If only <var>default</var> is specified and the property did not exist in the property file,
+ the property is set to <var>default</var>.</li>
+ <li>If <var>value</var> and <var>default</var> are both specified and the property previously
+ existed in the property file, the property is set to <var>value</var>.</li>
+ <li>If <var>value</var> and <var>default</var> are both specified and the property did not exist
+ in the property file, the property is set to <var>default</var>.</li>
</ul>
<h3>Examples</h3>
-<p>The following changes the my.properties file. Assume my.properties look like:</p>
+<p>The following changes the <samp>my.properties</samp> file. Assume <samp>my.properties</samp>
+looks like:</p>
<pre># A string value
akey=original value
@@ -167,8 +166,7 @@ akey=original value
# each time the build is run.
anint=1</pre>
-<p>After running, the file would now look like
-</p>
+<p>After running, the file would now look like</p>
<pre>#My properties
#Wed Aug 31 13:47:19 BST 2005
# A string value
@@ -183,63 +181,55 @@ adate=2005/08/31 13\:47
formated.int=0014
formated.date=243 13\:47</pre>
-<p>
-The slashes conform to the expectations of the Properties class. The file will be stored in a manner so that each character is examined and escaped if necessary.
-</p>
-
-<p>
-The layout and comment of the original file is preserved. New properties are added at the end of the file. Existing properties are overwritten in place.
-</p>
-
-<pre><propertyfile
- file="my.properties"
- comment="My properties">
- <entry key="akey" value="avalue"/>
- <entry key="adate" type="date" value="now"/>
- <entry key="anint" type="int" default="0" operation="+"/>
- <entry key="formated.int" type="int" default="0013" operation="+" pattern="0000"/>
- <entry key="formated.date" type="date" value="now" pattern="DDD HH:mm"/>
-</propertyfile>
-</pre>
-<p>
-To produce dates relative from today :</p>
-<pre><propertyfile
- file="my.properties"
- comment="My properties">
- <entry key="formated.date-1"
- type="date" default="now" pattern="DDD"
- operation="-" value="1"/>
- <entry key="formated.tomorrow"
- type="date" default="now" pattern="DDD"
- operation="+" value="1"/>
-</propertyfile>
-</pre>
-
-<p>
-Concatenation of strings :</p>
-<pre><propertyfile
- file="my.properties"
- comment="My properties">
- <entry key="progress" default="" operation="+" value="."/>
-</propertyfile>
-</pre>
-<p>Each time called, a "." will be appended to "progress"
-</p>
-
-<p>Pumps the project version to the next minor version (increase minor and set path=0):</p>
-<pre><target name="nextMinorVersion">
- <property
- name="header"
- value="##Generated file - do not modify!"/>
- <propertyfile file="version.properties" comment="${header}">
- <entry key="product.build.major" type="int" value="3" />
- <entry key="product.build.minor" type="int" operation="+" />
- <entry key="product.build.patch" type="int" value="0" />
- <entry key="product.build.date" type="date" value="now" />
- </propertyfile>
-</target>
-</pre>
-After running this target the version changed e.g. from 3.2.2 to 3.3.0.
+<p>The slashes conform to the expectations of the Properties class. The file will be stored in a
+manner so that each character is examined and escaped if necessary.</p>
+
+<p>The layout and comment of the original file is preserved. New properties are added at the end of
+the file. Existing properties are overwritten in place.</p>
+
+<pre>
+<propertyfile file="my.properties"
+ comment="My properties">
+ <entry key="akey" value="avalue"/>
+ <entry key="adate" type="date" value="now"/>
+ <entry key="anint" type="int" default="0" operation="+"/>
+ <entry key="formated.int" type="int" default="0013" operation="+" pattern="0000"/>
+ <entry key="formated.date" type="date" value="now" pattern="DDD HH:mm"/>
+</propertyfile></pre>
+<p>To produce dates relative from today:</p>
+<pre>
+<propertyfile file="my.properties"
+ comment="My properties">
+ <entry key="formated.date-1"
+ type="date" default="now" pattern="DDD"
+ operation="-" value="1"/>
+ <entry key="formated.tomorrow"
+ type="date" default="now" pattern="DDD"
+ operation="+" value="1"/>
+</propertyfile></pre>
+
+<p>Concatenation of strings:</p>
+<pre>
+<propertyfile file="my.properties"
+ comment="My properties">
+ <entrykey="progress" default="" operation="+" value="."/>
+</propertyfile></pre>
+<p>Each time called, a <q>.</q> will be appended to <code>progress</code></p>
+
+<p>Pumps the project version to the next minor version (increase minor and
+set <code>patch=0</code>):</p>
+<pre>
+<target name="nextMinorVersion">
+ <property name="header"
+ value="##Generated file - do not modify!"/>
+ <propertyfile file="version.properties" comment="${header}">
+ <entry key="product.build.major" type="int" value="3"/>
+ <entry key="product.build.minor" type="int" operation="+"/>
+ <entry key="product.build.patch" type="int" value="0"/>
+ <entry key="product.build.date" type="date" value="now"/>
+ </propertyfile>
+</target></pre>
+<p>After running this target the version changed e.g. from 3.2.2 to 3.3.0.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/propertyhelper.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/propertyhelper.html b/manual/Tasks/propertyhelper.html
index 8295d9e..db14aec 100644
--- a/manual/Tasks/propertyhelper.html
+++ b/manual/Tasks/propertyhelper.html
@@ -26,48 +26,49 @@
<h2>PropertyHelper</h2>
<h3>Description</h3>
-<p>This task is provided for the purpose of allowing the user to
-<b>(a)</b> install a different PropertyHelper at runtime, or
-<b>(b)</b> (hopefully more often) install one or more PropertyHelper Delegates into the
-PropertyHelper active on the current Project. This is somewhat advanced Apache Ant usage and
-assumes a working familiarity with the modern Ant APIs. See the description of Ant's
-<a href="../properties.html#propertyHelper">Property Helper</a> for more information.
+<p>This task is provided for the purpose of allowing the user to <strong>(a)</strong> install a
+different <code>PropertyHelper</code> at runtime, or <strong>(b)</strong> (hopefully more often)
+install one or more <code>PropertyHelper</code> Delegates into the <code>PropertyHelper</code>
+active on the current <code>Project</code>. This is somewhat advanced Apache Ant usage and assumes a
+working familiarity with the modern Ant APIs. See the description of
+Ant's <a href="../properties.html#propertyHelper">Property Helper</a> for more information.
<em>Since Ant 1.8.0</em></p>
<h3>Parameters specified as nested elements</h3>
<h4>PropertyHelper</h4>
-You may specify exactly one configured <code>org.apache.tools.ant.PropertyHelper</code> instance.
+<p>You may specify exactly one configured <code>org.apache.tools.ant.PropertyHelper</code>
+instance.</p>
<h4>PropertyHelper.Delegate</h4>
-You may specify, either in conjunction with a new <code>PropertyHelper</code> or not, one or
-more configured implementations of the <code>org.apache.tools.ant.PropertyHelper.Delegate</code>
-interface. A deeper understanding of the API is required here, however, as <code>Delegate</code>
-is a marker interface only: the nested arguments must implement a <code>Delegate</code>
-subinterface in order to do anything meaningful.
+<p>You may specify, either in conjunction with a new <code>PropertyHelper</code> or not, one or more
+configured implementations of the <code>org.apache.tools.ant.PropertyHelper.Delegate</code>
+interface. A deeper understanding of the API is required here, however, as <code>Delegate</code> is
+a marker interface only: the nested arguments must implement a <code>Delegate</code> subinterface in
+order to do anything meaningful.</p>
<h4>delegate</h4>
-<p>A generic <delegate> element which can use project references
-is also provided:</p>
+<p>A generic <code><delegate></code> element which can use project references is also
+provided:</p>
<h5>Parameters</h5>
-<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">refid</td>
- <td valign="top">The <i>id</i> of a <code>PropertyHelper.Delegate</code> to install.</td>
- <td valign="top" align="center">Yes</td>
+ <td>refid</td>
+ <td>The <var>id</var> of a <code>PropertyHelper.Delegate</code> to install.</td>
+ <td>Yes</td>
</tr>
</table>
<h3>Examples</h3>
-<p>Install a completely different PropertyHelper implementation
- (assuming <code>MyPropertyHelper extends PropertyHelper</code>):</p>
+<p>Install a completely different <code>PropertyHelper</code> implementation
+(assuming <code>MyPropertyHelper extends PropertyHelper</code>):</p>
<pre>
<componentdef classname="org.example.MyPropertyHelper"
@@ -77,12 +78,10 @@ is also provided:</p>
</propertyhelper>
</pre>
-<p>Add a new PropertyEvaluator delegate
- (assuming <code>MyPropertyEvaluator implements
- PropertyHelper.PropertyEvaluator</code>). Note that PropertyHelper
- uses the configured delegates in LIFO order. I.e. the delegate
- added by this task will be consulted before any previously defined
- delegate and in particular before the built-in ones.</p>
+<p>Add a new <code>PropertyEvaluator</code> delegate (assuming <code>MyPropertyEvaluator implements
+PropertyHelper.PropertyEvaluator</code>). Note that <code>PropertyHelper</code> uses the configured
+delegates in LIFO order. I.e. the delegate added by this task will be consulted before any
+previously defined delegate and in particular before the built-in ones.</p>
<pre>
<componentdef classname="org.example.MyPropertyEvaluator"
@@ -92,7 +91,7 @@ is also provided:</p>
</propertyhelper>
</pre>
-<p>Add a new PropertyEvaluator delegate using the refid syntax:</p>
+<p>Add a new <code>PropertyEvaluator</code> delegate using the <var>refid</var> syntax:</p>
<pre>
<typedef classname="org.example.MyPropertyEvaluator"
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/pvcstask.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/pvcstask.html b/manual/Tasks/pvcstask.html
index f08b5a1..077b145 100644
--- a/manual/Tasks/pvcstask.html
+++ b/manual/Tasks/pvcstask.html
@@ -24,217 +24,173 @@
<h1>Apache Ant Pvcs Task User Manual</h1>
-<p><strong>Note</strong>:
-Before using this task, the user running Ant must have access to the
-commands of PVCS (get and pcli) and must have access to the
-repository. Note that the way to specify the repository is platform
-dependent so use property to specify location of repository.
-</p>
-
-by
-<br><!-- Names are in alphabetical order, on last name -->
+<p><strong>Note</strong>: Before using this task, the user running Ant must have access to the
+commands of PVCS (<code>get</code> and <code>pcli</code>) and must have access to the
+repository. Note that the way to specify the repository is platform dependent so use property to
+specify location of repository.</p>
+<p>by</p>
+<!-- Names are in alphabetical order, on last name -->
<ul>
<li>Thomas Christensen (<a href="mailto:tchristensen@nordija.com">tchristensen@nordija.com</a>)</li>
<li>Don Jeffery (<a href="mailto:donj@apogeenet.com">donj@apogeenet.com</a>)</li>
<li>Jon Dickinson (<a href="mailto:dickinson.j@ucles.org.uk">dickinson.j@ucles.org.uk</a>)</li>
</ul>
-Version 1.1 - 2001/06/27<br>
-<p>Problems with UNC pathnames and the use of () in paths are fixed and an updateonly
- argument introduced.</p>
-Version 1.0 - 2001/01/31<br>
+<p>Version 1.1—2001/06/27</p>
+<p>Problems with UNC pathnames and the use of <q>()</q> in paths are fixed and
+an <var>updateonly</var> argument introduced.</p>
+<p>Version 1.0—2001/01/31</p>
<p>Initial release.</p>
-<hr>
+
+<hr/>
+
<h2>Table of Contents</h2>
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#pvcs">Pvcs Task</a></li>
</ul>
+
<hr/>
<h2 id="introduction">Introduction</h2>
-The pvcs task allows the user of Ant to extract the latest edition
-of the source code from a PVCS repository. PVCS is a version control system
-developed by <a href="http://www.merant.com/products/pvcs">Merant</a>.
-<br>
-This version has been tested against PVCS version 6.5 and 6.6 under Windows and Solaris.
+<p>The <code>pvcs</code> task allows the user of Ant to extract the latest edition of the source
+code from a PVCS repository. PVCS is a version control system developed
+by <a href="http://www.serena.com/products/pvcs">Merant</a>.</p>
+<p>This version has been tested against PVCS version 6.5 and 6.6 under Windows and Solaris.</p>
<hr/>
+
<h2 id="pvcs">Pvcs Task</h2>
<h3>Description</h3>
-The pvcs task is set to point at a PVCS repository and optionally a project
-within that repository, and can from that specification get the latest
-version of the files contained by the repository.
+<p>The <code>pvcs</code> task is set to point at a PVCS repository and optionally a project within
+that repository, and can from that specification get the latest version of the files contained by
+the repository.</p>
<h3>Parameters</h3>
-<table>
-<tr>
-<td valign="top"><b>Attribute</b></td>
-
-<td valign="top"><b>Description</b></td>
-
-<td valign="top"><b>Required</b></td>
-</tr>
-
-<tr>
-<td valign="top">repository</td>
-
-<td valign="top">The location of the repository (see your PVCS
-manuals)</td>
-
-<td valign="top">Yes</td>
-</tr>
-
-<tr>
-<td valign="top">pvcsproject</td>
-
-<td valign="top">The project within the PVCS repository to extract
-files from ("/" is root project and that is default if this attribute isn't
-specified)</td>
-
-<td valign="top">No</td>
-</tr>
-
-<tr>
-<td valign="top">label</td>
-
-<td valign="top">Only files marked with this label are extracted.</td>
-
-<td valign="top">No</td>
-</tr>
-
-<tr>
-<td valign="top">promotiongroup</td>
-
-<td valign="top">Only files within this promotion group are extracted. Using
-both the <i>label</i> and the <i>promotiongroup</i> tag will cause the files in the
-promotion group and with that label to be extracted.
-</td>
-
-<td valign="top">No</td>
-</tr>
-
-<tr>
-<td valign="top">config</td>
-
-<td valign="top">path of a non default .cfg file.
-Can be given absolute or relative to Ant's base directory.
-</td>
-
-<td valign="top">No</td>
-</tr>
-
-<tr>
-<td valign="top">force</td>
-
-<td valign="top">If set to <i>yes</i> all files that exists and are writable are overwritten. Default <i>no</i> causes the files that are writable to be ignored. This stops the PVCS command <i>get</i> to stop asking questions!</td>
-
-<td valign="top">No</td>
-</tr>
-
-<tr>
-<td valign="top">workspace</td>
-
-<td valign="top">By specifying a workspace, the files are extracted to that location. A PVCS workspace is a
-name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace
-using the PVCS GUI clients. If this isn't specified the default workspace for the current user is used.</td>
-
-<td valign="top">No</td>
-</tr>
-
-<tr>
-<td valign="top">pvcsbin</td>
-
-<td valign="top">On some systems the PVCS executables <i>pcli</i>
-and <i>get</i> are not found in the PATH. In such cases this attribute
-should be set to the bin directory of the PVCS installation containing
-the executables mentioned before. If this attribute isn't specified the
-tag expects the executables to be found using the PATH environment variable.</td>
-
-<td valign="top">No</td>
-</tr>
- <tr>
- <td valign="top">ignorereturncode</td>
- <td valign="top">If set to <i>true</i> the return value from executing
- the pvcs commands are ignored.</td>
- <td valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">updateonly</td>
- <td valign="top">If set to <i>true</i> files are gotten only if
- newer than existing local files.</td>
- <td valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">filenameformat</td>
- <td valign="top">The format of your folder names in a
- format suitable for <code>java.text.MessageFormat</code>.
- Defaults to <code>{0}-arc({1})</code>. Repositories where
- the archive extension is not <code>-arc</code> should set
- this.</td>
- <td valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">linestart</td>
- <td valign="top">Used to parse the output of the pcli
- command. It defaults to <code>"P:</code>. The parser already
- knows about / and \\, this property is useful in cases where the
- repository is accessed on a Windows platform via a drive letter
- mapping.</td>
- <td valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">revision</td>
- <td valign="top">Retrieve the specified revision.</td>
- <td valign="top">No</td>
- </tr>
- <tr>
- <td valign="top">userid</td>
- <td valign="top">Use the specified userid.</td>
- <td valign="top">No</td>
- </tr>
+<table class="attr">
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>repository</td>
+ <td>The location of the repository (see your PVCS manuals).</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>pvcsproject</td>
+ <td>The project within the PVCS repository to extract files from.</td>
+ <td>No; defaults to root project, <q>/</q></td>
+ </tr>
+ <tr>
+ <td>label</td>
+ <td>Only files marked with this label are extracted.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>promotiongroup</td>
+ <td>Only files within this promotion group are extracted. Using both the <var>label</var> and
+ the <var>promotiongroup</var> tag will cause the files in the promotion group and with that
+ label to be extracted.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>config</td>
+ <td>path of a non default <samp>.cfg</samp> file. Can be given absolute or relative to
+ project's base directory.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>force</td>
+ <td>If set to <q>yes</q> all files that exists and are writable are
+ overwritten. Default <q>no</q> causes the files that are writable to be ignored. This stops
+ the PVCS command <code>get</code> to stop asking questions!</td>
+ <td>No; default is <q>no</q></td>
+ </tr>
+ <tr>
+ <td>workspace</td>
+ <td>By specifying a <var>workspace</var>, the files are extracted to that location. A PVCS
+ workspace is a name for a location of the workfiles and isn't as such the location itself. You
+ define the location for a workspace using the PVCS GUI clients.</td>
+ <td>No; defaults to default workspace for the current user</td>
+ </tr>
+ <tr>
+ <td>pvcsbin</td>
+ <td>On some systems the PVCS executables <code>pcli</code> and <code>get</code> are not found in
+ the <code>PATH</code>. In such cases this attribute should be set to the <code>bin</code>
+ directory of the PVCS installation containing the executables mentioned before. If this
+ attribute isn't specified the tag expects the executables to be found using
+ the <code>PATH</code> environment variable.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>ignorereturncode</td>
+ <td>If set to <q>true</q> the return value from executing the PVCS commands are ignored.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>updateonly</td>
+ <td>If set to <q>true</q> files are gotten only if newer than existing local files.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>filenameformat</td>
+ <td>The format of your folder names in a format suitable
+ for <code>java.text.MessageFormat</code>. Repositories where the archive extension is
+ not <samp>-arc</samp> should set this.</td>
+ <td>No; defaults to <q>{0}-arc({1})</q></td>
+ </tr>
+ <tr>
+ <td>linestart</td>
+ <td>Used to parse the output of the <code>pcli</code> command. The parser already knows
+ about <q>/</q> and <q>\\</q>, this property is useful in cases where the repository is
+ accessed on a Windows platform via a drive letter mapping.</td>
+ <td>No; defaults to <code>"P:</code></td>
+ </tr>
+ <tr>
+ <td>revision</td>
+ <td>Retrieve the specified revision.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>userid</td>
+ <td>Use the specified userid.</td>
+ <td>No</td>
+ </tr>
</table>
<h3 id="nested">Nested Elements</h3>
<h4>pvcsproject element</h4>
-<p><code>pvcs</code> supports a nested
-<code><pvcsproject></code> element, that represents a project
-within the PVCS repository to extract files from. By nesting multiple
-<code><pvcsproject></code> elements under the
-<code><pvcs></code> task, multiple projects can be
-specified.</p>
+<p><code>pvcs</code> supports a nested <code><pvcsproject></code> element, that represents a
+project within the PVCS repository to extract files from. By nesting
+multiple <code><pvcsproject></code> elements under the <code><pvcs></code> task,
+multiple projects can be specified.</p>
<h3>Parameters</h3>
-<table>
-<tr>
-<td valign="top"><b>Attribute</b></td>
-
-<td valign="top"><b>Description</b></td>
-
-<td valign="top"><b>Required</b></td>
-</tr>
-
-<tr>
-<td valign="top">name</td>
-
-<td valign="top">The name of the pvcs project</td>
-
-<td valign="top">Yes</td>
-</tr>
+<table class="attr">
+ <tr>
+ <th>Attribute</th>
+ <th>Description</th>
+ <th>Required</th>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>The name of the PVCS project</td>
+ <td>Yes</td>
+ </tr>
</table>
<h3>Examples</h3>
-The following set-up extracts the latest version of the files in the pvcs repository.
+<p>The following set-up extracts the latest version of the files in the pvcs repository.</p>
<pre>
- <!-- =================================================================== -->
- <!-- Get the latest version -->
- <!-- =================================================================== -->
- <target name="getlatest">
- <pvcs repository="/mnt/pvcs" pvcsproject="/myprj"/>
- </target>
-</pre>
-<p>Now run:</p>
-<code>ant getlatest</code>
+<!-- =================================================================== -->
+<!-- Get the latest version -->
+<!-- =================================================================== -->
+<target name="getlatest">
+ <pvcs repository="/mnt/pvcs" pvcsproject="/myprj"/>
+</target></pre>
+<p>Now run: <code>ant getlatest</code></p>
<p>This will cause the following output to appear:</p>
<pre>
getlatest:
@@ -251,21 +207,19 @@ The following set-up extracts the latest version of the files in the pvcs reposi
Total time: 19 seconds</pre>
-This next example extracts the latest version of the files in the pvcs
-repository from two projects using nested <code><pvcsproject></code> elements.
+<p>This next example extracts the latest version of the files in the pvcs repository from two
+projects using nested <code><pvcsproject></code> elements.</p>
<pre>
- <!-- ===================================================================-->
- <!-- Get latest from myprj and myprj2 -->
- <!-- ===================================================================-->
- <target name="getlatest2">
- <pvcs repository="/mnt/pvcs">
- <pvcsproject name="/myprj"/>
- <pvcsproject name="/myprj2"/>
- </pvcs>
- </target>
-</pre>
-<p>Now run:</p>
-<code>ant getlatest2</code>
+<!-- ===================================================================-->
+<!-- Get latest from myprj and myprj2 -->
+<!-- ===================================================================-->
+<target name="getlatest2">
+ <pvcs repository="/mnt/pvcs">
+ <pvcsproject name="/myprj"/>
+ <pvcsproject name="/myprj2"/>
+ </pvcs>
+</target></pre>
+<p>Now run: <code>ant getlatest2</code></p>
<p>This will cause the following output to appear:</p>
<pre>
getlatest2:
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/recorder.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/recorder.html b/manual/Tasks/recorder.html
index 5066887..f920de1 100644
Binary files a/manual/Tasks/recorder.html and b/manual/Tasks/recorder.html differ
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/rename.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/rename.html b/manual/Tasks/rename.html
index d2442fd..f662a80 100644
--- a/manual/Tasks/rename.html
+++ b/manual/Tasks/rename.html
@@ -25,38 +25,39 @@
<body>
<h2 id="rename">Rename</h2>
-<h3><i>Deprecated</i></h3>
-<p><i>This task has been deprecated. Use the Move task instead.</i></p>
+<h3><em><u>Deprecated</u></em></h3>
+<p><em>This task has been <u>deprecated</u>. Use the <code>Move</code> task instead.</em></p>
<h3>Description</h3>
<p>Renames a given 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">src</td>
- <td valign="top">file to rename.</td>
- <td valign="top" align="center">Yes</td>
+ <td>src</td>
+ <td>file to rename.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">dest</td>
- <td valign="top">new name of the file.</td>
- <td valign="top" align="center">Yes</td>
+ <td>dest</td>
+ <td>new name of the file.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">replace</td>
- <td valign="top">Enable replacing of existing file (default: on).</td>
- <td valign="top" align="center">No</td>
+ <td>replace</td>
+ <td>Enable replacing of existing file.</td>
+ <td>No; default is <q>on</q></td>
</tr>
</table>
<h3>Examples</h3>
-<pre> <rename src="foo.jar" dest="${name}-${version}.jar"/></pre>
-<p>Renames the file <code>foo.jar</code> to <code>${name}-${version}.jar</code> (assuming <code>name</code>
- and <code>version</code> being predefined properties). If a file named <code>${name}-${version}.jar</code>
- already exists, it will be removed prior to renaming <code>foo.jar</code>.</p>
+<pre><rename src="foo.jar" dest="${name}-${version}.jar"/></pre>
+<p>Renames the file <samp>foo.jar</samp> to <samp>${name}-${version}.jar</samp>
+(assuming <code>name</code> and <code>version</code> being predefined properties). If a file
+named <samp>${name}-${version}.jar</samp> already exists, it will be removed prior to
+renaming <samp>foo.jar</samp>.</p>
</body>
</html>