Browse Source

Document <antversion> task.

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@513733 13f79535-47bb-0310-9956-ffa450edef68
master
Jan Materne 18 years ago
parent
commit
44838dc238
3 changed files with 99 additions and 29 deletions
  1. +95
    -0
      docs/manual/CoreTasks/antversion.html
  2. +3
    -29
      docs/manual/CoreTasks/conditions.html
  3. +1
    -0
      docs/manual/coretasklist.html

+ 95
- 0
docs/manual/CoreTasks/antversion.html View File

@@ -0,0 +1,95 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Antversion Task</title>
</head>
<body>
<h2><a name="antversion">Antversion</a></h2>
<h3>Description</h3>
<p>
Stores the Ant version (when used as task) or checks for a specific Ant version
(when used as condition).
<b>Since Ant 1.7.0</b>
</p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required (Task)</b></td>
<td align="center" valign="top"><b>Required (Condition)</b></td>
</tr>
<tr>
<td valign="top">atleast</td>
<td valign="top">The version that this at least.
The format is major.minor.point.</td>
<td valign="top" align="center">No</td>
<td valign="top" rowspan="2" align="center">One of these.</td>
</tr>
<tr>
<td valign="top">exactly</td>
<td valign="top">The version that this ant is exactly.
The format is <tt>major.minor.point</tt>.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">property</td>
<td valign="top">The name of the property to set.</td>
<td valign="top" align="center">Yes</td>
<td valign="top" align="center">No (ignored)</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote><pre>
&lt;antversion property=&quot;antversion&quot;/&gt;
</pre></blockquote>
<p>Stores the current Ant version in the property <i>antversion</i>.</p>
<blockquote><pre>
&lt;antversion property=&quot;antversion&quot; atleast=&quot;1.6&quot;/&gt;
</pre></blockquote>
<p>Stores the Ant version in the property <i>antversion</i> if the current Ant version is 1.6.0
or higher. Otherwise the property remains unset.</p>
<blockquote><pre>
&lt;antversion property=&quot;ant-is-exact-7&quot; exactly=&quot;1.7.0&quot;/&gt;
</pre></blockquote>
<p>Sets the property <i>ant-is-exact-7</i> if Ant 1.7.0 is running. Neither 1.6.5 nor 1.7.0
would match.</p>
<blockquote><pre>
&lt;condition property=&quot;Ant17isOnline&quot;&gt;
&lt;and&gt;
&lt;antversion exactly=&quot;1.7.0&quot;/&gt;
&lt;http url=&quot;http://ant.apache.org&quot;/&gt;
&lt;/and&gt;
&lt;/condition&gt;
</pre></blockquote>
<p>Sets <i>Ant17isOnline</i> if Ant 1.7.0 is running and can get a non-error-response from
the Ant homepage.</p>
</body>
</html>

+ 3
- 29
docs/manual/CoreTasks/conditions.html View File

@@ -920,37 +920,11 @@ must match. <b>Since Ant 1.7</b>
&lt;/au:assertFalse&gt;
</pre></blockquote>
<h4>antversion</h4>
<p>This condition is identical to the <a
href="antversion.html">Antversion</a> task, all attributes are supported, the property attribute
is redundant and will be ignored.</p>

<p>
Test the ant version.
<b>Since Ant 1.7.0</b></p>

<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">atleast</td>
<td valign="top">The version that this at least.
The format is major.minor.point.</td>
<td valign="top" rowspan="2" align="center">One of these.</td>
</tr>
<tr>
<td valign="top">exactly</td>
<td valign="top">The version that this ant is exactly.
The format is major.minor.point.</td>
</tr>
</table>
<p>
An example:
</p>
<blockquote><pre>
&lt;condition property="ant-is-exact-7"&gt;
&lt;antversion exactly="1.7.0"/&gt;
&lt;/condition&gt;
</pre></blockquote>
<h4>hasfreespace</h4>

<p>


+ 1
- 0
docs/manual/coretasklist.html View File

@@ -35,6 +35,7 @@
<a href="CoreTasks/ant.html">Ant</a><br/>
<a href="CoreTasks/antcall.html">AntCall</a><br/>
<a href="CoreTasks/antstructure.html">AntStructure</a><br/>
<a href="CoreTasks/antversion.html">AntVersion</a><br/>
<a href="CoreTasks/apply.html">Apply/<i>ExecOn</i></a><br/>
<a href="CoreTasks/apt.html">Apt</a><br/>
<a href="CoreTasks/available.html">Available</a><br/>


Loading…
Cancel
Save