ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gin...@apache.org
Subject [1/3] ant-ivy git commit: Documentation review: uniform style of “since” (inline) and [block]; working links for derelict projects
Date Thu, 14 Sep 2017 21:04:06 GMT
Repository: ant-ivy
Updated Branches:
  refs/heads/master fc8ef4d22 -> 45046b5fd


http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/postresolvetask.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/postresolvetask.adoc b/asciidoc/use/postresolvetask.adoc
index 60e663a..1257ef3 100644
--- a/asciidoc/use/postresolvetask.adoc
+++ b/asciidoc/use/postresolvetask.adoc
@@ -24,15 +24,15 @@ These tasks are:
 * link:../use/retrieve.html[retrieve]
 * link:../use/cachefileset.html[cachefileset]
 * link:../use/cachepath.html[cachepath]
-* link:../use/artifactproperty.html[artifactproperty] *__(since 2.0)__*
-* link:../use/artifactreport.html[artifactreport] *__(since 2.0)__*
+* link:../use/artifactproperty.html[artifactproperty] (*__since 2.0__*)
+* link:../use/artifactreport.html[artifactreport] (*__since 2.0__*)
 
 All these tasks will trigger a resolve automatically if:
 
 * none has already been called in the current build with the attribute `keep` set to `true`
(see below)
 * organisation and module are not set
 
-*__Since Ivy 1.4__*, there are two ways to run a link:../use/resolve.html[resolve]: with
an Ivy file, or with the inline mode.
+(*__since 1.4__*) There are two ways to run a link:../use/resolve.html[resolve]: with an
Ivy file, or with the inline mode.
 When you call resolve with an Ivy file, the default for it is to keep the resolved data for
use by the subsequent post resolve tasks. When you run an inline resolve, the default is not
to keep the data. You can override this behaviour by setting the keep attribute as you like.
 
 If you want to to reuse the resolved data obtained through a call to resolve in another build
(i.e. not the current one), then you have to set the organisation and module attributes. This
work only if the cache was not cleaned since your last resolve call. This does not work with
inline calls, which must be performed in the same build.
@@ -45,23 +45,23 @@ The attributes listed are then mostly used only if a resolve is triggered
automa
 |=======
 |Attribute|Description|Required
 |conf|a comma separated list of the configurations to retrieve or `$$*$$`. +
-*__Since 2.0__* you can also use `$$*(public)$$` or `$$*(private)$$`.  Note that `$$*$$`
is interpreted as `$$*(public)$$` when `inline` is `true`.|No. Defaults to the configurations
resolved by the last resolve call, or `$$*$$` if no resolve was explicitly called
-|inline|`true` to use inline mode, `false` to resolve an Ivy file *__(since 1.4)__*|No. defaults
`false`
+(*__since 2.0__*) You can also use `$$*(public)$$` or `$$*(private)$$`. Note that `$$*$$`
is interpreted as `$$*(public)$$` when `inline` is `true`.|No. Defaults to the configurations
resolved by the last resolve call, or `$$*$$` if no resolve was explicitly called
+|inline|`true` to use inline mode, `false` to resolve an Ivy file (*__since 1.4__*)|No. defaults
`false`
 |organisation|the organisation of the module to retrieve. This usually doesn't need to be
set since it defaults to the last resolved one, except for inline mode where it is required.|Yes
in inline mode, otherwise no, it then defaults to last resolved module name
 |module|the name of the module to retrieve. This usually doesn't need to be set since it
