Repository: ant-ivy
Updated Branches:
refs/heads/master 614bf1ad5 -> b693aa0a2 (forced update)
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b693aa0a/asciidoc/use/resolve.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/resolve.adoc b/asciidoc/use/resolve.adoc
index 371d2c4..fcc7bd9 100644
--- a/asciidoc/use/resolve.adoc
+++ b/asciidoc/use/resolve.adoc
@@ -17,21 +17,21 @@
under the License.
////
-The resolve task actually resolve dependencies described in an link:../ivyfile.html[ivy file], and put the resolved dependencies in the ivy cache.
-If configure has not been called before resolve is called, a default
configuration will be used (equivalent to call configure with no attributes).
+The resolve task actually resolve dependencies described in an
link:../ivyfile.html[Ivy file], and put the resolved dependencies in the Ivy
cache.
+If configure has not been called before resolve is called, a default
configuration will be used (equivalent to calling configure without attributes).
-After the call to this task, four properties are set in ant:
+After the call to this task, four properties are set in Ant:
-* `ivy.organisation`: set to the organisation name found in the ivyfile which was used for resolve
-* `ivy.module`: set to the module name found in the ivyfile which was used for
resolve
-* `ivy.revision`: set to the revision name found in the ivyfile which was used
for resolve, or a generated revision name if no revision was specified in the
file
+* `ivy.organisation`: set to the organisation name found in the Ivy file which
was used for resolve
+* `ivy.module`: set to the module name found in the Ivy file which was used
for resolve
+* `ivy.revision`: set to the revision name found in the Ivy file which was
used for resolve, or a generated revision name if no revision was specified in
the file
* `ivy.resolved.configurations`: set to the comma separated list of
configurations resolved
*Since 1.2:*
An additional property is set to `true` if the resolved dependencies are
changes since the last resolve, and to `false` otherwise: `ivy.deps.changed`.
*Since 2.0:*
-The property `ivy.deps.changed` will not be set (and not be computed) if you
set the parameter `checkIfChanged` to `false`. (by default it is `true` to keep
backward compatibility). This allow to optimize your build when you have
multi-module build with multiple configurations.
+The property `ivy.deps.changed` will not be set (and not be computed) if you
set the parameter `checkIfChanged` to `false`. (By default, it is `true` to
keep backward compatibility). This allows to optimize your build when you have
multi-module build with multiple configurations.
*Since 2.0:*
In addition, if the `resolveId` attribute has been set, the following
properties are set as well:
@@ -45,15 +45,15 @@ In addition, if the `resolveId` attribute has been set, the
following properties
*Since 2.4*
If current module extends other modules:
-* `ivy.parents.count`: number of parents module
-* `ivy.parent[__index__].organisation`: set to the organisation name found in
the parent ivyfile which was used for resolve
-* `ivy.parent[__index__].module`: set to the module name found in the parent
ivyfile which was used for resolve
-* `ivy.parent[__index__].revision`: set to the revision name found in the
parent ivyfile which was used for resolve
-* `ivy.parent[__index__].branch`: set to the branch name found in the parent
ivyfile which was used for resolve
+* `ivy.parents.count`: number of parent modules
+* `ivy.parent[__index__].organisation`: set to the organisation name found in
the parent Ivy file which was used for resolve
+* `ivy.parent[__index__].module`: set to the module name found in the parent
Ivy file which was used for resolve
+* `ivy.parent[__index__].revision`: set to the revision name found in the
parent Ivy file which was used for resolve
+* `ivy.parent[__index__].branch`: set to the branch name found in the parent
Ivy file which was used for resolve
Where __index__ represent the index of extends module.
-When ivy has finished the resolve task, it outputs a summary of what has been resolved. This summary looks like this:
+When Ivy has finished the resolve task, it outputs a summary of what has been
resolved. This summary looks like this:
[source]
----
@@ -72,7 +72,7 @@ This table gives some statistics about the dependency
resolution. Each line corr
* `modules`
** `number`: the total number of dependency modules resolved in this
configuration, including transitive ones
** `search`: the number of dependency modules that required a repository
access. The repository access is needed if the module is not yet in cache, or
if a latest version is required, or in some other cases (depending on
`checkModified`, for instance)
-** `dwnlded`: the number of dependency ivy files downloaded from the
repository. This number can be less than the total number of modules even with
a clean cache, if no ivy file is provided for some dependencies.
+** `dwnlded`: the number of dependency Ivy files downloaded from the
repository. This number can be less than the total number of modules even with
a clean cache, if no Ivy file is provided for some dependencies.
** `evicted`: the number of dependency module evicted by conflict managers.
* `artifacts`
** `number`: the total number of artifacts resolved in the given
configuration.
@@ -80,9 +80,9 @@ This table gives some statistics about the dependency
resolution. Each line corr
== Inline mode
-*__since 1.4__* 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.
+*__since 1.4__* The inline mode allows 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.
-*Remark:* 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`!
+*Remark:* 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`!
== Resolve mode
@@ -97,32 +97,32 @@ Two modes are available:
During resolve, Ivy creates a file in the link:../settings/caches.html[resolution cache]. The creation of this file is not aimed to support concurrency, meaning that you can't have two concurrent resolve of the same module, in the same resolution cache, with the same `resolveId`.
-__Note for developers__: after the call to this task, a reference to the module descriptor resolved is put in the ant project under the id `ivy.resolved.descriptor`.
+__Note for developers__: after the call to this task, a reference to the
module descriptor resolved is put in the Ant project under the id
`ivy.resolved.descriptor`.
== Attributes
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|file|path to the ivy file to use for resolution|No. Defaults to
`${ivy.dep.file}` or nothing in inline mode
+|file|path to the Ivy file to use for resolution|No. Defaults to
`${ivy.dep.file}` or nothing in inline mode
|conf|a comma separated list of the configurations to resolve, or `$$*$$`.
*__Since 2.0__*, you can also use `$$*(private)$$`, `$$*(public)$$`. Note
that when `inline` is `true`, the configuration `$$*$$` is equivalent as
`$$*(public)$$`.|No. Defaults to `${ivy.configurations}`
|refresh|`true` to force Ivy to resolve dynamic revision in this resolve
process, `false` to use cached resolved revision *__since 2.0__*|No. defaults
to `false`
|resolveMode|the resolve mode to use for this dependency resolution process
*__since 2.0__*|No. defaults to using the resolve mode set in the
link:../settings.html[settings]
-|inline|`true` to use inline mode, false to resolve an ivy file *__since
1.4__*|No. defaults to `false`
-|keep|`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
post-resolve tasks (like `retrieve` and `cachepath`) won't be able to reuse the
results of this resolve!|No. defaults to `false` for an inline resolve and to
`true` in any other case
+|inline|`true` to use inline mode, false to resolve an Ivy file *__since
1.4__*|No. defaults to `false`
+|keep|`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
post-resolve tasks (like `retrieve` and `cachepath`) won't be able to reuse the
results of this resolve!|No. defaults to `false` for an inline resolve and to
`true` in any other case
|organisation|the organisation of the module to resolve in inline mode
*__since 1.4__*|Yes in inline mode, no otherwise.
|module|the name of the module to resolve in inline mode *__since 1.4__*|Yes
in inline mode, no otherwise.
|revision|the revision constraint to apply to the module to resolve in inline
mode *__since 1.4__*|No. Defaults to `latest.integration` in inline mode,
nothing in standard mode.
-|branch|the name of the branch to resolve in inline mode *__(since
2.1.0)__*|Defaults to no branch in inline mode, nothing in standard mode.
+|branch|the name of the branch to resolve in inline mode *__(since
2.1)__*|Defaults to no branch in inline mode, nothing in standard mode.
|changing|indicates that the module may change when resolving in inline mode.
See link:../concept.html#change[cache and change management] for details.
Ignored when resolving in standard mode. *__(since 1.4)__*|No. Defaults to
`false`.
|type|comma separated list of accepted artifact types (*__since 1.2__*)|No.
defaults to `${ivy.resolve.default.type.filter}`
-|haltonfailure|`true` to halt the build on ivy failure, false to continue|No.
Defaults to `true`
+|haltonfailure|`true` to halt the build on Ivy failure, false to continue|No.
Defaults to `true`
|failureproperty|the name of the property to set if the resolve failed
*__since 1.4__*|No. No property is set by default.
|transitive|`true` to resolve dependencies transitively, `false` otherwise
*__since 1.4__*|No. Defaults to `true`
|showprogress|`true` to show dots while downloading, `false` otherwise|No.
Defaults to `true`
-|validate|`true` to force ivy files validation against ivy.xsd, `false` to
force no validation|No. Defaults to default ivy value (as configured in
configuration file)
-|settingsRef|A reference to the ivy settings that must be used by this task
*__(since 2.0)__*|No, defaults to `ivy.instance`.
+|validate|`true` to force Ivy files validation against ivy.xsd, `false` to
force no validation|No. Defaults to default Ivy value (as configured in
settings)
+|settingsRef|A reference to Ivy settings that must be used by this task
*__(since 2.0)__*|No, defaults to `ivy.instance`.
|resolveId|An id which can be used later to refer to the results of this
resolve *__(since 2.0)__*|No, defaults to `[org]-[module]`.
|log|the log setting to use during the resolve process. *__(since 2.0)__*
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b693aa0a/asciidoc/use/resources.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/resources.adoc b/asciidoc/use/resources.adoc
index a2181e9..73d94ed 100644
--- a/asciidoc/use/resources.adoc
+++ b/asciidoc/use/resources.adoc
@@ -20,7 +20,7 @@
*__(since 2.3) (Ant 1.7 required)__*
`ivy:resources` is an Ant
link:http://ant.apache.org/manual/Types/resources.html#collection[resource
collection], which files are based on an Ivy resolve, and then can be used with
any task which is working with resources like `copy` or `import`.
-This datatype share the same attributes, child elements and behaviour of a link:../use/postresolvetask.html[post resolve task]. It is not expected to be used as an Ant task though, only as a resource collection.
+This datatype shares the same attributes, child elements and behaviour of a
link:../use/postresolvetask.html[post resolve task]. It is not expected to be
used as an Ant task though, only as a resource collection.
== Examples
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b693aa0a/asciidoc/use/retrieve.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/retrieve.adoc b/asciidoc/use/retrieve.adoc
index 6b1bde2..5b4df5d 100644
--- a/asciidoc/use/retrieve.adoc
+++ b/asciidoc/use/retrieve.adoc
@@ -36,11 +36,11 @@ For instance, for the pattern
`lib/[conf]/[artifact].[ext]`, the root will be `l
|=======
|Attribute|Description|Required
|pattern|the pattern to use to copy the dependencies|No. Defaults to
`${ivy.retrieve.pattern}`
-|ivypattern|the pattern to use to copy the ivy files of dependencies *__since
1.3__*|No. Dependencies ivy files are not retrieved by default.
+|ivypattern|the pattern to use to copy the Ivy files of dependencies *__since
1.3__*|No. Dependency Ivy files are not retrieved by default.
|conf|a comma separated list of the configurations to retrieve|No. Defaults
to the configurations resolved by the last resolve call, or `$$*$$` if no
resolve was explicitly called
|sync|`true` to synchronize the destination, false to just make a copy
*__since 1.4__*|No. Defaults to `false`
|type|comma separated list of accepted artifact types *__since 1.4__*|No. All
artifact types are accepted by default.
-|overwriteMode|option to configure when the destination file should be
overwritten if it exist *__(since 2.2.0)__*.
+|overwriteMode|option to configure when the destination file should be
overwritten if it exists *__(since 2.2)__*.
Possible values are: +
* `newer`: overwrite the destination file if a more recent one is available
(based on timestamp) +
@@ -54,8 +54,8 @@ Possible values are: +
filesystem supports symbolic links, creation of such symbolic links may
or may not work. +
If this option is set to `true` and symbolic link creation fails, then
the retrieve task will attempt to do a regular copy of the artifact which
failed symlink creation.
*__(since 2.0)__*|No. Defaults to `false`
-|symlinkmass| *__Deprecated since 2.5__* This option is no longer supported or
relevant starting 2.5 version of Ivy|No. Defaults to `false`
-|settingsRef|A reference to the ivy settings that must be used by this task
*__(since 2.0)__*|No, defaults ot `ivy.instance`.
+|symlinkmass| *__Deprecated since 2.5__* This option is no longer supported or
relevant.|No. Defaults to `false`
+|settingsRef|A reference to Ivy settings that must be used by this task
*__(since 2.0)__*|No, defaults ot `ivy.instance`.
|log|the log setting to use during the resolve and retrieve process.
*__(since 2.0)__*
Available options are the same as for link:../use/resolve.html[resolve] when used to trigger resolve automatically (see link:../use/postresolvetask.html[postresolvetask]), or the following for the retrieve process only: +
@@ -83,7 +83,7 @@ Retrieves dependencies using default parameters. This usually
retrieves all the
----
Retrieves all dependencies of the last resolve call to a lib directory, dependencies being separated in directories named by configuration, each conf directory containing corresponding artifacts without the revision.
-For instance, if the ivy file declares two configurations default and test,
the resulting lib dir could look like this:
+For instance, if the Ivy file declares two configurations default and test,
the resulting lib dir could look like this:
[source]
----
@@ -106,7 +106,7 @@ Note that if a dependency is required in the two
configurations, it will be copi
Same as before, but with synchronisation enabled.
-For instance, if the ivy file declares two configurations default and test, the resulting lib dir could look like this:
+For instance, if the Ivy file declares two configurations default and test,
the resulting lib dir could look like this:
[source]
----
@@ -138,9 +138,7 @@ With no synchronisation, commons-logging would not have
been removed by the call
<ivy:retrieve pattern="${lib.dir}/[type]/[artifact]-[revision].[ext]"
conf="runtime"/>
----
-Retrieves only the dependencies of the `runtime`.
-
-configuration in directories named by artifact type. The resulting lib dir
could look like this:
+Retrieves only the dependencies of the `runtime`. Dependencies separated in
directories named by artifact type. The resulting lib dir could look like this:
[source]
----
@@ -196,7 +194,7 @@ lib
<ivy:retrieve organisation="foo" module="bar" inline="true"
pattern="${my.install.dir}/[artifact].[ext]"/>
----
-Resolves and retrieve the latest version of the module bar and its dependencies in the directory pointed by `${my.install.dir}`.
+Resolves and retrieves the latest version of the module bar and its
dependencies in the directory pointed by `${my.install.dir}`.
'''
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b693aa0a/asciidoc/use/settings.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/settings.adoc b/asciidoc/use/settings.adoc
index 319abe1..96b4581 100644
--- a/asciidoc/use/settings.adoc
+++ b/asciidoc/use/settings.adoc
@@ -19,7 +19,7 @@
*__(since 2.0)__*
-The settings declaration is used to configure Ivy with an xml settings file. The difference with the link:../use/configure.html[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.
+The settings declaration is used to configure Ivy with a settings XML file.
The difference with the link:../use/configure.html[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 link:../settings.html[Settings Files] for details about the settings file itself.
@@ -42,10 +42,10 @@ my.variable.yourid=your.value
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|id|The settings id usable in the `settingsRef` attributes of the ivy task
that needs a setting.|No, defaults to `ivy.instance`
+|id|The settings id usable in the `settingsRef` attributes of the Ivy task
that needs a setting.|No, defaults to `ivy.instance`
|file|path to the settings file to use
-.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 link:../tutorial/defaultconf.html[default settings file]
-|url|url of the settings file to use
+.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 link:../tutorial/defaultconf.html[default settings file]
+|url|URL of the settings file to use
|host|HTTP authentication host
.4+.^|No, unless authentication is required
|realm|HTTP authentication realm
@@ -55,13 +55,13 @@ my.variable.yourid=your.value
== HTTP Authentication
-__Note__: HTTP Authentication can be used only if link:https://hc.apache.org/httpcomponents-client-ga/index.html[HttpComponents HttpClient library] (minimum of 4.5.3 version) and its linke:https://hc.apache.org/httpcomponents-client-4.5.x/dependency-management.html[dependencies] are in your classpath.
+__Note__: HTTP authentication can be used only if
link:https://hc.apache.org/httpcomponents-client-ga/index.html[HttpComponents
HttpClient library] (minimum of 4.5.3 version) and its
link:https://hc.apache.org/httpcomponents-client-4.5.x/dependency-management.html[dependencies]
are in your classpath.
-If any of the url you use in Ivy (especially in dependency resolvers) need HTTP authentication, then you have to provide the `host`, `realm`, `username` and `passwd` attributes of the configure task. These settings will then be used in any further call to ivy tasks.
+If any of the URLs you use in Ivy (especially in dependency resolvers) needs
HTTP authentication, then you have to provide the `host`, `realm`, `username`
and `passwd` attributes of the configure task. These settings will then be used
in any further call to Ivy tasks.
== Multiple classloader
-A special attention should be applied when you have a multi-project build with `subant` call, using ivy task loaded by a `typedef`. Indeed in this situation, it is possible to pass settings reference to a subbuild. When you do that, you should take of the classloader. The ivy task of your `subant` should not be defined in a different classloader than the parent one. This can be achieved by using the `loader` parameter of the antlib declaration, or avoid to reload the ivy antlib in the subbuild (place the `taskdef` in a target only executed when the antlib is not yet loaded).
+A special attention should be applied when you have a multi-project build with
`subant` call, using Ivy task loaded by a `typedef`. Indeed in this situation,
it is possible to pass settings reference to a subbuild. When you do that, you
should take care of the classloader. The Ivy task of your `subant` should not
be defined in a different classloader than the parent one. This can be
achieved by using the `loader` parameter of the antlib declaration, or avoid to
reload the Ivy antlib in the subbuild (place the `taskdef` in a target only
executed when the antlib is not yet loaded).
== Examples
@@ -83,7 +83,7 @@ This simplest setting is implicit.
<ivy:settings file="mysettings.xml"/>
----
-=== Configure with an url
+=== Configure with an URL
[source,xml]
----
@@ -102,7 +102,7 @@ This simplest setting is implicit.
=== Configure 2 different settings
-You can use multiple ivy settings during a build. Then every ivy task should specify the settings it uses using the `settingsRef` attribute.
+You can use multiple Ivy settings during a build. Then every Ivy task should
specify the settings it uses using the `settingsRef` attribute.
[source,xml]
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b693aa0a/asciidoc/use/var.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/var.adoc b/asciidoc/use/var.adoc
index 7fc4e96..79e6c25 100644
--- a/asciidoc/use/var.adoc
+++ b/asciidoc/use/var.adoc
@@ -17,11 +17,11 @@
under the License.
////
-Sets a variable (by name and value), or set of variables (from file or url) in Ivy.
+Sets a variable (by name and value), or set of variables (from file or URL) in
Ivy.
Variables are case sensitive.
-Contrary to ant properties, ivy variables are mutable. But a problem with this is that you do not control when
+Contrary to Ant properties, Ivy variables are mutable. But a problem with this
is that you do not control when
variables are substituted, and usually it is done as soon as possible. So
changing the value of a variable will
have no effect if it has already been substituted. Consequently, *using this
task is NOT recommended*.
@@ -34,9 +34,9 @@ See link:../reference.html[reference] page for details about Ivy variables.
|Attribute|Description|Required
|name|the name of the variable to set|No
|value|the value of the variable to set|Yes when using the name attribute
-|file|the filename of the property file to load as ivy variables
+|file|the filename of the property file to load as Ivy variables
.2+.^|One of these, when *not* using the name attribute
-|url|the url from which to read ivy variables
+|url|the URL from which to read Ivy variables
|prefix|Prefix to apply to variables. A dot (`.`) is appended to the prefix
if not specified.|No
-|settingsRef|A reference to the ivy settings that must be used by this task
*__(since 2.0)__*|No, defaults to `ivy.instance`.
+|settingsRef|A reference to Ivy settings that must be used by this task
*__(since 2.0)__*|No, defaults to `ivy.instance`.
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b693aa0a/asciidoc/yed.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/yed.adoc b/asciidoc/yed.adoc
index 8c7c4e1..1e9bd74 100644
--- a/asciidoc/yed.adoc
+++ b/asciidoc/yed.adoc
@@ -24,11 +24,11 @@ The graphs generated by Ivy are not laid out (in fact it's
why we use yEd), so y
== Preparation
-First you have to generate a graphml file. Simply call the report task (see ivy use documentation) for that.
+First you have to generate a GraphML file. Simply call the report task (see
ivy use documentation) for that.
-== Step 1: open the graphml file
+== Step 1: open the GraphML file
-Launch yEd editor, and open the graphml file generated by the report task. You should obtain something like this:
+Launch yEd editor, and open the GraphML file generated by the report task. You
should obtain something like this:
image::images/yed-step1.jpg[]
@@ -53,4 +53,4 @@ That's all, you should have obtained something like this:
image::images/yed-step7.jpg[]
Note that this is only one possibility, test the available layouts yourself, you could find one better in your case.
-Once you have laid out the graph, you can either save it with in the same file
(but be warned that it will be overwritten at next ivy report call), or another
file, export it to jpg, gif, svg, etc. (see
link:http://www.yworks.com/en/products_yed_about.htm[yEd] site for details).
+Once you have laid out the graph, you can either save it with in the same file
(but be warned that it will be overwritten at next Ivy report call), or another
file, export it to JPEG, GIF, SVG, etc. (see
link:http://www.yworks.com/en/products_yed_about.htm[yEd] site for details).
