Author: maartenc
Date: Wed Jul 1 23:08:13 2009
New Revision: 790416
URL: http://svn.apache.org/viewvc?rev=790416&view=rev
Log:
DOCUMENTATION: added missing documentation for the 'keep' attribute on the
(post)resolve Ant tasks (IVY-1091)
Modified:
ant/ivy/core/trunk/CHANGES.txt
ant/ivy/core/trunk/doc/use/postresolvetask.html
ant/ivy/core/trunk/doc/use/resolve.html
Modified: ant/ivy/core/trunk/CHANGES.txt
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/CHANGES.txt?rev=790416&r1=790415&r2=790416&view=diff
==============================================================================
--- ant/ivy/core/trunk/CHANGES.txt (original)
+++ ant/ivy/core/trunk/CHANGES.txt Wed Jul 1 23:08:13 2009
@@ -92,6 +92,7 @@
=====================================
- DOCUMENTATION: not all attributes of publish task are documented (IVY-963)
(thanks to Jon Schneider)
- DOCUMENTATION: missing documentation for the 'Version Pattern Matcher'
(IVY-871) (thanks to Jon Schneider)
+- DOCUMENTATION: added missing documentation for the 'keep' attribute on the
(post)resolve Ant tasks (IVY-1091)
- NEW: configuration intersections (IVY-1093)
- NEW: configuration groups (IVY-1097)
Modified: ant/ivy/core/trunk/doc/use/postresolvetask.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/use/postresolvetask.html?rev=790416&r1=790415&r2=790416&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/use/postresolvetask.html (original)
+++ ant/ivy/core/trunk/doc/use/postresolvetask.html Wed Jul 1 23:08:13 2009
@@ -66,6 +66,7 @@
<tr><td>branch</td><td>the name of the branch to resolve in inline mode
<span class="since">(since 2.1)</span></td><td>Defaults to no branch in inline
mode, nothing in standard mode.</td></tr>
<tr><td>transitive</td><td>true to resolve dependencies transitively,
false otherwise <span class="since">since 1.4</span></td><td>No. Defaults to
true</td></tr>
<tr><td>resolveMode</td><td>the [[ant:resolve resolve mode]] to use when
an automatic resolve is triggered <span class="since">(since
2.1)</span></td><td>No. defaults to using the resolve mode set in the
[[settings settings]]</td></tr>
+ <tr><td>keep</td><td>true to keep the results of the automatic resolve in
memory, false to discard them. When this is false, the standard ivy properties
won't be set and other postresolve-tasks (like retrieve and cachepath) won't be
able to resuse the results of this resolve!</td><td>No. defaults to false for
an inline resolve and to true in any other case</td></tr>
<tr><td>haltonfailure</td><td>true to halt the build on ivy failure, false
to continue</td><td>No. Defaults to true</td></tr>
<tr><td>validate</td><td>true to force ivy files validation against
ivy.xsd, false to force no validation</td><td>No. Defaults to default ivy value
(as configured in configuration file)</td></tr>
<tr><td>refresh</td><td>true to force Ivy to resolve dynamic revision in
this resolve process, false to use cached resolved revision <span
class="since">since 2.1</span></td><td>No. defaults to false</td></tr>
Modified: ant/ivy/core/trunk/doc/use/resolve.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/use/resolve.html?rev=790416&r1=790415&r2=790416&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/use/resolve.html (original)
+++ ant/ivy/core/trunk/doc/use/resolve.html Wed Jul 1 23:08:13 2009
@@ -86,7 +86,9 @@
</ul>
<h2>Inline mode</h2>
-<span class="since">since 1.4</span> The inline mode allow to call a resolve
without an ivy file, by setting directly the module which should be resolved
from the repository. It is particularly useful to install released software,
like an ant task for example. When inline is set to true, the organisation
module and revision attributes are used to specify which module should be
resolved from the repository.
+<span class="since">since 1.4</span> The inline mode allow to call a resolve
without an ivy file, by setting directly the module which should be resolved
from the repository. It is particularly useful to install released software,
like an ant task for example. When inline is set to true, the organisation
module and revision attributes are used to specify which module should be
resolved from the repository.
+
+<b>Remark:</b> if you want the standard ivy properties to be set or to reuse
the results of an inline resolve by other post-resolve tasks like retrieve,
cachepath, report, ..., you must set the keep attribute to true!
<h2>Resolve mode</h2>
<span class="since">since 2.0</span> The resolve mode allows to define how Ivy
should use dependency revision constraints when performing the resolution.
@@ -121,6 +123,8 @@
<tr><td>inline</td><td>true to use inline mode, false to resolve an ivy
file <span class="since">since 1.4</span></td><td>No. defaults to
false</td></tr>
+ <tr><td>keep</td><td>true to keep the results of the resolve in memory,
false to discard them. When this is false, the standard ivy properties won't be
set and other postresolve-tasks (like retrieve and cachepath) won't be able to
resuse the results of this resolve!</td><td>No. defaults to false for an inline
resolve and to true in any other case</td></tr>
+
<tr><td>organisation</td><td>the organisation of the module to resolve in
inline mode <span class="since">since 1.4</span></td><td>Yes in inline mode, no
otherwise.</td></tr>
<tr><td>module</td><td>the name of the module to resolve in inline mode
<span class="since">since 1.4</span></td><td>Yes in inline mode, no
otherwise.</td></tr>
