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:36 UTC
[21/47] ant git commit: Use HTML 5(-ish), fix links
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/unpack.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/unpack.html b/manual/Tasks/unpack.html
index ac278d2..95c1c45 100644
--- a/manual/Tasks/unpack.html
+++ b/manual/Tasks/unpack.html
@@ -28,85 +28,81 @@
<h3>Description</h3>
<p>Expands a resource packed using GZip, BZip2 or XZ.</p>
-<p>If <i>dest</i> is a directory the name of the destination file is
-the same as <i>src</i> (with the ".gz", ".bz2" or ".xz"
-extension removed if present). If <i>dest</i> is omitted, the parent
-dir of <i>src</i> is taken. The file is only expanded if the source
-resource is newer than the destination file, or when the destination file
-does not exist.</p>
-
-<p>XZ compression support has been added with Apache Ant 1.10.1 and
-depends on external libraries not included in the Ant distribution.
-See <a href="../install.html#librarydependencies">Library
-Dependencies</a> for more information.</p>
+<p>If <var>dest</var> is a directory the name of the destination file is the same as <var>src</var>
+(with the <q>.gz</q>, <q>.bz2</q> or <q>.xz</q> extension removed if present). If <var>dest</var> is
+omitted, the parent dir of <var>src</var> is taken. The file is only expanded if the source resource
+is newer than the destination file, or when the destination file does not exist.</p>
+
+<p>XZ compression support has been added <em>since Apache Ant 1.10.1</em> and depends on external
+libraries not included in the Ant distribution.
+See <a href="../install.html#librarydependencies">Library Dependencies</a> for more information.</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">the file to expand.</td>
- <td align="center" valign="top">Yes, or a nested resource collection.</td>
+ <td>src</td>
+ <td>the file to expand.</td>
+ <td>Yes, or a nested resource collection</td>
</tr>
<tr>
- <td valign="top">dest</td>
- <td valign="top">the destination file or directory.</td>
- <td align="center" valign="top">No</td>
+ <td>dest</td>
+ <td>the destination file or directory.</td>
+ <td>No</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
-<h4>any <a href="../Types/resources.html">resource</a> or single element
-resource collection</h4>
+<h4>any <a href="../Types/resources.html">resource</a> or single element resource collection</h4>
-<p>The specified resource will be used as src.</p>
+<p>The specified resource will be used as <var>src</var>.</p>
<h3>Examples</h3>
<pre><gunzip src="test.tar.gz"/></pre>
-<p>expands <i>test.tar.gz</i> to <i>test.tar</i></p>
+<p>expands <samp>test.tar.gz</samp> to <samp>test.tar</samp></p>
+
<pre><bunzip2 src="test.tar.bz2"/></pre>
-<p>expands <i>test.tar.bz2</i> to <i>test.tar</i></p>
+<p>expands <samp>test.tar.bz2</samp> to <samp>test.tar</samp></p>
+
<pre><unxz src="test.tar.xz"/></pre>
-<p>expands <i>test.tar.xz</i> to <i>test.tar</i></p>
+<p>expands <samp>test.tar.xz</samp> to <samp>test.tar</samp></p>
+
<pre><gunzip src="test.tar.gz" dest="test2.tar"/></pre>
-<p>expands <i>test.tar.gz</i> to <i>test2.tar</i></p>
+<p>expands <samp>test.tar.gz</samp> to <samp>test2.tar</samp></p>
+
<pre><gunzip src="test.tar.gz" dest="subdir"/></pre>
-<p>expands <i>test.tar.gz</i> to <i>subdir/test.tar</i> (assuming
-subdir is a directory).</p>
+<p>expands <samp>test.tar.gz</samp> to <samp>subdir/test.tar</samp> (assuming subdir is a
+directory).</p>
+
<pre>
<gunzip dest=".">
<url url="http://example.org/archive.tar.gz"/>
</gunzip>
</pre>
-<p>downloads <i>http://example.org/archive.tar.gz</i> and expands it
-to <i>archive.tar</i> in the project's basedir on the fly.</p>
+<p>downloads <samp>http://example.org/archive.tar.gz</samp> and expands it
+to <samp>archive.tar</samp> in the project's <var>basedir</var> on the fly.</p>
<h3>Related tasks</h3>
-<pre>
-<gunzip src="some-archive.gz" dest="some-dest-dir"/>
-</pre>
-is identical to
+<pre><gunzip src="some-archive.gz" dest="some-dest-dir"/></pre>
+<p>is identical to</p>
<pre>
<copy todir="some-dest-dir">
<gzipresource>
<file file="some-archive.gz"/>
</gzipresource>
<mapper type="glob" from="*.gz" to="*"/>
-</copy>
-</pre>
+</copy></pre>
-<p>The same is also true for <code><bunzip2></code> and
-<code><bzip2resource></code> or <code>%lt;unxz></code>
-and <code>%lt;xzresource></code>. <code><copy></code> offers
-additional features like <a href="../Types/filterchain.html">filtering
-files</a> on the fly, allowing a file to be mapped to multiple
-destinations, preserving the last modified time or a configurable file
-system timestamp granularity.</p>
+<p>The same is also true for <code><bunzip2></code> and <code><bzip2resource></code>
+or <code><unxz></code> and <code><xzresource></code>. <code><copy></code> offers
+additional features like <a href="../Types/filterchain.html">filtering files</a> on the fly,
+allowing a file to be mapped to multiple destinations, preserving the last modified time or a
+configurable file system timestamp granularity.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/unzip.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/unzip.html b/manual/Tasks/unzip.html
index 41b19e5..2d2ee5b 100644
--- a/manual/Tasks/unzip.html
+++ b/manual/Tasks/unzip.html
@@ -27,127 +27,103 @@
<h2 id="unzip">Unjar/Untar/Unwar/Unzip</h2>
<h3>Description</h3>
<p>Unzips a zip-, war-, or jar file.</p>
-<p><a href="../Types/patternset.html">PatternSet</a>s are used to select files to extract
-<i>from</i> the archive. If no patternset is used, all files are extracted.
-</p>
-
-<p><a href="../Types/resources.html#collection">Resource
-Collection</a>s may be used to select archived files to perform
-unarchival upon. Only file system based resource collections are
-supported by Unjar/Unwar/Unzip, this includes <a
-href="../Types/fileset.html">fileset</a>, <a
-href="../Types/filelist.html">filelist</a>, <a
-href="../using.html#path">path</a>, and <a
-href="../Types/resources.html#files">files</a>.
-Untar supports arbitrary resource collections.
-Prior to Apache Ant 1.7 only fileset has been supported as a nested element.</p>
-
-<p>You can define filename transformations by using a nested <a href="../Types/mapper.html">mapper</a> element. The default mapper is the
-<a href="../Types/mapper.html#identity-mapper">identity mapper</a>.
-</p>
+<p><a href="../Types/patternset.html">PatternSet</a>s are used to select files to
+extract <em>from</em> the archive. If no patternset is used, all files are extracted.</p>
+
+<p><a href="../Types/resources.html#collection">Resource Collection</a>s may be used to select
+archived files to perform unarchival upon. Only file system based resource collections are
+supported by <code>Unjar</code>/<code>Unwar</code>/<code>Unzip</code>, this
+includes <a href="../Types/fileset.html">fileset</a>, <a href="../Types/filelist.html">filelist</a>, <a href="../using.html#path">path</a>,
+and <a href="../Types/resources.html#files">files</a>. <code>Untar</code> supports arbitrary
+resource collections. Prior to Apache Ant 1.7 only <code>fileset</code> has been supported as a
+nested element.</p>
+
+<p>You can define filename transformations by using a
+nested <a href="../Types/mapper.html">mapper</a> element. The default mapper is the
+<a href="../Types/mapper.html#identity-mapper">identity mapper</a>.</p>
<p>File permissions will not be restored on extracted files.</p>
-<p>The untar task recognizes the long pathname entries used by GNU tar.<p>
+<p>The <code>untar</code> task recognizes the long pathname entries used by GNU tar.<p>
-<p><b>Please note</b> that different ZIP tools handle timestamps
-differently when it comes to applying timezone offset calculations of
-files. Some ZIP libraries will store the timestamps as they've been
-read from the filesystem while others will modify the timestamps both
-when reading and writing the files to make all timestamps use the same
-timezone. A ZIP archive created by one library may extract files with
-"wrong timestamps" when extracted by another library.</p>
-
-<p>Ant's ZIP classes use the same algorithm as the InfoZIP tools and
-zlib (timestamps get adjusted), Windows' "compressed folders" function
-and WinZIP don't change the timestamps. This means that using the
-unzip task on files created by Windows' compressed folders function
-may create files with timestamps that are "wrong", the same is true if
-you use Windows' functions to extract an Ant generated ZIP
-archive.</p>
+<p><strong>Please note</strong> that different ZIP tools handle timestamps differently when it comes
+to applying timezone offset calculations of files. Some ZIP libraries will store the timestamps as
+they've been read from the filesystem while others will modify the timestamps both when reading and
+writing the files to make all timestamps use the same timezone. A ZIP archive created by one
+library may extract files with "wrong timestamps" when extracted by another library.</p>
+<p>Ant's ZIP classes use the same algorithm as the InfoZIP tools and zlib (timestamps get adjusted),
+Windows' "compressed folders" function and WinZIP don't change the timestamps. This means that
+using the <code>unzip</code> task on files created by Windows' compressed folders function may
+create files with timestamps that are "wrong", the same is true if you use Windows' functions to
+extract an Ant generated ZIP archive.</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">archive file to expand.</td>
- <td align="center" valign="top">Yes, if filesets are not used.</td>
+ <td>src</td>
+ <td>archive file to expand.</td>
+ <td>Yes, unless filesets are used</td>
</tr>
<tr>
- <td valign="top">dest</td>
- <td valign="top">directory where to store the expanded files.</td>
- <td align="center" valign="top">Yes</td>
+ <td>dest</td>
+ <td>directory where to store the expanded files.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">overwrite</td>
- <td valign="top">Overwrite files, even if they are newer than the
- corresponding entries in the archive (true or false, default is
- true).</td>
- <td align="center" valign="top">No</td>
+ <td>overwrite</td>
+ <td>Overwrite files, even if they are newer than the corresponding entries in the archive
+ (<q>true|false</q>).</td>
+ <td>No; default is <q>true</q></td>
</tr>
<tr>
- <td valign="top">compression</td>
- <td valign="top"><strong>Note</strong>: This attribute is only available for
- the <code>untar</code> task.<br>
- compression method. Allowable values are "none",
- "gzip", "xz" and "bzip2". Default is
- "none".</td>
- <td valign="top" align="center">No</td>
+ <td>compression</td>
+ <td><strong>Note</strong>: This attribute is only available for the <code>untar</code> task.<br>
+ compression method. Allowable values are <q>none</q>, <q>gzip</q>, <q>xz</q>
+ and <q>bzip2</q>.</td>
+ <td>No; default is <q>none</q></td>
</tr>
<tr>
- <td valign="top">encoding</td>
- <td valign="top">
- The character encoding that has been used for filenames
- inside the zip file. For a list of possible values see the <a
- href="http://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">Supported Encodings</a>.<br/>
- Defaults to "UTF8" for the <code>unzip</code> and the
- platform's default encoding for the <code>untar</code> task. Use
- the magic value
- <code>native-encoding</code> for the platform's default character
- encoding.
- <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 that has been used for filenames inside the zip file. For a list of
+ possible values see
+ the <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">Supported
+ Encodings</a>.<br/> Use the magic value <q>native-encoding</q> for default JVM character
+ encoding.<br/> See also the <a href="zip.html#encoding">discussion in the zip task
+ page</a></td>
+ <td>No; defaults to <q>UTF8</q> for <code>unzip</code> and default JVM character encoding
+ for <code>untar</code> task</td>
</tr>
<tr>
- <td valign="top">failOnEmptyArchive</td>
- <td valign="top">whether trying to extract an empty archive is an
- error. <em>since Ant 1.8.0</em></td>
- <td valign="top" align="center">No, defaults to false</td>
+ <td>failOnEmptyArchive</td>
+ <td>whether trying to extract an empty archive is an error. <em>since Ant 1.8.0</em></td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">stripAbsolutePathSpec</td>
- <td valign="top">whether Ant should remove leading '/' or '\'
- characters from the extracted file name before extracting it.
- Note that this changes the entry's name before applying
- include/exclude patterns and before using the nested mappers (if
- any). <em>since Ant 1.8.0</em></td>
- <td valign="top" align="center">No, defaults to false</td>
+ <td>stripAbsolutePathSpec</td>
+ <td>whether Ant should remove leading <q>/</q> or <q>\</q> characters from the extracted file
+ name before extracting it. Note that this changes the entry name before
+ applying <code>include</code>/<code>exclude</code> patterns and before using the nested
+ mappers (if any). <em>since Ant 1.8.0</em></td>
+ <td>No; defaults to <q>false</q></td>
</tr>
<tr>
- <td valign="top">scanForUnicodeExtraFields</td>
- <td valign="top"><strong>Note</strong>: This attribute is not available for
- the <code>untar</code> task.<br>
- If the archive contains Unicode extra fields then use them to set
- the file names, ignoring the specified encoding.
- <br/>See also the <a href="zip.html#encoding">discussion in the
- zip task page</a></td>
- <td align="center" valign="top">No, defaults to true</td>
+ <td>scanForUnicodeExtraFields</td>
+ <td><strong>Note</strong>: This attribute is not available for the <code>untar</code> task.<br>
+ If the archive contains Unicode extra fields then use them to set the file names, ignoring the
+ specified encoding. <br/>See also the <a href="zip.html#encoding">discussion in the zip task
+ page</a></td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
<h3>Examples</h3>
-<pre>
-<unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/>
-</pre>
-<p>
+<pre><unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/></pre>
<pre>
<gunzip src="tools.tar.gz"/>
-<untar src="tools.tar" dest="${tools.home}"/>
-</pre>
+<untar src="tools.tar" dest="${tools.home}"/></pre>
<pre>
<unzip src="${tomcat_src}/tools-src.zip"
dest="${tools.home}">
@@ -155,9 +131,7 @@ archive.</p>
<include name="**/*.java"/>
<exclude name="**/Test*.java"/>
</patternset>
-</unzip>
-</pre>
-<p>
+</unzip></pre>
<pre>
<unzip dest="${tools.home}">
<patternset>
@@ -168,17 +142,14 @@ archive.</p>
<include name="**/*.zip"/>
<exclude name="**/tmp*.zip"/>
</fileset>
-</unzip>
-</pre>
-<p>
+</unzip></pre>
<pre>
<unzip src="apache-ant-bin.zip" dest="${tools.home}">
<patternset>
<include name="apache-ant/lib/ant.jar"/>
</patternset>
<mapper type="flatten"/>
-</unzip>
-</pre>
+</unzip></pre>
<h3>Related tasks</h3>
@@ -188,10 +159,9 @@ archive.</p>
<include name="some-pattern"/>
</patternset>
<mapper type="some-mapper"/>
-</unzip>
-</pre>
+</unzip></pre>
-is identical to
+<p>is identical to</p>
<pre>
<copy todir="some-dir" preservelastmodified="true">
@@ -201,21 +171,19 @@ is identical to
</patternset>
</zipfileset>
<mapper type="some-mapper"/>
-</copy>
-</pre>
+</copy></pre>
-<p>The same is also true for <code><untar></code> and
-<code><tarfileset></code>. <code><copy></code> offers
-additional features like <a href="../Types/filterchain.html">filtering files</a> on the fly,
-allowing a file to be mapped to multiple destinations or a
-configurable file system timestamp granularity.</p>
+<p>The same is also true for <code><untar></code>
+and <code><tarfileset></code>. <code><copy></code> offers additional features
+like <a href="../Types/filterchain.html">filtering files</a> on the fly, allowing a file to be
+mapped to multiple destinations or a configurable file system timestamp granularity.</p>
<pre><zip destfile="new.jar">
<zipfileset src="old.jar">
<exclude name="do/not/include/this/class"/>
</zipfileset>
-</zip>
-</pre>
+</zip></pre>
+
<p>"Deletes" files from a zipfile.</p>
<pre>
@@ -223,11 +191,11 @@ configurable file system timestamp granularity.</p>
<patternset>
<include name="images/"/>
</patternset>
-</unzip>
-</pre>
-<p>This extracts all images from <tt>ant.jar</tt> which are stored in the <tt>images</tt> directory
-of the Jar (or somewhere under it). While extracting the directory structure (<tt>images</tt>)
-will be taken.</p>
+</unzip></pre>
+
+<p>This extracts all images from <samp>ant.jar</samp> which are stored in the <samp>images</samp>
+directory of the Jar (or somewhere under it). While extracting the directory structure
+(<samp>images</samp>) will be taken.</p>
<pre>
<unzip src="${ant.home}/lib/ant.jar" dest="...">
@@ -235,10 +203,11 @@ will be taken.</p>
<include name="**/ant_logo_large.gif"/>
<include name="**/LICENSE.txt"/>
</patternset>
-</unzip>
-</pre>
-<p>This extracts the two files <tt>ant_logo_large.gif</tt> and <tt>LICENSE.txt</tt> from the
-<tt>ant.jar</tt>. More exactly: it extracts all files with these names from anywhere in the source file. While extracting the directory structure will be taken.</p>
+</unzip></pre>
+
+<p>This extracts the two files <samp>ant_logo_large.gif</samp> and <samp>LICENSE.txt</samp> from
+the <samp>ant.jar</samp>. More exactly: it extracts all files with these names from anywhere in the
+source file. While extracting the directory structure will be taken.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/uptodate.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/uptodate.html b/manual/Tasks/uptodate.html
index b5a8f5c..bc7bd70 100644
--- a/manual/Tasks/uptodate.html
+++ b/manual/Tasks/uptodate.html
@@ -26,149 +26,126 @@
<h2 id="uptodate">Uptodate</h2>
<h3>Description</h3>
-<p>Sets a property if a target file or set of target files is more up-to-date
-than a source file or set of source files. A single source file is specified
-using the <code>srcfile</code> attribute. A set of source files is specified
-using the nested <code><srcfiles></code>
-elements. These are <a href="../Types/fileset.html">FileSet</a>s,
-whereas multiple target files are specified using a nested
-<a href="../Types/mapper.html"><code><mapper></code></a> element.</p>
-<p>By default, the value of the property is set to <code>true</code> if
-the timestamp of the source file(s) is not more recent than the timestamp of
-the corresponding target file(s). You can set the value to something other
-than the default by specifying the <code>value</code> attribute.</p>
+<p>Sets a property if a target file or set of target files is more up-to-date than a source file or
+set of source files. A single source file is specified using the <var>srcfile</var> attribute. A set
+of source files is specified using the nested <code><srcfiles></code> elements. These
+are <a href="../Types/fileset.html">FileSet</a>s, whereas multiple target files are specified using
+a nested <a href="../Types/mapper.html"><code><mapper></code></a> element.</p>
+<p>By default, the value of the property is set to <q>true</q> if the timestamp of the source
+file(s) is not more recent than the timestamp of the corresponding target file(s). You can set the
+value to something other than the default by specifying the <var>value</var> attribute.</p>
<p>If a <code><srcfiles></code> element is used, without also specifying
-a <code><mapper></code> element, the default behavior is to use a
-<a href="../Types/mapper.html#merge-mapper">merge mapper</a>, with the
-<code>to</code> attribute set to the value of the
-<code>targetfile</code> attribute.</p>
-<p>Normally, this task is used to set properties that are useful to avoid
-target execution depending on the relative age of the specified files.</p>
+a <code><mapper></code> element, the default behavior is to use
+a <a href="../Types/mapper.html#merge-mapper">merge mapper</a>, with the <var>to</var> attribute set
+to the value of the <var>targetfile</var> attribute.</p>
+<p>Normally, this task is used to set properties that are useful to avoid target execution depending
+on the relative age of the specified 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">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>
<tr>
- <td valign="top">value</td>
- <td valign="top">The value to set the property to.</td>
- <td valign="top" align="center">No; defaults to <code>true</code>.</td>
+ <td>value</td>
+ <td>The value to set the property to.</td>
+ <td>No; defaults to <q>true</q>.</td>
</tr>
<tr>
- <td valign="top">srcfile</td>
- <td valign="top">The file to check against the target file(s).</td>
- <td valign="top" align="center">Yes, unless a nested
+ <td>srcfile</td>
+ <td>The file to check against the target file(s).</td>
+ <td>Yes, unless a nested
<code><srcfiles></code> or <code><srcresources></code>
element is present.</td>
</tr>
<tr>
- <td valign="top">targetfile</td>
- <td valign="top">The file for which we want to determine the status.</td>
- <td valign="top" align="center">Yes, unless a nested
- <code><mapper></code> element is present.</td>
+ <td>targetfile</td>
+ <td>The file for which we want to determine the status.</td>
+ <td>Yes, unless a nested <code><mapper></code> element is present.</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4 id="srcfiles">srcfiles</h4>
-<p>The nested <code><srcfiles></code> element is a
-<a href="../Types/fileset.html">fileset</a> and allows you to
-specify a set of files to check against the target file(s).</p>
+<p>The nested <code><srcfiles></code> element is a <a href="../Types/fileset.html">fileset</a>
+and allows you to specify a set of files to check against the target file(s).</p>
-<p><strong>Note</strong>: You can specify either the <code>srcfile</code>
-attribute or nested <code><srcfiles></code> elements, but not both.
+<p><strong>Note</strong>: You can specify either the <var>srcfile</var> attribute or
+nested <code><srcfiles></code> elements, but not both.
-<p>Note that the task will completely ignore any directories that seem
- to be matched by the srcfiles fileset, it will only consider normal
- files. If you need logic that applies to directories as well, use a
- nested srcresource and a dirset (for example).</p>
+<p>Note that the task will completely ignore any directories that seem to be matched by
+the <var>srcfiles</var> fileset, it will only consider normal files. If you need logic that applies
+to directories as well, use a nested <code>srcresources</code> element and a <code>dirset</code>
+(for example).</p>
<h4 id="srcresources">srcresources</h4>
-<p>The nested <code><srcresources></code> element is a <a
-href="../Types/resources.html#union">union</a> and allows you to
-specify a collection of resources to check against the target file(s).
-<em>Since Apache Ant 1.7</em></p>
+<p>The nested <code><srcresources></code> element is
+a <a href="../Types/resources.html#union">union</a> and allows you to specify a collection of
+resources to check against the target file(s). <em>Since Apache Ant 1.7</em></p>
<h4 id="mapper">mapper</h4>
-<p>The nested <code><mapper></code> element allows you to specify
-a set of target files to check for being up-to-date with respect to a
-set of source files.</p>
- <p>
- The mapper "to" attribute is relative to the target file, or to
- the "dir" attribute of the nested srcfiles element.
- </p>
- <p>
- <em>Since Ant 1.6.3</em>,
- one can use a filenamemapper type in place of the mapper element.
- </p>
+<p>The nested <code><mapper></code> element allows you to specify a set of target files to
+check for being up-to-date with respect to a set of source files.</p>
+<p>The mapper <var>to</var> attribute is relative to the target file, or to the <var>dir</var>
+attribute of the nested <code>srcfiles</code> element.</p>
+<p><em>Since Ant 1.6.3</em>, one can use a <code>filenamemapper</code> type in place of the mapper
+element.</p>
<h3>Examples</h3>
-<pre> <uptodate property="xmlBuild.notRequired" targetfile="${deploy}\xmlClasses.jar" >
- <srcfiles dir= "${src}/xml" includes="**/*.dtd"/>
- </uptodate></pre>
-<p>sets the property <code>xmlBuild.notRequired</code> to <code>true</code>
-if the <code>${deploy}/xmlClasses.jar</code> file is more up-to-date than
-any of the DTD files in the <code>${src}/xml</code> directory.</p>
+<pre>
+<uptodate property="xmlBuild.notRequired" targetfile="${deploy}\xmlClasses.jar">
+ <srcfiles dir="${src}/xml" includes="**/*.dtd"/>
+</uptodate></pre>
+<p>sets the property <code>xmlBuild.notRequired</code> to <q>true</q> if
+the <samp>${deploy}/xmlClasses.jar</samp> file is more up-to-date than any of the DTD files in
+the <samp>${src}/xml</samp> directory.</p>
<p>This can be written as:</p>
-<pre> <uptodate property="xmlBuild.notRequired">
- <srcfiles dir= "${src}/xml" includes="**/*.dtd"/>
- <mapper type="merge" to="${deploy}\xmlClasses.jar"/>
- </uptodate></pre>
-<p>as well.
+<pre>
+<uptodate property="xmlBuild.notRequired">
+ <srcfiles dir= "${src}/xml" includes="**/*.dtd"/>
+ <mapper type="merge" to="${deploy}\xmlClasses.jar"/>
+</uptodate></pre>
+<p>as well.</p>
-The <code>xmlBuild.notRequired</code> property can then be used in a
-<code><target></code> tag's <code>unless</code> attribute to
-conditionally run that target. For example, running the following target:</p>
+<p>The <code>xmlBuild.notRequired</code> property can then be used in a <code><target></code>
+tag's <var>unless</var> attribute to conditionally run that target. For example, running the
+following target:</p>
<pre>
<target name="xmlBuild" depends="chkXmlBuild" unless="xmlBuild.notRequired">
...
-</target>
-</pre>
-<p>
-will first run the <code>chkXmlBuild</code> target, which contains
-the <code><uptodate></code> task that determines whether
-<code>xmlBuild.notRequired</code> gets set. The property named in
-the <code>unless</code> attribute is then checked for being set/not set.
-If it did get set (ie., the jar file is up-to-date),
-then the <code>xmlBuild</code> target won't be run.
-</p>
+</target></pre>
+<p>will first run the <q>chkXmlBuild</q> target, which contains the <code><uptodate></code>
+task that determines whether <code>xmlBuild.notRequired</code> gets set. The property named in
+the <var>unless</var> attribute is then checked for being set/not set. If it did get set (ie., the
+jar file is up-to-date), then the <q>xmlBuild</q> target won't be run.</p>
-<p>The following example shows a single source file being checked
-against a single target file:</p>
-<pre> <uptodate property="isUpToDate"
- srcfile="/usr/local/bin/testit"
- targetfile="${build}/.flagfile"/>
+<p>The following example shows a single source file being checked against a single target file:</p>
+<pre>
+<uptodate property="isUpToDate"
+ srcfile="/usr/local/bin/testit"
+ targetfile="${build}/.flagfile"/>
</pre>
-<p>sets the property <code>isUpToDate</code> to <code>true</code>
-if <code>/usr/local/bin/testit</code> is not newer than
-<code>${build}/.flagfile</code>.</p>
- <p>
- The following shows usage of a relative mapper.
- </p>
- <pre>
- <uptodate property="checkUptodate.uptodate">
- <srcfiles dir="src" includes="*"/>
- <mapper type="merge" to="../dest/output.done"/>
- </uptodate>
- <echo message="checkUptodate result: ${checkUptodate.uptodate}"/>
- </pre>
- <p>
- The previous example can be a bit confusing, so it may be better to
- use absolute paths:
- </p>
- <pre>
- <property name="dest.dir" location="dest"/>
- <uptodate property="checkUptodate.uptodate">
- <srcfiles dir="src" includes="*"/>
- <mapper type="merge" to="${dest.dir}/output.done"/>
- </uptodate>
- </pre>
+<p>sets the property <code>isUpToDate</code> to <q>true</q> if <samp>/usr/local/bin/testit</samp> is
+not newer than <samp>${build}/.flagfile</samp>.</p>
+<p>The following shows usage of a relative mapper.</p>
+<pre>
+<uptodate property="checkUptodate.uptodate">
+ <srcfiles dir="src" includes="*"/>
+ <mapper type="merge" to="../dest/output.done"/>
+</uptodate>
+<echo message="checkUptodate result: ${checkUptodate.uptodate}"/></pre>
+<p>The previous example can be a bit confusing, so it may be better to use absolute paths:</p>
+<pre>
+<property name="dest.dir" location="dest"/>
+<uptodate property="checkUptodate.uptodate">
+ <srcfiles dir="src" includes="*"/>
+ <mapper type="merge" to="${dest.dir}/output.done"/>
+</uptodate></pre>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/verifyjar.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/verifyjar.html b/manual/Tasks/verifyjar.html
index 8908b31..3fe02ce 100644
--- a/manual/Tasks/verifyjar.html
+++ b/manual/Tasks/verifyjar.html
@@ -26,115 +26,106 @@
<h2 id="verifyjar">VerifyJar</h2>
<h3>Description</h3>
-<p>Verifies JAR files with the <tt>jarsigner</tt> command line tool.
-It will take a named file in the <tt>jar</tt> attribute. Nested paths are also
-supported
-</p>
+<p>Verifies JAR files with the <code>jarsigner</code> command line tool. It will take a named file
+in the <var>jar</var> attribute. Nested paths are also supported.</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">jar</td>
- <td valign="top">the jar file to verify</td>
- <td valign="top" align="center">Yes, unless nested paths have
- been used.</td>
+ <td>jar</td>
+ <td>the jar file to verify</td>
+ <td>Yes, unless nested paths have been used</td>
</tr>
<tr>
- <td valign="top">alias</td>
- <td valign="top">the alias to verify under</td>
- <td valign="top" align="center">Yes.</td>
+ <td>alias</td>
+ <td>the alias to verify under</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">storepass</td>
- <td valign="top">password for keystore integrity.</td>
- <td valign="top" align="center">Yes.</td>
+ <td>storepass</td>
+ <td>password for keystore integrity.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td valign="top">keystore</td>
- <td valign="top">keystore location</td>
- <td valign="top" align="center">No</td>
+ <td>keystore</td>
+ <td>keystore location</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">storetype</td>
- <td valign="top">keystore type</td>
- <td valign="top" align="center">No</td>
+ <td>storetype</td>
+ <td>keystore type</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">keypass</td>
- <td valign="top">password for private key (if different)</td>
- <td valign="top" align="center">No</td>
+ <td>keypass</td>
+ <td>password for private key (if different)</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">certificates</td>
- <td valign="top">(true | false) display information about certificates</td>
- <td valign="top" align="center">No; default false</td>
+ <td>certificates</td>
+ <td>(<q>true|false</q>) display information about certificates</td>
+ <td>No; default <q>false</q></td>
</tr>
<tr>
- <td valign="top">verbose</td>
- <td valign="top">(true | false) verbose output when verifying</td>
- <td valign="top" align="center">No; default false</td>
+ <td>verbose</td>
+ <td>(<q>true|false</q>) verbose output when verifying</td>
+ <td>No; default <q>false</q></td>
</tr>
<tr>
- <td valign="top">strict</td>
- <td valign="top">(true | false) strict checking when verifying.<br/><em>since Ant 1.9.1</em>.</td>
- <td valign="top" align="center">No; default false</td>
+ <td>strict</td>
+ <td>(<q>true|false</q>) strict checking when verifying.<br/><em>since Ant 1.9.1</em>.</td>
+ <td>No; default <q>false</q></td>
</tr>
<tr>
- <td valign="top">maxmemory</td>
- <td valign="top">Specifies the maximum memory the jarsigner VM will use. Specified in the
- style of standard java memory specs (e.g. 128m = 128 MBytes)</td>
- <td valign="top" align="center">No</td>
+ <td>maxmemory</td>
+ <td>Specifies the maximum memory the <code>jarsigner</code> JVM will use. Specified in the style
+ of standard Java memory specs (e.g. <q>128m</q> = 128 MBytes)</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">executable</td>
- <td valign="top">Specify a particular <code>jarsigner</code> executable
- to use in place of the default binary (found in the same JDK as
- Apache Ant is running in).<br/>
- Must support the same command line options as the Sun JDK
- jarsigner command.
- <em>since Ant 1.8.0</em>.</td>
- <td align="center" valign="top">No</td>
+ <td>executable</td>
+ <td>Specify a particular <code>jarsigner</code> executable to use in place of the default binary
+ (found in the same JDK as Apache Ant is running in).<br/> Must support the same command line
+ options as the Sun JDK <code>jarsigner</code> command. <em>since Ant 1.8.0</em>.</td>
+ <td>No</td>
</tr>
</table>
<h3>Parameters as nested elements</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">path</td>
- <td valign="top">path of JAR files to verify. <em>since Ant 1.7</em></td>
- <td valign="top" align="center">No</td>
+ <td>path</td>
+ <td>path of JAR files to verify. <em>since Ant 1.7</em></td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">fileset</td>
- <td valign="top">fileset of JAR files to verify.</td>
- <td valign="top" align="center">No</td>
+ <td>fileset</td>
+ <td>fileset of JAR files to verify.</td>
+ <td>No</td>
</tr>
<tr>
- <td valign="top">sysproperty</td>
- <td valign="top">JVM system properties, with the syntax of Ant
- <a href="exec.html#env">environment variables</a></td>
- <td valign="top" align="center">No, and only one can be supplied</td>
+ <td>sysproperty</td>
+ <td>JVM system properties, with the syntax of Ant <a href="exec.html#env">environment
+ variables</a></td>
+ <td>No, and only one can be supplied</td>
</tr>
</table>
<h3>Examples</h3>
<pre>
<verifyjar jar="${dist}/lib/ant.jar"
-alias="apache-group" storepass="secret"/>
-</pre>
-<p>
- verifies the ant.jar with alias "apache-group" accessing the
- keystore and private key via "secret" password.
-</p>
+ alias="apache-group" storepass="secret"/></pre>
+<p>verifies the <samp>ant.jar</samp> with alias <q>apache-group</q> accessing the keystore and
+private key via <q>secret</q> password.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/vss.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/vss.html b/manual/Tasks/vss.html
index e02b76d..99d6c1d 100644
--- a/manual/Tasks/vss.html
+++ b/manual/Tasks/vss.html
@@ -17,183 +17,177 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
-<title>Microsoft Visual SourceSafe(VSS) Tasks</title>
+<title>Microsoft Visual SourceSafe (VSS) Tasks</title>
</head>
<body>
<h1>Microsoft Visual SourceSafe Tasks User Manual</h1>
<p>by</p>
<ul>
- <li>Craig Cottingham</li>
- <li>Andrew Everitt</li>
- <li>Balazs Fejes 2</li>
- <li><a href="mailto:Glenn_Twiggs@bmc.com">Glenn_Twiggs@bmc.com</a></li>
- <li>Martin Poeschl (<a href="mailto:mpoeschl@marmot.at">mpoeschl@marmot.at</a>)</li>
- <li>Phillip Wells</li>
- <li>Jon Skeet (<a href="mailto:jon.skeet@peramon.com">jon.skeet@peramon.com</a>)</li>
- <li>Nigel Magnay (<a href="mailto:nigel.magnay@parsec.co.uk">nigel.magnay@parsec.co.uk</a>)</li>
- <li>Gary S. Weaver</li>
- <li>Jesse Stockall</li>
- </ul>
+ <li>Craig Cottingham</li>
+ <li>Andrew Everitt</li>
+ <li>Balazs Fejes 2</li>
+ <li><a href="mailto:Glenn_Twiggs@bmc.com">Glenn_Twiggs@bmc.com</a></li>
+ <li>Martin Poeschl (<a href="mailto:mpoeschl@marmot.at">mpoeschl@marmot.at</a>)</li>
+ <li>Phillip Wells</li>
+ <li>Jon Skeet (<a href="mailto:jon.skeet@peramon.com">jon.skeet@peramon.com</a>)</li>
+ <li>Nigel Magnay (<a href="mailto:nigel.magnay@parsec.co.uk">nigel.magnay@parsec.co.uk</a>)</li>
+ <li>Gary S. Weaver</li>
+ <li>Jesse Stockall</li>
+</ul>
<hr>
<h2>Contents</h2>
<ul>
- <li><a href="#intro">Introduction</a></li>
- <li><a href="#tasks">The Tasks</a></li>
+ <li><a href="#intro">Introduction</a></li>
+ <li><a href="#tasks">The Tasks</a></li>
</ul>
-<br>
+
+<br/>
<h2 id="intro">Introduction</h2>
-<p>These tasks provide an interface to the
-<a href="http://msdn.microsoft.com/ssafe/default.asp" target="_top">Microsoft Visual SourceSafe</a> SCM.
-The <code>org.apache.tools.ant.taskdefs.optional.vss</code> package consists of a simple framework to support
-vss functionality as well as some Apache Ant tasks encapsulating frequently used vss commands.
-Although it is possible to use these commands on the desktop,
-they were primarily intended to be used by automated build systems.</p>
-<p>
-If you get a CreateProcess IOError=2 when running these, it means
-that ss.exe was not found. Check to see if you can run it from the
-command line -you may need to alter your path, or set the <tt>ssdir</tt>
-property.
+<p>These tasks provide an interface to
+the <a href="https://msdn.microsoft.com/en-us/library/3h0544kx(v=vs.80).aspx"
+target="_top">Microsoft Visual SourceSafe</a> SCM.
+The <code>org.apache.tools.ant.taskdefs.optional.vss</code> package consists of a simple framework
+to support VSS functionality as well as some Apache Ant tasks encapsulating frequently used VSS
+commands. Although it is possible to use these commands on the desktop, they were primarily
+intended to be used by automated build systems.</p>
+<p>If you get a <code>CreateProcess error=2</code> when running these, it means
+that <code>ss.exe</code> was not found. Check to see if you can run it from the command
+line—you may need to alter your path, or set the <var>ssdir</var> property.</p>
<h2 id="tasks">The Tasks</h2>
<table>
- <tr><td>Task</td><td>Description</td></tr>
- <tr>
- <td><a href="#vssget">vssget</a></td>
- <td>Retrieves a copy of the specified VSS file(s).</td>
- </tr>
- <tr>
- <td><a href="#vsslabel">vsslabel</a></td>
- <td>Assigns a label to the specified version or current version of a file or project.</td>
- </tr>
- <tr>
- <td><a href="#vsshistory">vsshistory</a></td>
- <td>Shows the history of a file or project in VSS.</td>
- </tr>
- <tr>
- <td><a href="#vsscheckin">vsscheckin</a></td>
- <td>Updates VSS with changes made to a checked out file, and unlocks the VSS master copy.</td>
- </tr>
- <tr>
- <td><a href="#vsscheckout">vsscheckout</a></td>
- <td>Copies a file from the current project to the current folder, for the purpose of editing.</td>
- </tr>
- <tr>
- <td><a href="#vssadd">vssadd</a></td>
- <td>Adds a new file into the VSS Archive</td>
- </tr>
- <tr>
- <td><a href="#vsscp">vsscp</a></td>
- <td>Change the current project being used in VSS</td>
- </tr>
- <tr>
- <td><a href="#vsscreate">vsscreate</a></td>
- <td>Creates a project in VSS.</td>
- </tr>
+ <tr><th>Task</th><th>Description</th></tr>
+ <tr>
+ <td><a href="#vssget">vssget</a></td>
+ <td>Retrieves a copy of the specified VSS file(s).</td>
+ </tr>
+ <tr>
+ <td><a href="#vsslabel">vsslabel</a></td>
+ <td>Assigns a label to the specified version or current version of a file or project.</td>
+ </tr>
+ <tr>
+ <td><a href="#vsshistory">vsshistory</a></td>
+ <td>Shows the history of a file or project in VSS.</td>
+ </tr>
+ <tr>
+ <td><a href="#vsscheckin">vsscheckin</a></td>
+ <td>Updates VSS with changes made to a checked out file, and unlocks the VSS master copy.</td>
+ </tr>
+ <tr>
+ <td><a href="#vsscheckout">vsscheckout</a></td>
+ <td>Copies a file from the current project to the current folder, for the purpose of editing.</td>
+ </tr>
+ <tr>
+ <td><a href="#vssadd">vssadd</a></td>
+ <td>Adds a new file into the VSS Archive</td>
+ </tr>
+ <tr>
+ <td><a href="#vsscp">vsscp</a></td>
+ <td>Change the current project being used in VSS</td>
+ </tr>
+ <tr>
+ <td><a href="#vsscreate">vsscreate</a></td>
+ <td>Creates a project in VSS.</td>
+ </tr>
</table>
-<hr>
+<hr/>
<h2>Task Descriptions</h2>
<!-- VSSGET -->
<h2 id="vssget">VssGet</h2>
<h3>Description</h3>
-Task to perform GET commands to Microsoft Visual SourceSafe.
-<p>If you specify two or more attributes from version, date and
-label only one will be used in the order version, date, label.</p>
+<p>Task to perform GET commands to Microsoft Visual SourceSafe.</p>
+<p>If you specify two or more attributes from version, date and label only one will be used in the
+order version, date, label.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
- <td>vsspath</td>
- <td>SourceSafe path which specifies the project/file(s) you wish to
- perform the action on.</td>
- <td>Yes</td>
+ <td>vsspath</td>
+ <td>SourceSafe path which specifies the project/file(s) you wish to perform the action on.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td>login</td>
- <td>username[,password] - The username and password needed to get access
- to VSS. Note that you may need to specify both (if you have a password) -
- Ant/VSS will hang if you leave the password out and VSS does not accept
- login without a password.</td>
- <td>No</td>
+ <td>login</td>
+ <td><q>username[,password]</q>—The username and password needed to get access to VSS. Note
+ that you may need to specify both (if you have a password)—Ant/VSS will hang if you
+ leave the password out and VSS does not accept login without a password.</td>
+ <td>No</td>
</tr>
<tr>
- <td>localpath</td>
- <td>Override the working directory and get to the specified path</td>
- <td>No</td>
+ <td>localpath</td>
+ <td>Override the working directory and get to the specified path</td>
+ <td>No</td>
</tr>
<tr>
- <td>ssdir</td>
- <td>directory where <code>ss.exe</code> resides. By default the
- task expects it to be in the PATH.</td>
- <td>No</td>
+ <td>ssdir</td>
+ <td>directory where <code>ss.exe</code> resides.</td>
+ <td>No; by default expected to be in <code>PATH</code></td>
</tr>
<tr>
- <td>serverPath</td>
- <td>directory where <code>srcsafe.ini</code> resides.</td>
- <td>No</td>
+ <td>serverPath</td>
+ <td>directory where <samp>srcsafe.ini</samp> resides.</td>
+ <td>No</td>
</tr>
<tr>
- <td>writable</td>
- <td>true or false; default false</td>
- <td>No</td>
+ <td>writable</td>
+ <td><q>true|false</q></td>
+ <td>No; default <q>false</q></td>
</tr>
<tr>
- <td>recursive</td>
- <td>true or false; default false. Note however that in the SourceSafe UI
- , there is a setting accessed via Tools/Options/GeneralTab called
- "Act on projects recursively". If this setting is checked,
- then the recursive attribute is effectively ignored, and the get
- will always be done recursively
- </td>
- <td>No</td>
+ <td>recursive</td>
+ <td><q>true|false</q>. Note however that in the SourceSafe UI there is a setting accessed
+ via <q>Tools/Options/GeneralTab</q> called <q>Act on projects recursively</q>. If this
+ setting is checked, then the <var>recursive</var> attribute is effectively ignored, and get
+ will always be done recursively</td>
+ <td>No; default <q>false</q></td>
</tr>
<tr>
- <td>version</td>
- <td>a version number to get</td>
- <td rowspan="3">No; only one of these may be used</td>
+ <td>version</td>
+ <td>a version number to get</td>
+ <td rowspan="3">No; only one of these may be used</td>
</tr>
<tr>
- <td>date</td>
- <td>a date stamp to get at</td>
+ <td>date</td>
+ <td class="left">a date stamp to get at</td>
</tr>
<tr>
- <td>label</td>
- <td>a label to get for</td>
+ <td>label</td>
+ <td class="left">a label to get for</td>
</tr>
<tr>
- <td>quiet</td>
- <td>suppress output (off by default)</td>
- <td>No</td>
+ <td>quiet</td>
+ <td>suppress output</td>
+ <td>No; defaults to <q>off</q></td>
</tr>
<tr>
- <td>autoresponse</td>
- <td>What to respond with (sets the -I option). By default, -I- is
- used; values of Y or N will be appended to this.</td>
- <td>No</td>
+ <td>autoresponse</td>
+ <td>What to respond with (sets the <code>-I</code> option). By default, <code>-I-</code> is
+ used; values of <q>Y</q> or <q>N</q> will be appended to this.</td>
+ <td>No</td>
</tr>
<tr>
<td>writablefiles</td>
- <td>Behavior when local files are writable. Valid options are: <code>replace</code>,
- <code>skip</code> and <code>fail</code>; Defaults to <code>fail</code>
- <br><code>skip</code> implies <code>failonerror=false</code></td>
- <td>No</td>
+ <td>Behavior when local files are writable. Valid options are: <q>replace</q>, <q>skip</q>
+ and <q>fail</q>; <q>skip</q> implies <var>failonerror</var>=<q>false</q></td>
+ <td>No; defaults to <q>fail</q></td>
</tr>
<tr>
<td>failonerror</td>
- <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
- <td>No</td>
+ <td>Stop the build process if <code>ss.exe</code> exits with a return code <q>100</q></td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
<td>filetimestamp</td>
- <td>Set the behavior for timestamps of local files. Valid options are <code>current</code>,
- <code>modified</code>, or <code>updated</code>. Defaults to <code>current</code>.</td>
- <td>No</td>
+ <td>Set the behavior for timestamps of local files. Valid options
+ are <q>current</q>, <q>modified</q>, or <q>updated</q>.</td>
+ <td>No; defaults to <q>current</q></td>
</tr>
</table>
<p>Note that only one of version, date or label should be specified</p>
@@ -205,106 +199,98 @@ label only one will be used in the order version, date, label.</p>
label="Release1"
login="me,mypassword"
vsspath="$/source/aProject"
- writable="true"/>
-</pre>
+ writable="true"/></pre>
-<p>Does a get on the VSS-Project <i>$/source/myproject</i> using the username
-<i>me</i> and the password <i>mypassword</i>. It will recursively get the files
-which are labeled <i>Release1</i> and write them to the local directory
-<i>C:\mysrc\myproject</i>. The local files will be writable.</p>
-<hr>
+<p>Does a get on the VSS Project <samp>$/source/myproject</samp> using the username <q>me</q> and
+the password <q>mypassword</q>. It will recursively get the files which are labeled <q>Release1</q>
+and write them to the local directory <samp>C:\mysrc\myproject</samp>. The local files will be
+writable.</p>
+
+<hr/>
<!-- VSSLABEL -->
<h2 id="vsslabel">VssLabel</h2>
<h3>Description</h3>
-Task to perform LABEL commands to Microsoft Visual SourceSafe.
-<p>Assigns a label to the specified version or current version of a file or
-project.</p>
+<p>Task to perform LABEL commands to Microsoft Visual SourceSafe.</p>
+<p>Assigns a label to the specified version or current version of a file or project.</p>
<h3>Parameters</h3>
-<table>
- <tr>
- <th>Attribute</th>
- <th>Values</th>
- <th>Required</th>
- </tr>
+<table class="attr">
<tr>
- <td>vsspath</td>
- <td>SourceSafe path which specifies the project/file(s) you wish to
- perform the action on.</td>
- <td>Yes</td>
+ <th>Attribute</th>
+ <th>Values</th>
+ <th>Required</th>
</tr>
<tr>
- <td>login</td>
- <td>username[,password] - The username and password needed to get access
- to VSS. Note that you may need to specify both (if you have a password) -
- Ant/VSS will hang if you leave the password out and VSS does not accept
- login without a password.</td>
- <td>No</td>
+ <td>vsspath</td>
+ <td>SourceSafe path which specifies the project/file(s) you wish to perform the action on.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td>ssdir</td>
- <td>directory where <code>ss.exe</code> resides. By default the
- task expects it to be in the PATH.</td>
- <td>No</td>
+ <td>login</td>
+ <td><q>username[,password]</q>—The username and password needed to get access to VSS. Note
+ that you may need to specify both (if you have a password)—Ant/VSS will hang if you
+ leave the password out and VSS does not accept login without a password.</td>
+ <td>No</td>
</tr>
<tr>
- <td>serverPath</td>
- <td>directory where <code>srcsafe.ini</code> resides.</td>
- <td>No</td>
+ <td>ssdir</td>
+ <td>directory where <code>ss.exe</code> resides.</td>
+ <td>No; by default expected to be in <code>PATH</code></td>
</tr>
- <tr>
- <td>label</td>
- <td>A label to apply to the hierarchy</td>
- <td>Yes</td>
- </tr>
- <tr>
- <td>version</td>
- <td>An existing file or project version to label. By default the current
- version is labeled.</td>
- <td>No</td>
- </tr>
- <tr>
- <td>comment</td>
- <td>The comment to use for this label. Empty or '-' for no comment.</td>
- <td>No</td>
- </tr>
- <tr>
- <td>autoresponse</td>
- <td>What to respond with (sets the -I option). By default, -I- is
- used; values of Y or N will be appended to this.</td>
- <td>No</td>
+ <tr>
+ <td>serverPath</td>
+ <td>directory where <samp>srcsafe.ini</samp> resides.</td>
+ <td>No</td>
</tr>
<tr>
- <td>failonerror</td>
- <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
+ <td>label</td>
+ <td>A label to apply to the hierarchy</td>
+ <td>Yes</td>
+ </tr>
+ <tr>
+ <td>version</td>
+ <td>An existing file or project version to label. By default the current version is
+ labeled.</td>
<td>No</td>
</tr>
+ <tr>
+ <td>comment</td>
+ <td>The comment to use for this label. Empty or <q>-</q> for no comment.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>autoresponse</td>
+ <td>What to respond with (sets the <code>-I</code> option). By default, <code>-I-</code> is
+ used; values of <q>Y</q> or <q>N</q> will be appended to this.</td>
+ <td>No</td>
+ </tr>
+ <tr>
+ <td>failonerror</td>
+ <td>Stop the build process if <code>ss.exe</code> exits with a return code <q>100</q>.</td>
+ <td>No; defaults to <q>true</q></td>
+ </tr>
</table>
<h3>Examples</h3>
<pre>
<vsslabel vsspath="$/source/aProject"
login="me,mypassword"
- label="Release1"/>
-</pre>
+ label="Release1"/></pre>
-<p>Labels the current version of the VSS project <i>$/source/aProject</i> with
-the label <i>Release1</i> using the username <i>me</i> and the password
-<i>mypassword</i>.
-</p>
+<p>Labels the current version of the VSS project <samp>$/source/aProject</samp> with the
+label <q>Release1</q> using the username <q>me</q> and the password <q>mypassword</q>.</p>
<pre>
<vsslabel vsspath="$/source/aProject/myfile.txt"
version="4"
- label="1.03.004"/>
-</pre>
+ label="1.03.004"/></pre>
-<p>Labels version 4 of the VSS file <i>$/source/aProject/myfile.txt</i> with the
-label <i>1.03.004</i>. If this version already has a label, the operation (and
-the build) will fail.
-</p>
-<hr>
+<p>Labels version 4 of the VSS file <samp>$/source/aProject/myfile.txt</samp> with the
+label <q>1.03.004</q>. If this version already has a label, the operation (and the build) will
+fail.</p>
+
+<hr/>
<!-- VSSHISTORY -->
@@ -312,36 +298,33 @@ the build) will fail.
<h3>Description</h3>
Task to perform HISTORY commands to Microsoft Visual SourceSafe.
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
- <td>vsspath</td>
- <td>SourceSafe path which specifies the project/file(s) you wish to
- perform the action on.</td>
- <td>Yes</td>
+ <td>vsspath</td>
+ <td>SourceSafe path which specifies the project/file(s) you wish to perform the action on.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td>login</td>
- <td>username[,password] - The username and password needed to get access
- to VSS. Note that you may need to specify both (if you have a password) -
- Ant/VSS will hang if you leave the password out and VSS does not accept
- login without a password.</td>
- <td>No</td>
+ <td>login</td>
+ <td><q>username[,password]</q>—The username and password needed to get access to VSS. Note
+ that you may need to specify both (if you have a password)—Ant/VSS will hang if you
+ leave the password out and VSS does not accept login without a password.</td>
+ <td>No</td>
</tr>
<tr>
- <td>ssdir</td>
- <td>directory where <code>ss.exe</code> resides. By default the
- task expects it to be in the PATH.</td>
- <td>No</td>
+ <td>ssdir</td>
+ <td>directory where <code>ss.exe</code> resides.</td>
+ <td>No; by default expected to be in <code>PATH</code></td>
</tr>
<tr>
- <td>serverPath</td>
- <td>directory where <code>srcsafe.ini</code> resides.</td>
- <td>No</td>
+ <td>serverPath</td>
+ <td>directory where <samp>srcsafe.ini</samp> resides.</td>
+ <td>No</td>
</tr>
<tr>
<td>fromDate</td>
@@ -355,10 +338,10 @@ Task to perform HISTORY commands to Microsoft Visual SourceSafe.
</tr>
<tr>
<td>dateFormat</td>
- <td>Format of dates in fromDate and toDate. Used when calculating dates with
- the numdays attribute. This string uses the formatting rules of SimpleDateFormat.
- Defaults to DateFormat.SHORT.</td>
- <td>No</td>
+ <td>Format of dates in <var>fromDate</var> and <var>toDate</var>. Used when calculating dates
+ with the <var>numdays</var> attribute. This string uses the formatting rules of
+ SimpleDateFormat.</td>
+ <td>No; defaults to <code>DateFormat.SHORT</code></td>
</tr>
<tr>
<td>fromLabel</td>
@@ -382,13 +365,13 @@ Task to perform HISTORY commands to Microsoft Visual SourceSafe.
</tr>
<tr>
<td>recursive</td>
- <td>true or false</td>
+ <td><q>true|false</q></td>
<td>No</td>
</tr>
<tr>
<td>style</td>
- <td>brief, codediff, default or nofile. The default is default.</td>
- <td>No</td>
+ <td><q>brief</q>, <q>codediff</q>, <q>default</q> or <q>nofile</q>.</td>
+ <td>No; defaults to <q>default</q></td>
</tr>
<tr>
<td>user</td>
@@ -397,43 +380,39 @@ Task to perform HISTORY commands to Microsoft Visual SourceSafe.
</tr>
<tr>
<td>failonerror</td>
- <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
- <td>No</td>
+ <td>Stop the build process if <code>ss.exe</code> exits with a return code <q>100</q></td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
<h4>Specifying the time-frame</h4>
<p>There are different ways to specify what time-frame you wish to evaluate:</p>
<ul>
- <li>Changes between two dates: Specify both <code>fromDate</code> and <code>toDate</code></li>
- <li>Changes before a date: Specify <code>toDate</code></li>
- <li>Changes after a date: Specify <code>fromDate</code></li>
- <li>Changes X Days before a date: Specify <code>toDate</code> and (negative!) <code>numDays</code></li>
- <li>Changes X Days after a date: Specify <code>fromDate</code> and <code>numDays</code></li>
+ <li>Changes between two dates: Specify both <var>fromDate</var> and <var>toDate</var></li>
+ <li>Changes before a date: Specify <var>toDate</var></li>
+ <li>Changes after a date: Specify <var>fromDate</var></li>
+ <li>Changes X Days before a date: Specify <var>toDate</var> and (negative!) <var>numDays</var></li>
+ <li>Changes X Days after a date: Specify <var>fromDate</var> and <var>numDays</var></li>
</ul>
-
<h3>Examples</h3>
- <pre>
+<pre>
<vsshistory vsspath="$/myProject" recursive="true"
fromLabel="Release1"
- toLabel="Release2"/>
-</pre>
+ toLabel="Release2"/></pre>
-<p>Shows all changes between "Release1" and "Release2".</p>
+<p>Shows all changes between <q>Release1</q> and <q>Release2</q>.</p>
-
- <pre>
+<pre>
<vsshistory vsspath="$/myProject" recursive="true"
fromDate="01.01.2001"
- toDate="31.03.2001"/>
-</pre>
-
-<p>Shows all changes between January 1st 2001 and March 31st 2001 (in Germany, date must be specified according to your locale).</p>
+ toDate="31.03.2001"/></pre>
+<p>Shows all changes between January 1st 2001 and March 31st 2001 (in Germany, date must be
+specified according to your locale).</p>
- <pre>
+<pre>
<tstamp>
<format property="to.tstamp" pattern="M-d-yy;h:mma"/>
</tstamp>
@@ -441,19 +420,18 @@ Task to perform HISTORY commands to Microsoft Visual SourceSafe.
<vsshistory vsspath="$/myProject" recursive="true"
numDays="-14"
dateFormat="M-d-yy;h:mma"
- toDate="${to.tstamp}"/>
-</pre>
+ toDate="${to.tstamp}"/></pre>
<p>Shows all changes in the 14 days before today.</p>
-<hr>
+<hr/>
<!-- VSSCHECKIN -->
<h2 id="vsscheckin">VssCheckin</h2>
<h3>Description</h3>
-Task to perform CHECKIN commands to Microsoft Visual SourceSafe.
+<p>Task to perform CHECKIN commands to Microsoft Visual SourceSafe.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -461,16 +439,14 @@ Task to perform CHECKIN commands to Microsoft Visual SourceSafe.
</tr>
<tr>
<td>vsspath</td>
- <td>SourceSafe path which specifies the project/file(s) you wish to
- perform the action on.</td>
+ <td>SourceSafe path which specifies the project/file(s) you wish to perform the action on.</td>
<td>Yes</td>
</tr>
<tr>
<td>login</td>
- <td>username[,password] - The username and password needed to get access
- to VSS. Note that you may need to specify both (if you have a password) -
- Ant/VSS will hang if you leave the password out and VSS does not accept
- login without a password.</td>
+ <td><q>username[,password]</q>—The username and password needed to get access to
+ VSS. Note that you may need to specify both (if you have a password)—Ant/VSS will hang
+ if you leave the password out and VSS does not accept login without a password.</td>
<td>No</td>
</tr>
<tr>
@@ -480,39 +456,38 @@ Task to perform CHECKIN commands to Microsoft Visual SourceSafe.
</tr>
<tr>
<td>ssdir</td>
- <td>directory where <code>ss.exe</code> resides. By default the
- task expects it to be in the PATH.</td>
- <td>No</td>
+ <td>directory where <code>ss.exe</code> resides.</td>
+ <td>No; by default expected to be in <code>PATH</code></td>
</tr>
<tr>
- <td>serverPath</td>
- <td>directory where <code>srcsafe.ini</code> resides.</td>
- <td>No</td>
+ <td>serverPath</td>
+ <td>directory where <samp>srcsafe.ini</samp> resides.</td>
+ <td>No</td>
</tr>
<tr>
- <td>writable</td>
- <td>true or false</td>
- <td>No</td>
+ <td>writable</td>
+ <td><q>true|false</q></td>
+ <td>No</td>
</tr>
<tr>
- <td>recursive</td>
- <td>true or false</td>
- <td>No</td>
+ <td>recursive</td>
+ <td><q>true|false</q></td>
+ <td>No</td>
</tr>
<tr>
- <td>comment</td>
- <td>Comment to use for the files that where checked in.</td>
- <td>No</td>
+ <td>comment</td>
+ <td>Comment to use for the files that where checked in.</td>
+ <td>No</td>
</tr>
<tr>
- <td>autoresponse</td>
- <td>'Y', 'N' or empty. Specify how to reply to questions from VSS.</td>
- <td>No</td>
+ <td>autoresponse</td>
+ <td><q>Y</q>, <q>N</q> or empty. Specify how to reply to questions from VSS.</td>
+ <td>No</td>
</tr>
<tr>
<td>failonerror</td>
- <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
- <td>No</td>
+ <td>Stop the build process if <code>ss.exe</code> exits with a return code <q>100</q>.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
@@ -524,99 +499,97 @@ Task to perform CHECKIN commands to Microsoft Visual SourceSafe.
comment="Modified by automatic build"/>
</pre>
-<p>Checks in the file(s) named <i>test*</i> in the project <i>$/test</i> using
-the local directory <i>D:\build</i>.</p>
-<hr>
+<p>Checks in the file(s) named <samp>test*</samp> in the project <samp>$/test</samp> using the local
+directory <samp>D:\build</samp>.</p>
+
+<hr/>
<!-- VSSCHECKOUT -->
<h2 id="vsscheckout">VssCheckout</h2>
<h3>Description</h3>
-Task to perform CHECKOUT commands to Microsoft Visual SourceSafe.
-<p>If you specify two or more attributes from version, date and
-label only one will be used in the order version, date, label.</p>
+<p>Task to perform CHECKOUT commands to Microsoft Visual SourceSafe.</p>
+<p>If you specify two or more attributes from <var>version</var>, <var>date</var>
+and <var>label</var> only one will be used in the
+order <var>version</var>, <var>date</var>, <var>label</var>.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
- <td>vsspath</td>
- <td>SourceSafe path which specifies the project/file(s) you wish to
- perform the action on.</td>
- <td>Yes</td>
+ <td>vsspath</td>
+ <td>SourceSafe path which specifies the project/file(s) you wish to perform the action on.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td>login</td>
- <td>username[,password] - The username and password needed to get access
- to VSS. Note that you may need to specify both (if you have a password) -
- Ant/VSS will hang if you leave the password out and VSS does not accept
- login without a password.</td>
- <td>No</td>
+ <td>login</td>
+ <td><q>username[,password]</q>—The username and password needed to get access to VSS. Note
+ that you may need to specify both (if you have a password)—Ant/VSS will hang if you
+ leave the password out and VSS does not accept login without a password.</td>
+ <td>No</td>
</tr>
<tr>
- <td>localpath</td>
- <td>Override the working directory and get to the specified path</td>
- <td>No</td>
+ <td>localpath</td>
+ <td>Override the working directory and get to the specified path</td>
+ <td>No</td>
</tr>
<tr>
- <td>ssdir</td>
- <td>directory where <code>ss.exe</code> resides. By default the
- task expects it to be in the PATH.</td>
- <td>No</td>
+ <td>ssdir</td>
+ <td>directory where <code>ss.exe</code> resides.</td>
+ <td>No; by default expected to be in <code>PATH</code></td>
</tr>
<tr>
- <td>serverPath</td>
- <td>directory where <code>srcsafe.ini</code> resides.</td>
- <td>No</td>
+ <td>serverPath</td>
+ <td>directory where <samp>srcsafe.ini</samp> resides.</td>
+ <td>No</td>
</tr>
<tr>
- <td>writable</td>
- <td>true or false</td>
- <td>No</td>
+ <td>writable</td>
+ <td><q>true|false</q></td>
+ <td>No</td>
</tr>
<tr>
- <td>recursive</td>
- <td>true or false</td>
- <td>No</td>
+ <td>recursive</td>
+ <td><q>true|false</q></td>
+ <td>No</td>
</tr>
<tr>
- <td>version</td>
- <td>a version number to get</td>
- <td rowspan="3">No; only one of these may be used</td>
+ <td>version</td>
+ <td>a version number to get</td>
+ <td rowspan="3">No; only one of these may be used</td>
</tr>
<tr>
- <td>date</td>
- <td>a date stamp to get at</td>
+ <td>date</td>
+ <td class="left">a date stamp to get at</td>
</tr>
<tr>
- <td>label</td>
- <td>a label to get for</td>
+ <td>label</td>
+ <td class="left">a label to get for</td>
</tr>
<tr>
<td>writablefiles</td>
- <td>Behavior when local files are writable. Valid options are: <code>replace</code>,
- <code>skip</code> and <code>fail</code>; Defaults to <code>fail</code>
- <br><code>skip</code> implies <code>failonerror=false</code></td>
- <td>No</td>
+ <td>Behavior when local files are writable. Valid options are: <q>replace</q>, <q>skip</q>
+ and <q>fail</q>; <q>skip</q> implies <var>failonerror</var>=<q>false</q></td>
+ <td>No; defaults to <q>fail</q></td>
</tr>
<tr>
<td>failonerror</td>
- <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
- <td>No</td>
+ <td>Stop the build process if <code>ss.exe</code> exits with a return code <q>100</q>.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
<td>filetimestamp</td>
- <td>Set the behavior for timestamps of local files. Valid options are <code>current</code>,
- <code>modified</code>, or <code>updated</code>. Defaults to <code>current</code>.</td>
- <td>No</td>
+ <td>Set the behavior for timestamps of local files. Valid options
+ are <q>current</q>, <q>modified</q>, or <q>updated</q>.</td>
+ <td>No; defaults to <q>current</q></td>
</tr>
<tr>
<td>getlocalcopy</td>
- <td>Set the behavior to retrieve local copies of the files. Defaults to true.</td>
- <td>No</td>
+ <td>Set the behavior to retrieve local copies of the files.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
@@ -626,12 +599,12 @@ label only one will be used in the order version, date, label.</p>
<vsscheckout vsspath="$/test"
localpath="D:\build"
recursive="true"
- login="me,mypass"/>
-</pre>
+ login="me,mypass"/></pre>
-<p>Does a recursive checkout of the project <i>$/test</i> to the directory D:\build.
-</p>
-<hr>
+<p>Does a recursive checkout of the project <samp>$/test</samp> to the
+directory <samp>D:\build</samp>.</p>
+
+<hr/>
<!-- VSSADD -->
@@ -639,60 +612,58 @@ label only one will be used in the order version, date, label.</p>
<h3>Description</h3>
Task to perform ADD commands to Microsoft Visual SourceSafe.
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
- <td>localpath</td>
- <td>Specify the local file(s) to add to VSS</td>
- <td>Yes</td>
+ <td>localpath</td>
+ <td>Specify the local file(s) to add to VSS</td>
+ <td>Yes</td>
</tr>
<tr>
- <td>login</td>
- <td>username[,password] - The username and password needed to get access
- to VSS. Note that you may need to specify both (if you have a password) -
- Ant/VSS will hang if you leave the password out and VSS does not accept
- login without a password.</td>
- <td>No</td>
+ <td>login</td>
+ <td><q>username[,password]</q>—The username and password needed to get access to VSS. Note
+ that you may need to specify both (if you have a password)—Ant/VSS will hang if you
+ leave the password out and VSS does not accept login without a password.</td>
+ <td>No</td>
</tr>
<tr>
- <td>ssdir</td>
- <td>directory where <code>ss.exe</code> resides. By default the
- task expects it to be in the PATH.</td>
- <td>No</td>
+ <td>ssdir</td>
+ <td>directory where <code>ss.exe</code> resides.</td>
+ <td>No; by default expected to be in <code>PATH</code></td>
</tr>
<tr>
- <td>serverPath</td>
- <td>directory where <code>srcsafe.ini</code> resides.</td>
- <td>No</td>
+ <td>serverPath</td>
+ <td>directory where <samp>srcsafe.ini</samp> resides.</td>
+ <td>No</td>
</tr>
<tr>
- <td>writable</td>
- <td>true or false</td>
- <td>No</td>
+ <td>writable</td>
+ <td><q>true|false</q></td>
+ <td>No</td>
</tr>
<tr>
- <td>recursive</td>
- <td>true or false</td>
- <td>No</td>
+ <td>recursive</td>
+ <td><q>true|false</q></td>
+ <td>No</td>
</tr>
<tr>
- <td>comment</td>
- <td>Comment to use for the files that where checked in.</td>
- <td>No</td>
+ <td>comment</td>
+ <td>Comment to use for the files that where checked in.</td>
+ <td>No</td>
</tr>
<tr>
- <td>autoresponse</td>
- <td>'Y', 'N' or empty. Specify how to reply to questions from VSS.</td>
- <td>No</td>
+ <td>autoresponse</td>
+ <td><q>Y</q>, <q>N</q> or empty. Specify how to reply to questions from VSS.</td>
+ <td>No</td>
</tr>
<tr>
<td>failonerror</td>
- <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
- <td>No</td>
+ <td>Stop the build process if <code>ss.exe</code> exits with a return code <q>100</q>.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
@@ -700,55 +671,52 @@ Task to perform ADD commands to Microsoft Visual SourceSafe.
<pre>
<vssadd localpath="D:\build\build.00012.zip"
- comment="Added by automatic build"/>
-</pre>
+ comment="Added by automatic build"/></pre>
-<p>Add the file named build.00012.zip into the project current working
-directory (see vsscp).</p>
-<hr>
+<p>Add the file named <samp>build.00012.zip</samp> into the project current working directory
+(see <code>vsscp</code>).</p>
+
+<hr/>
<!-- VSSCP -->
<h2 id="vsscp">VssCp</h2>
<h3>Description</h3>
<p>Task to perform CP (Change Project) commands to Microsoft Visual SourceSafe.</p>
-<p>This task is typically used before a VssAdd in order to set the target project</p>
+<p>This task is typically used before a <code>VssAdd</code> in order to set the target project</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
- <td>vsspath</td>
- <td>SourceSafe path which specifies the project you wish to
- make the current project.</td>
- <td>Yes</td>
+ <td>vsspath</td>
+ <td>SourceSafe path which specifies the project you wish to make the current project.</td>
+ <td>Yes</td>
</tr>
<tr>
- <td>login</td>
- <td>username[,password] - The username and password needed to get access
- to VSS. Note that you may need to specify both (if you have a password) -
- Ant/VSS will hang if you leave the password out and VSS does not accept
- login without a password.</td>
- <td>No</td>
+ <td>login</td>
+ <td><q>username[,password]</q>—The username and password needed to get access to VSS. Note
+ that you may need to specify both (if you have a password)—Ant/VSS will hang if you
+ leave the password out and VSS does not accept login without a password.</td>
+ <td>No</td>
</tr>
<tr>
- <td>ssdir</td>
- <td>directory where <code>ss.exe</code> resides. By default the
- task expects it to be in the PATH.</td>
- <td>No</td>
+ <td>ssdir</td>
+ <td>directory where <code>ss.exe</code> resides.</td>
+ <td>No; by default expected to be in <code>PATH</code></td>
</tr>
<tr>
- <td>serverPath</td>
- <td>directory where <code>srcsafe.ini</code> resides.</td>
- <td>No</td>
+ <td>serverPath</td>
+ <td>directory where <samp>srcsafe.ini</samp> resides.</td>
+ <td>No</td>
</tr>
<tr>
<td>failonerror</td>
- <td>Stop the buildprocess if ss.exe exits with a returncode of 100. Defaults to true</td>
- <td>No</td>
+ <td>Stop the build process if <code>ss.exe</code> exits with a return code <q>100</q>.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
</table>
@@ -756,17 +724,18 @@ directory (see vsscp).</p>
<pre><vsscp vsspath="$/Projects/ant"/></pre>
-<p>Sets the current VSS project to <i>$/Projects/ant</i>.</p>
-<hr>
+<p>Sets the current VSS project to <samp>$/Projects/ant</samp>.</p>
+
+<hr/>
<!-- VSSCREATE -->
<h2 id="vsscreate">VssCreate</h2>
<h3>Description</h3>
- Task to perform CREATE commands to Microsoft Visual Source Safe.
- <p>Creates a new project in VSS.</p>
+<p>Task to perform CREATE commands to Microsoft Visual Source Safe.</p>
+<p>Creates a new project in VSS.</p>
<h3>Parameters</h3>
-<table>
+<table class="attr">
<tr>
<th>Attribute</th>
<th>Values</th>
@@ -774,7 +743,7 @@ directory (see vsscp).</p>
</tr>
<tr>
<td>login</td>
- <td>username,password</td>
+ <td><q>username,password</q></td>
<td>No</td>
</tr>
<tr>
@@ -784,27 +753,28 @@ directory (see vsscp).</p>
</tr>
<tr>
<td>ssdir</td>
- <td>directory where <code>ss.exe</code> resides. By default the task expects it to be in the PATH.</td>
- <td>No</td>
+ <td>directory where <code>ss.exe</code> resides.</td>
+ <td>No; by default expected to be in <code>PATH</code></td>
</tr>
<tr>
<td>quiet</td>
- <td>suppress output (off by default)</td>
- <td>No</td>
- </tr>
+ <td>suppress output</td>
+ <td>No; defaults to <q>off</q></td>
+ </tr>
<tr>
<td>failOnError</td>
- <td>fail if there is an error creating the project (true by default)</td>
- <td>No</td>
+ <td>fail if there is an error creating the project.</td>
+ <td>No; defaults to <q>true</q></td>
</tr>
<tr>
<td>autoresponse</td>
- <td>What to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this.</td>
+ <td>What to respond with (sets the <code>-I</code> option). By default, <code>-I-</code> is
+ used; values of <q>Y</q> or <q>N</q> will be appended to this.</td>
<td>No</td>
</tr>
<tr>
<td>comment</td>
- <td>The comment to use for this label. Empty or '-' for no comment.</td>
+ <td>The comment to use for this label. Empty or <q>-</q> for no comment.</td>
<td>No</td>
</tr>
</table>
@@ -812,7 +782,7 @@ directory (see vsscp).</p>
<pre><vsscreate vsspath="$/existingProject/newProject"/></pre>
-<p>Creates the VSS-Project <i>$/existingProject/newProject</i>.</p>
+<p>Creates the VSS Project <samp>$/existingProject/newProject</samp>.</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/ant/blob/66b52f99/manual/Tasks/waitfor.html
----------------------------------------------------------------------
diff --git a/manual/Tasks/waitfor.html b/manual/Tasks/waitfor.html
index 890ede6..f0ba880 100644
--- a/manual/Tasks/waitfor.html
+++ b/manual/Tasks/waitfor.html
@@ -26,106 +26,95 @@
<h2>Waitfor</h2>
<h3>Description</h3>
-<p>Blocks execution until a set of specified conditions become true. This is intended
- to be used with the <a href="parallel.html">parallel</a> task to
- synchronize a set of processes.</p>
-<p>The conditions to wait for are defined in <a href="waitfor.html#nested">nested elements</a>,
-if multiple conditions are specified, then the task will wait until all conditions are true..</p>
-<p></p>
-<p>If both maxwait and maxwaitunit are not specified, the maxwait is 3 minutes (180000 milliseconds).</p>
-<p>If the <code>timeoutproperty</code> attribute has been set, a
-property of that name will be created if the condition didn't come
-true within the specified time.</p>
+<p>Blocks execution until a set of specified conditions become true. This is intended to be used
+with the <a href="parallel.html">parallel</a> task to synchronize a set of processes.</p>
+<p>The conditions to wait for are defined in <a href="waitfor.html#nested">nested elements</a>, if
+multiple conditions are specified, then the task will wait until all conditions are true.</p>
+<p>If both <var>maxwait</var> and <var>maxwaitunit</var> are not specified,
+default <var>maxwait</var> is 3 minutes (180000 milliseconds).</p>
+<p>If the <var>timeoutproperty</var> attribute has been set, a property of that name will be created
+if the condition didn't come true within the specified time.</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">maxwait</td>
- <td valign="top">The maximum amount of time to wait for all the required conditions
- to become true before failing the task. Defaults to 180000 maxwaitunits.</td>
- <td valign="top" align="center">No</td>
+ <td>maxwait</td>
+ <td>The maximum amount of time to wait for all the required conditions to become true before
+ failing the task.</td>
+ <td>No; defaults to 180000 <var>maxwaitunit</var>s</td>
</tr>
<tr>
- <td valign="top">maxwaitunit</td>
- <td valign="top">The unit of time that must be used to interpret the value of the
- maxwait attribute. Defaults to millisecond.
- Valid Values are
- <ul>
- <li>millisecond</li>
- <li>second</li>
- <li>minute</li>
- <li>hour</li>
- <li>day</li>
- <li>week</li>
- </ul>
- </td>
- <td valign="top" align="center">No</td>
+ <td>maxwaitunit</td>
+ <td>The unit of time that must be used to interpret the value of the <var>maxwait</var>
+ attribute. 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></li>
+ <li><q>week</q></li>
+ </ul>
+ </td>
+ <td>No; defaults to <q>millisecond</q></td>
</tr>
<tr>
- <td valign="top">checkevery</td>
- <td valign="top">The amount of time to wait between each test of the conditions.
- Defaults to 500 checkeveryunits.</td>
- <td valign="top" align="center">No</td>
+ <td>checkevery</td>
+ <td>The amount of time to wait between each test of the conditions.</td>
+ <td>No; defaults to 500 <var>checkeveryunit</var>s</td>
</tr>
<tr>
- <td valign="top">checkeveryunit</td>
- <td valign="top">The unit of time that must be used to interpret the value of the
- checkevery attribute. Defaults to millisecond.
- Valid Values are
- <ul>
- <li>millisecond</li>
- <li>second</li>
- <li>minute</li>
- <li>hour</li>
- <li>day</li>
- <li>week</li>
- </ul>
+ <td>checkeveryunit</td>
+ <td>The unit of time that must be used to interpret the value of the <var>checkevery</var>
+ attribute. 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></li>
+ <li><q>week</q></li>
+ </ul>
</td>
- <td valign="top" align="center">No</td>
+ <td>No; defaults to <q>millisecond</q></td>
</tr>
<tr>
- <td valign="top">timeoutproperty</td>
- <td valign="top">the name of the property to set if maxwait has
- been exceeded.</td>
- <td valign="top" align="center">No</td>
+ <td>timeoutproperty</td>
+ <td>the name of the property to set if <var>maxwait</var> has been exceeded.</td>
+ <td>No</td>
</tr>
</table>
<h3 id="nested">Nested Elements</h3>
-<p>The available conditions that satisfy the
-<code><waitfor></code> task are the same as those for the
-<a href="condition.html"><code><condition></code></a> task. See
-<a href="conditions.html">here</a> for the full list.</p>
+<p>The available conditions that satisfy the <code><waitfor></code> task are the same as those
+for the <a href="condition.html"><code><condition></code></a>
+task. See <a href="conditions.html">here</a> for the full list.</p>
<h3>Examples</h3>
<pre>
<waitfor maxwait="30" maxwaitunit="second">
- <available file="errors.log"/>
-</waitfor>
-</pre>
-<p>waits up to 30 seconds for a file called errors.log to appear.</p>
+ <available file="errors.log"/>
+</waitfor></pre>
+<p>waits up to 30 seconds for a file called <samp>errors.log</samp> to appear.</p>
<pre>
<waitfor maxwait="3" maxwaitunit="minute" checkevery="500">
- <http url="http://localhost/myapp/index.html"/>
-</waitfor>
-</pre>
-<p>waits up to 3 minutes (and checks every 500 milliseconds) for a web server on localhost
- to serve up the specified URL.</p>
+ <http url="http://localhost/myapp/index.html"/>
+</waitfor></pre>
+<p>waits up to 3 minutes (and checks every 500 milliseconds) for a web server
+on <samp>localhost</samp> to serve up the specified URL.</p>
<pre>
<waitfor maxwait="10" maxwaitunit="second">
- <and>
- <socket server="dbserver" port="1521"/>
- <http url="http://webserver/mypage.html"/>
- </and>
-</waitfor>
-</pre>
-<p>waits up to 10 seconds for a server on the dbserver machine to begin listening
- on port 1521 and for the http://webserver/mypage.html web page
- to become available.</p>
+ <and>
+ <socket server="dbserver" port="1521"/>
+ <http url="http://webserver/mypage.html"/>
+ </and>
+</waitfor></pre>
+<p>waits up to 10 seconds for a server on the <samp>dbserver</samp> machine to begin listening on
+port 1521 and for the <samp>http://webserver/mypage.html</samp> web page to become available.</p>
</body>
</html>