Author: maartenc
Date: Mon Jul 21 14:22:12 2008
New Revision: 678574
URL: http://svn.apache.org/viewvc?rev=678574&view=rev
Log:
Updated ivy:configure and ivy:settings documentation for IVY-849
Modified:
ant/ivy/core/trunk/doc/use/configure.html
ant/ivy/core/trunk/doc/use/settings.html
Modified: ant/ivy/core/trunk/doc/use/configure.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/use/configure.html?rev=678574&r1=678573&r2=678574&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/use/configure.html (original)
+++ ant/ivy/core/trunk/doc/use/configure.html Mon Jul 21 14:22:12 2008
@@ -25,22 +25,23 @@
</head>
<body>
<textarea id="xooki-source">
-<span class="since">(since 2.0)</span> the configure task is deprecated. Use
the <a href="settings.html">setting</a> declaration<br/>
-
The configure task is used to configure ivy with an xml settings
file.<br/><br/>
See [[settings]] for details about the settings file itself.<br/><br/>
-<i>Note for developers:<br/>
-After the call to this task, a reference to the configured ivy instance used
by all subsequent ant tasks is put in the ant project, under the id
"ivy.instance".</i>
<span class="since">since 2.0</span> The file loaded used to be called
configuration file in versions prior to 2.0. The name 'settings' and the use of
the ivy.settings.file is new to 2.0.
+
+<span class="since">since 2.0</span> It is also possible to configure Ivy with
the [[ant:settings]] declaration. The difference with this task is that when
using the settings declaration, the configuration of Ivy will be done when the
settings are first needed (for instance when you do a resolve), while the
configure task will perform a configuration of Ivy instantly, which makes it
easier to see the problem if something goes wrong.
+
<table class="ant">
<thead>
<tr><th class="ant-att">Attribute</th><th
class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
</thead>
<tbody>
+ <tr><td>settingsId</td><td>The settings id useable in the settingsRef
attributes of the ivy task that needs a setting. Note that the ivy tasks will
search by default for the settings with the id "ivy.instance", which is the
default value.</td><td>No, defaults to "ivy.instance"</td></tr>
<tr><td>file</td><td>path to the settings file to use</td>
<td rowspan="2">No. If a file is provided, url is ignored. If none are
provided, then it attempts to find a file at ${ivy.settings.file}, and if this
file does not exist, it uses a <a
href="../samples/ivysettings-default.xml">default settings file</a></td></tr>
<tr><td>url</td><td>url of the settings file to use</td></tr>
+ <tr><td>override</td><td>Specify what to do when another settings with the
same id has already been loaded.<ul><li>true</li> the current settings will
take precedence over any previously defined setting with this id<li>false</li>
the current settings will not override a previously defined setting with this
id<li>notallowed</li>an error is raised if a settings has already been defined
with this id</ul></td><td>No, defaults to "notallowed"</td></tr>
<tr><td>host</td><td>http authentication host</td><td rowspan="4">No,
unless authentication is required</td></tr>
<tr><td>realm</td><td>http authentication realm</td></tr>
<tr><td>username</td><td>http authentication user name</td></tr>
Modified: ant/ivy/core/trunk/doc/use/settings.html
URL:
http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/use/settings.html?rev=678574&r1=678573&r2=678574&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/use/settings.html (original)
+++ ant/ivy/core/trunk/doc/use/settings.html Mon Jul 21 14:22:12 2008
@@ -26,11 +26,11 @@
<textarea id="xooki-source">
<span class="since">(since 2.0)</span>
-The settings declaration is used to configure ivy with an xml settings file.
+The settings declaration is used to configure ivy with an xml settings file.
The difference with the [[ant:configure]] task is that when using the settings
declaration, the configuration of Ivy will be done when the settings are first
needed (for instance when you do a resolve), while the configure task will
perform a configuration of Ivy instantly, which makes it easier to see the
problem if something goes wrong.
See [[settings]] for details about the settings file itself.<br/><br/>
-Multiple settings can be defined in a build script. Every task can reference
its own settings.
+Multiple settings can be defined in a build script. Every task can reference
its own settings.
All Ivy variables set during the settings are available in the Ant project as
long as they were not set in Ant before (Ant properties are immutable).
Moreover, the variables are exposed under two names: the variable name, and
the variable name suffixed by dot + the settings id.
@@ -51,7 +51,6 @@
<tr><td>file</td><td>path to the settings file to use</td>
<td rowspan="2">No. If a file is provided, url is ignored. If none are
provided, then it attempts to find a file at ${ivy.settings.file}, and if this
file does not exist, it uses a [[tutorial/defaultconf default settings
file]]</td></tr>
<tr><td>url</td><td>url of the settings file to use</td></tr>
- <tr><td>override</td><td>Specify what to do when another settings with the
same id has already been loaded.<ul><li>true</li> the current settings will
take precedence over any previously defined setting with this id<li>false</li>
the current settings will not override a previously defined setting with this
id<li>notallowed</li>an error is raised if a settings has already been defined
with this id</ul></td><td>No, defaults to "notallowed"</td></tr>
<tr><td>host</td><td>http authentication host</td><td rowspan="4">No,
unless authentication is required</td></tr>
<tr><td>realm</td><td>http authentication realm</td></tr>
<tr><td>username</td><td>http authentication user name</td></tr>