defaults to the last resolved one, except for inline mode where it is required.|Yes in inline
mode, otherwise no, it then defaults to last resolved module name
-|revision|the revision constraint of the module to retrieve. Used only in inline mode. *__since
1.4__*|No. Defaults to latest.integration
-|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 2.2)__*|No.
Defaults to `false`.
-|transitive|`true` to resolve dependencies transitively, `false` otherwise *__since 1.4__*|No.
Defaults to `true`
-|resolveMode|the link:../use/resolve.html[resolve mode] to use when an automatic resolve
is triggered *__(since 2.1)__*|No. defaults to using the resolve mode set in the link:../settings.html[settings]
+|revision|the revision constraint of the module to retrieve. Used only in inline mode. (*__since
1.4__*)|No. Defaults to latest.integration
+|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 2.2__*).|No.
Defaults to `false`.
+|transitive|`true` to resolve dependencies transitively, `false` otherwise (*__since 1.4__*)|No.
Defaults to `true`
+|resolveMode|the link:../use/resolve.html[resolve mode] to use when an automatic resolve
is triggered (*__since 2.1__*)|No. defaults to using the resolve mode set in the link:../settings.html[settings]
 |keep|`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 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
 |haltonfailure|`true` to halt the build on Ivy failure, `false` to continue|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 settings)
-|refresh|`true` to force Ivy to resolve dynamic revision in this resolve process, `false`
to use cached resolved revision *__since 2.1__*|No. defaults to `false`
-|file|the file to resolve if a resolve is necessary *__since 2.0__*|No. Defaults to the previous
resolved Ivy file or to `${ivy.dep.file}`
-|settingsRef|A reference to Ivy settings that must be used by this task *__(since 2.0)__*|No,
defaults to `ivy.instance`
-|resolveId|The id which was used for a previous resolve, or the resolveId if a new resolve
is performed *__(since 2.0)__*|No, defaults to `[org]-[module]`.
-|log|the log setting to use during the resolve process. *__(since 2.0)__*
+|refresh|`true` to force Ivy to resolve dynamic revision in this resolve process, `false`
to use cached resolved revision (*__since 2.1__*)|No. defaults to `false`
+|file|the file to resolve if a resolve is necessary (*__since 2.0__*)|No. Defaults to the
previous resolved Ivy file or to `${ivy.dep.file}`
+|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No,
defaults to `ivy.instance`
+|resolveId|The id which was used for a previous resolve, or the resolveId if a new resolve
is performed (*__since 2.0__*)|No, defaults to `[org]-[module]`.
+|log|the log setting to use during the resolve process (*__since 2.0__*)
 
 Available options are: +
 * `default`: the default log settings, where all usual messages are output to the console
+
@@ -72,7 +72,7 @@ Available options are: +
 
 == Child elements
 
-*__(Since 2.3)__*
+[*__since 2.3__*]
 
 These child elements are defining an inlined ivy.xml's link:../ivyfile/dependencies.html[dependencies]
elements. Thus these child elements cannot be used together with the `inline` or `file` attributes.
 
@@ -83,7 +83,7 @@ There is one important difference with the ivy.xml's link:../ivyfile/dependencie
 |Element|Description|Cardinality
 |link:../ivyfile/dependency.html[dependency]|declares a dependency to resolve|0..n
 |link:../ivyfile/exclude.html[exclude]|excludes artifacts, modules or whole organizations
from the set of dependencies to resolve|0..n
-|link:../ivyfile/override.html[override]|specify an override mediation rule, overriding the
revision and/or branch requested for a transitive dependency *__since 2.0__*|0..n
+|link:../ivyfile/override.html[override]|specify an override mediation rule, overriding the
revision and/or branch requested for a transitive dependency (*__since 2.0__*)|0..n
 |=======
 
 == Examples

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/publish.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/publish.adoc b/asciidoc/use/publish.adoc
index 3631335..dc95575 100644
--- a/asciidoc/use/publish.adoc
+++ b/asciidoc/use/publish.adoc
@@ -29,8 +29,7 @@ It also publishes the delivered Ivy file (except if you don't want), and
even de
 
 image::../images/ivy-publish-fc.png[]
 
-*__since 1.4.1__*
-The source artifact pattern can be specified either as an attribute on the task (artifactspattern)
or using a list of nested artifacts element (see examples below).
+(*__since 1.4.1__*) The source artifact pattern can be specified either as an attribute on
the task (artifactspattern) or using a list of nested artifacts element (see examples below).
 
 == Attributes
 
@@ -44,21 +43,21 @@ The source artifact pattern can be specified either as an attribute on
the task
 |resolver|the name of the resolver to use for publication|Yes
 |pubrevision|the revision to use for the publication|No. Defaults to the `${ivy.deliver.revision}`
 |pubbranch|the branch to use for the publication|No. Defaults to the `${ivy.deliver.branch}`
-|forcedeliver|`true` to force the implicit call to deliver, `false` to do it only if the
Ivy file to publish doesn't exist yet *__(since 1.4)__*|No. Defaults to `false`
+|forcedeliver|`true` to force the implicit call to deliver, `false` to do it only if the
Ivy file to publish doesn't exist yet (*__since 1.4__*)|No. Defaults to `false`
 |update|`true` to update Ivy file metadata (revision, branch, publication date and status)
before publishing, `false` otherwise. This is usually not necessary when using deliver before
publish.|No. Defaults to `false`
-|merge|if this descriptor link:../ivyfile/extends.html[extends] a parent, merge the inherited
information directly into this descriptor on publish.  The __extends__ element itself will
be commented out in the published descriptor. *__(since 2.2)__*|No. Defaults to false
+|merge|if this descriptor link:../ivyfile/extends.html[extends] a parent, merge the inherited
information directly into this descriptor on publish.  The __extends__ element itself will
be commented out in the published descriptor. (*__since 2.2__*)|No. Defaults to false
 |validate|`true` to force Ivy files validation against ivy.xsd, `false` to force no validation|No.
Defaults to default Ivy value (as configured in link:../settings.html[settings file])
-|replacedynamicrev|`true` to replace dynamic revisions by static ones in the delivered file,
`false` to avoid this replacement *__(since 1.3)__*|No. Defaults to `true`
+|replacedynamicrev|`true` to replace dynamic revisions by static ones in the delivered file,
`false` to avoid this replacement (*__since 1.3__*)|No. Defaults to `true`
 |publishivy|`true` to publish delivered Ivy file, `false` otherwise|No. Defaults to `true`
-|conf|A comma separated list of configurations to publish  *__(since 1.4.1)__*. Accepts wildcards
*__(since 2.2)__*.|No. Defaults to all configurations
+|conf|A comma separated list of configurations to publish (*__since 1.4.1__*). Accepts wildcards
(*__since 2.2__*).|No. Defaults to all configurations
 |overwrite|`true` to overwrite files in repository if the revision already exists, `false`
to let it as is|No. Defaults to `false`
 |warnonmissing|`true` to warn when artifacts to be published are missing|No. Defaults to
`true`
 |haltonmissing|`true` to halt build when artifacts to be published are missing|No. Defaults
to `true`
-|srcivypattern|the pattern to use to find Ivy file to publish, and even deliver if necessary
*__(since 1.2)__*|No. Defaults to the value of `artifactspattern`
+|srcivypattern|the pattern to use to find Ivy file to publish, and even deliver if necessary
(*__since 1.2__*)|No. Defaults to the value of `artifactspattern`
 |pubdate|the publication date to use for the delivery, if necessary. This date should be
either `now`, or a date given with the following pattern: `yyyyMMddHHmmss`|No. Defaults to
`now`
 |status|the status to use for the delivery, if necessary|No. Defaults to `${ivy.status}`
 |delivertarget|the target to call for recursive delivery|No. No recursive delivery is done
by default
-|settingsRef|A reference to Ivy settings that must be used by this task *__(since 2.0)__*|No,
default to `ivy.instance`.
+|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No,
default to `ivy.instance`.
 |=======
 
 == Child elements
@@ -66,7 +65,7 @@ The source artifact pattern can be specified either as an attribute on the
task
 [options="header"]
 |=======
 |Element|Description|Cardinality
-|artifact|Describe additional artifacts to publish. These elements can have any attributes:
standard artifact attributes and *__(since 2.2)__* extra attributes are supported.|0..n
+|artifact|Describe additional artifacts to publish. These elements can have any attributes:
standard artifact attributes and (*__since 2.2__*) extra attributes are supported.|0..n
 |artifacts|Specify the pattern used to find the artifact. These elements have a `pattern`
attribute containing the pattern used to find the artifact.|0..n
 |=======
 

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/report.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/report.adoc b/asciidoc/use/report.adoc
index 86ae3f9..9cf9561 100644
--- a/asciidoc/use/report.adoc
+++ b/asciidoc/use/report.adoc
@@ -26,7 +26,7 @@ If you want to have an idea of what reports look like, check this very simple
li
 The task also generates a GraphML file which can be loaded with the free link:http://www.yworks.com/en/products_yed_about.htm[yEd]
graph editor.
 Then following a few link:../yed.html[simple steps] you can obtain a graph like this link:../samples/jayasoft-ivyrep-example-default.jpg[one].
 
-*__since 1.4__* If a custom XSLT is specified, it's possible to specify additional parameters
to the stylesheet.
+(*__since 1.4__*) If a custom XSLT is specified, it's possible to specify additional parameters
to the stylesheet.
 
 == Attributes
 
@@ -35,17 +35,17 @@ Then following a few link:../yed.html[simple steps] you can obtain a graph
like
 |Attribute|Description|Required
 |todir|the directory to which reports should be generated|No, defaults to `${ivy.report.todir}`,
or execution directory if not defined
 |outputpattern|the generated report names pattern|No, defaults to `${ivy.report.output.pattern}`,
or `[organisation]-[module]-[conf].[ext]` if not defined
-|xsl|`true` to generate a report (by default html report) using xslt, `false` otherwise *__since
1.3__*|No, defaults to `true`
-|xml|`true` to generate an XML report, `false` otherwise *__since 1.3__*|No, defaults to
`false`
+|xsl|`true` to generate a report (by default html report) using xslt, `false` otherwise (*__since
1.3__*)|No, defaults to `true`
+|xml|`true` to generate an XML report, `false` otherwise (*__since 1.3__*)|No, defaults to
`false`
 |graph|`true` to generate GraphML files, `false` otherwise|No, defaults to `true`
-|dot|`true` to generate link:http://www.graphviz.org/[Graphviz DOT] files, `false` otherwise
*__since 1.4__*|No, defaults to `false`
+|dot|`true` to generate link:http://www.graphviz.org/[Graphviz DOT] files, `false` otherwise
(*__since 1.4__*)|No, defaults to `false`
 |conf|a comma separated list of the configurations for which a report should be generated|No.
Defaults to the configurations resolved by the last resolve call (during same Ant build),
or `${ivy.resolved.configurations}` if no resolve was called
 |organisation|the name of the organisation of the module for which report should be generated|No,
unless resolveId has not been specified and no resolve was called during the build. Defaults
to last resolved module organisation.
 |module|the name of the module for which report should be generated|No, unless resolveId
has not been specified and no resolve was called during the build. Defaults to last resolved
module.
 |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)
 |xslfile|indicates which xsl file should be used to generate the report|No, defaults to Ivy
provided xsl which generates html report
-|settingsRef|A reference to Ivy settings that must be used by this task *__(since 2.0)__*|No,
defaults to `ivy.instance`.
-|resolveId|The id which was used for a previous resolve *__(since 2.0)__*|No, defaults to
`[org]-[module]`.
+|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No,
defaults to `ivy.instance`.
+|resolveId|The id which was used for a previous resolve (*__since 2.0__*)|No, defaults to
`[org]-[module]`.
 |=======
 
 == Examples

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/repreport.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/repreport.adoc b/asciidoc/use/repreport.adoc
index 29ecda9..f9291c8 100644
--- a/asciidoc/use/repreport.adoc
+++ b/asciidoc/use/repreport.adoc
@@ -17,7 +17,9 @@
    under the License.
 ////
 
-Generates reports about dependencies among several modules in the repository (repreport stands
for repository report). *__since 1.4__*
+[*__since 1.4__*]
+
+Generates reports about dependencies among several modules in the repository (repreport stands
for repository report).
 
 This task is similar to the link:../use/report.html[report] task, except that instead of
working on a single module you just resolved, it works with a set of modules in your repository.
 
@@ -47,7 +49,7 @@ Moreover, to be able to list organizations, this task requires an [organisation]
 |dot|`true` to generate Graphviz DOT format file, `false` otherwise|No, defaults to `false`
 |matcher|the name of the matcher to use for matching modules names and organisations in your
repository|No. Defaults to `exactOrRegexp`
 |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`.
+|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No,
defaults to `ivy.instance`.
 |=======
 
 == Examples

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/resolve.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/resolve.adoc b/asciidoc/use/resolve.adoc
index 2bb798f..d563902 100644
--- a/asciidoc/use/resolve.adoc
+++ b/asciidoc/use/resolve.adoc
@@ -27,14 +27,11 @@ After the call to this task, four properties are set in Ant:
 * `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 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
allows to optimize your build when you have multi-module build with multiple configurations.
+(*__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 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:
+(*__since 2.0__*) In addition, if the `resolveId` attribute has been set, the following properties
are set as well:
 
 * `ivy.organisation.${resolveId}`
 * `ivy.module.${resolveId}`
@@ -42,8 +39,7 @@ In addition, if the `resolveId` attribute has been set, the following properties
 * `ivy.resolved.configurations.${resolveId}`
 * `ivy.deps.changed.${resolveId}`
 
-*Since 2.4*
-If current module extends other modules:
+(*__since 2.4__*) If current module extends other modules:
 
 * `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
@@ -80,13 +76,17 @@ This table gives some statistics about the dependency resolution. Each
line corr
 
 == Inline mode
 
-*__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.
+[*__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`!
 
 == Resolve mode
 
-*__since 2.0__* The resolve mode allows to define how Ivy should use dependency revision
constraints when performing the resolution.
+[*__since 2.0__*]
+
+The resolve mode allows to define how Ivy should use dependency revision constraints when
performing the resolution.
 
 Two modes are available:
 
@@ -106,38 +106,38 @@ __Note for developers__: after the call to this task, a reference to
the module
 |Attribute|Description|Required
 |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`
+(*__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
-|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)__*|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`.
+|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__*)|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`
-|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`
+|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 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)__*
+|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__*)
 
 Available options are: +
 * `default`: the default log settings, where all usual messages are output to the console
+
 * `download-only`: disable all usual messages but download ones. A resolve with everything
in cache won't output any message. +
 * `quiet`: disable all usual messages, making the whole resolve process quiet unless errors
occur +
 |No, defaults to `default`.
-|checkIfChanged|When set to `true`, the resolve will compare the result with the last resolution
done on this module, with those configurations in order to define the property `ivy.deps.changed`.
 Put it to `false` may provides slightly better performance. *__(since 2.0)__*|No, default
to `true`
-|useCacheOnly|When set to `true`, it forces the resolvers to only use their caches and not
their actual contents.*__(since 2.0)__*|No, default to `false`
+|checkIfChanged|When set to `true`, the resolve will compare the result with the last resolution
done on this module, with those configurations in order to define the property `ivy.deps.changed`.
 Put it to `false` may provides slightly better performance. (*__since 2.0__*)|No, default
to `true`
+|useCacheOnly|When set to `true`, it forces the resolvers to only use their caches and not
their actual contents. (*__since 2.0__*)|No, default to `false`
 |=======
 
 == Child elements
 
-*__(Since 2.3)__*
+[*__since 2.3__*]
 
 These child elements are defining an inlined ivy.xml's link:../ivyfile/dependencies.html[dependencies]
elements. Thus these child elements cannot be used together with the `inline` or `file` attributes.
 
@@ -148,7 +148,7 @@ There is one important difference with the ivy.xml's link:../ivyfile/dependencie
 |Element|Description|Cardinality
 |link:../ivyfile/dependency.html[dependency]|declares a dependency to resolve|0..n
 |link:../ivyfile/exclude.html[exclude]|excludes artifacts, modules or whole organizations
from the set of dependencies to resolve|0..n
-|link:../ivyfile/override.html[override]|specify an override mediation rule, overriding the
revision and/or branch requested for a transitive dependency *__since 2.0__*|0..n
+|link:../ivyfile/override.html[override]|specify an override mediation rule, overriding the
revision and/or branch requested for a transitive dependency (*__since 2.0__*)|0..n
 |=======
 
 == Examples

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/resources.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/resources.adoc b/asciidoc/use/resources.adoc
index 5b625f7..9d285ee 100644
--- a/asciidoc/use/resources.adoc
+++ b/asciidoc/use/resources.adoc
@@ -17,7 +17,8 @@
    under the License.
 ////
 
-*__(since 2.3) (Ant 1.7 required)__*
+[*__since 2.3__*] (*__Ant 1.7 required__*)
+
 `ivy:resources` is an Ant link:http://ant.apache.org/manual/Types/resources.html#collection[resource
collection], containing files found by an Ivy resolve, which then can be used with any task
working with resources like `copy` or `import`.
 
 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.

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/retrieve.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/retrieve.adoc b/asciidoc/use/retrieve.adoc
index 5b4df5d..05f11bb 100644
--- a/asciidoc/use/retrieve.adoc
+++ b/asciidoc/use/retrieve.adoc
@@ -21,14 +21,14 @@ The `retrieve` task copies resolved dependencies anywhere you want in
your file
 
 This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and
attributes common to all post resolve tasks.
 
-*__since 1.4__* This task can even be used to synchronize the destination directory with
what should actually be in according to the dependency resolution. This means that by setting
`sync="true"`, Ivy will not only copy the necessary files, but it will also remove the files
which do not need to be there.
+(*__since 1.4__*) This task can even be used to synchronize the destination directory with
what should actually be in according to the dependency resolution. This means that by setting
`sync="true"`, Ivy will not only copy the necessary files, but it will also remove the files
which do not need to be there.
 
 The synchronisation actually consists in deleting all filles and directories in the root
destination directory which are not required by the retrieve.
 
 The root destination directory is the the directory denoted by the first level up the first
token in the destination pattern.
 For instance, for the pattern `lib/[conf]/[artifact].[ext]`, the root will be `lib`.
 
-*__since 2.3__* A nested link:http://ant.apache.org/manual/Types/mapper.html[mapper] element
can be used to specify more complex filename transformations of the retrieved files. See the
examples below.
+(*__since 2.3__*) A nested link:http://ant.apache.org/manual/Types/mapper.html[mapper] element
can be used to specify more complex filename transformations of the retrieved files. See the
examples below.
 
 == Attributes
 
@@ -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.
Dependency 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
exists *__(since 2.2)__*.
+|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
exists (*__since 2.2__*).
 
 Possible values are: +
 * `newer`: overwrite the destination file if a more recent one is available (based on timestamp)
+
@@ -48,22 +48,19 @@ Possible values are: +
 * `always`: always overwrite the destination file +
 * `never`: never overwrite the destination file +
 |No. Defaults to `newer`.
-|symlink|`true` to create symbolic links, `false` to copy the artifacts.
-    The destination of the symbolic links depends on the value of the `useOrigin` attribute.
+
-    The implementation of this task relies on Java standard `Files.createSymbolicLink` API
and depending on whether or not the underlying
-    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.|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)__*
+|symlink|`true` to create symbolic links, `false` to copy the artifacts. The destination
of the symbolic links depends on the value of the `useOrigin` attribute. +
+The implementation of this task relies on Java standard `Files.createSymbolicLink` API and
depending on whether or not the underlying 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`
+|[line-through]#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: +
 * `default`: the default log settings, where all usual messages are output to the console
+
 * `quiet`: disable all usual messages, making the whole retrieve process quiet unless errors
occur
 |No, defaults to `default`.
-|pathId|the id of the path to create containing the retrieved artifacts. *__since 2.3__*|No.
No path is created by default.
-|setId|the id of the fileset to create containing the retrieved artifacts. *__since 2.3__*|No.
No fileset is created by default.
+|pathId|the id of the path to create containing the retrieved artifacts. (*__since 2.3__*)|No.
No path is created by default.
+|setId|the id of the fileset to create containing the retrieved artifacts. (*__since 2.3__*)|No.
No fileset is created by default.
 |=======
 
 == Examples

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/settings.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/settings.adoc b/asciidoc/use/settings.adoc
index 96b4581..e2e2d0b 100644
--- a/asciidoc/use/settings.adoc
+++ b/asciidoc/use/settings.adoc
@@ -17,7 +17,7 @@
    under the License.
 ////
 
-*__(since 2.0)__*
+[*__since 2.0__*]
 
 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.
 

http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/var.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/var.adoc b/asciidoc/use/var.adoc
index 79e6c25..a729d88 100644
--- a/asciidoc/use/var.adoc
+++ b/asciidoc/use/var.adoc
@@ -38,5 +38,5 @@ See link:../reference.html[reference] page for details about Ivy variables.
 .2+.^|One of these, when *not* using the name attribute
 |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 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`.
 |=======


Mime
View raw message