You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by ja...@apache.org on 2017/06/20 08:59:58 UTC
[1/2] ant-ivy git commit: [doc changes] Fix the "Reference ->
Settings File" section and children docs
Repository: ant-ivy
Updated Branches:
refs/heads/master 39431e202 -> e35f06c0a
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/outputters.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/outputters.adoc b/asciidoc/settings/outputters.adoc
index 3529b01..d3d554a 100644
--- a/asciidoc/settings/outputters.adoc
+++ b/asciidoc/settings/outputters.adoc
@@ -1,3 +1,4 @@
+= outputters
*Tag:* outputters
@@ -8,10 +9,10 @@ A report outputter is used at the end of the resolve process to generate a repor
Two report outputters are registered by default:
-* a log report outputter (link:https://git-wip-us.apache.org/repos/asf?p=ant-ivy.git;a=blob;f=src/java/org/apache/ivy/plugins/report/LogReportOutputter.java[LogReportOutputter]) +
-which produces the output on the console at the end of the resolve, which looks like this:
+ * a log report outputter (link:https://git-wip-us.apache.org/repos/asf?p=ant-ivy.git;a=blob;f=src/java/org/apache/ivy/plugins/report/LogReportOutputter.java[LogReportOutputter]) +
+ which produces the output on the console at the end of the resolve, which looks like this:
-[source]
+[source.shell]
----
---------------------------------------------------------------------
@@ -24,11 +25,11 @@ which produces the output on the console at the end of the resolve, which looks
----
-* an xml report outputter (link:https://git-wip-us.apache.org/repos/asf?p=ant-ivy.git;a=blob;f=src/java/org/apache/ivy/plugins/report/XmlReportOutputter.java[XmlReportOutputter]) +
-which produces an xml report in the cache, which is mandatory for correct Ivy behaviour, since it's that report which is used when you do a post resolve step in a separate build from the resolve itself. It's also this xml report which is processed to generate all the different reports available in the link:../use/report.html[report] task.
+ * an xml report outputter (link:https://git-wip-us.apache.org/repos/asf?p=ant-ivy.git;a=blob;f=src/java/org/apache/ivy/plugins/report/XmlReportOutputter.java[XmlReportOutputter]) +
+ which produces an xml report in the cache, which is mandatory for correct Ivy behaviour, since it's that report which is used when you do a post resolve step in a separate build from the resolve itself. It's also this xml report which is processed to generate all the different reports available in the link:../use/report.html[report] task.
-The child tag used for the parser must be equal to a name of a report outputter type (added with the typedef tag).
+The child tag used for the parser must be equal to a name of a report outputter type (added with the `typedef` tag).
To see how to define your own report outputter see link:../extend.html[Extending Ivy documentation]
@@ -41,3 +42,4 @@ To see how to define your own report outputter see link:../extend.html[Extending
|Element|Description|Cardinality
|any report outputter|adds a report outputter to the list of available ones|0..n
|=======
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/parsers.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/parsers.adoc b/asciidoc/settings/parsers.adoc
index 40cbb89..30a744e 100644
--- a/asciidoc/settings/parsers.adoc
+++ b/asciidoc/settings/parsers.adoc
@@ -1,10 +1,11 @@
+= parsers
*Tag:* parsers
Defines a list of module descriptor parsers usable in ivy. Each parser defines which resources (which descriptor file) it accepts.
-The child tag used for the parser must be equal to a name of a parser type (added with the typedef tag).
+The child tag used for the parser must be equal to a name of a parser type (added with the `typedef` tag).
-Note that when looking for a parser, ivy queries the parsers list in the reverse order. So the last parser in the list will be queried first. Consequently, if the last parser accepts all resources, the other parsers will never have a chance to parse the resource.
+Note that when looking for a parser, ivy queries the parsers list in the reverse order. So the last parser in the list will be queried first. Consequently, if the last parser accepts all resources, the other parsers will _never_ have a chance to parse the resource.
Two parsers are available by default and thus do not need to be declared in this section:
@@ -13,7 +14,7 @@ Two parsers are available by default and thus do not need to be declared in this
this is the parser used for ivy xml files. This parser is used for resources that aren't accepted by any other parser.
* pom parser +
-this parser is able to parse maven2 pom files
+this parser is able to parse Maven2 `pom` files
== Child elements
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/properties.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/properties.adoc b/asciidoc/settings/properties.adoc
index da14804..4d42557 100644
--- a/asciidoc/settings/properties.adoc
+++ b/asciidoc/settings/properties.adoc
@@ -1,11 +1,11 @@
+= properties
*Tag:* properties
-
Loads a properties file into ivy variables. See the variables chapter above for details about ivy variables.
-*__Since 2.0__*: it is possible to access environment variables. This can be done by specifying the environment attribute. This attribute specifies the prefix which can be used to access these environment variables. For instance, if you specify environment="env", you can access the PATH environment variable with the env.PATH property name.
+*__Since 2.0__*: it is possible to access environment variables. This can be done by specifying the environment attribute. This attribute specifies the prefix which can be used to access these environment variables. For instance, if you specify `environment="env"`, you can access the `PATH` environment variable with the `env.PATH` property name.
== Attributes
@@ -14,7 +14,8 @@ Loads a properties file into ivy variables. See the variables chapter above for
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|file|a path to a properties file to load|One of these
+|file|a path to a properties file to load
+.2+|One of these
|environment|the prefix to use when retrieving environment variables *__(since 2.0)__*
|override|indicates if the variable found in the properties file should override its previous value, if any *__(since 1.3)__*|No, defaults to true
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/property.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/property.adoc b/asciidoc/settings/property.adoc
index 5df7361..a4c05d3 100644
--- a/asciidoc/settings/property.adoc
+++ b/asciidoc/settings/property.adoc
@@ -1,9 +1,10 @@
+= property
*Tag:* property
-Defines an ivy variable. *__since 1.3__*
+Defines an ivy variable.
-The optional override attribute enables you to avoid overriding the previous value of the variable, which makes the definition behave like an ant property, which is particularly useful to define default values (values which are used only if they haven't been defined yet).
+*__since 1.3__*: The optional override attribute enables you to avoid overriding the previous value of the variable, which makes the definition behave like an ant property, which is particularly useful to define default values (values which are used only if they haven't been defined yet).
== Attributes
@@ -22,7 +23,7 @@ The optional override attribute enables you to avoid overriding the previous val
== Examples
-[source]
+[source, xml]
----
<property name="myvar" value="myvalue"/>
@@ -34,7 +35,7 @@ Sets the variable myvar to the value myvalue.
'''
-[source]
+[source, xml]
----
<property name="myvar" value="myvalue" override="false"/>
@@ -46,7 +47,7 @@ Sets the variable myvar to the value myvalue only if myvar has not been set yet.
'''
-[source]
+[source, xml]
----
<properties environment="env"/>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/resolvers.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/resolvers.adoc b/asciidoc/settings/resolvers.adoc
index 4cc899d..0608d5c 100644
--- a/asciidoc/settings/resolvers.adoc
+++ b/asciidoc/settings/resolvers.adoc
@@ -1,3 +1,4 @@
+= resolvers
*Tag:* resolvers
@@ -7,14 +8,14 @@ The child tag used for the dependency resolver must be equal to a name of a depe
*__since 1.3__* Once defined, resolvers can be referenced by their name, using the following syntax:
-[source]
+[source, xml]
----
<resolver ref="alreadydefinedresolver"/>
----
-Note that this works only if the resolver has already been defined and NOT if it is defined later in the ivysettings file.
+Note that this works only if the resolver has already been defined and *NOT* if it is defined later in the ivysettings file.
== Child elements
@@ -33,7 +34,7 @@ Ivy comes with a set of built-in dependency resolvers that handle most common ne
If you don't find the one you want here, you can also check if someone has contributed it on the links page, or even link:../extend.html[write your own].
-There are basically two types of resolvers in Ivy: composite and standard. A composite resolver is a resolver which delegates the work to other resolvers. The other resolvers are standard resolvers.
+There are basically two types of resolvers in Ivy - composite and standard. A composite resolver is a resolver which delegates the work to other resolvers. The other resolvers are standard resolvers.
Here is the list of built-in resolvers:
@@ -69,19 +70,19 @@ All resolvers of the same type share some common features and attributes detaile
All standard resolvers support several options for validation.
-The __validate__ attribute is used to configure if ivy files should be checked against the ivy file xml schema.
+The `validate` attribute is used to configure if ivy files should be checked against the ivy file xml schema.
-The checkconsistency attribute allows you to enable or disable consistency checking between what is expected by Ivy when it finds a module descriptor, and what the module descriptor actually contains.
+The `checkconsistency` attribute allows you to enable or disable consistency checking between what is expected by Ivy when it finds a module descriptor, and what the module descriptor actually contains.
-The descriptor attribute lets you define if module descriptors are mandatory or optional.
+The `descriptor` attribute lets you define if module descriptors are mandatory or optional.
-The checksums attribute is used to define the list of checksums files to use to check if the content of downloaded files has not been corrupted (eg during transfer).
+The `checksums` attribute is used to define the list of checksums files to use to check if the content of downloaded files has not been corrupted (eg during transfer).
==== force
-Any standard resolver can be used in force mode, which is used mainly to handle local development builds. In force mode, the resolver attempts to find a dependency whatever the requested revision is (internally it replace the requested revision by 'latest.integration'), and if it finds one, it forces this revision to be returned, even when used in a chain with returnFirst=false.
+Any standard resolver can be used in `force` mode, which is used mainly to handle local development builds. In force mode, the resolver attempts to find a dependency whatever the requested revision is (internally it replace the requested revision by `latest.integration`), and if it finds one, it forces this revision to be returned, even when used in a chain with `returnFirst=false`.
-By using such a resolver at the beginning of a chain, you can be sure that Ivy will pick up whatever module is available in this resolver (usually a private local build) instead of the real requested revision. This allows to handle use case like a developer working on modules A and C, where A -> B -> C, and pick up the local build for C without having to publish a local version of B.
+By using such a resolver at the beginning of a chain, you can be sure that Ivy will pick up whatever module is available in this resolver (usually a private local build) instead of the real requested revision. This allows to handle use case like a developer working on modules `A` and `C`, where `A -> B -> C`, and pick up the local build for `C` without having to publish a local version of `B`.
*__since 2.0__*
@@ -123,7 +124,7 @@ And setting the property `ivy.maven.lookup.javadoc` to `false` disable the looku
== Examples
-[source]
+[source, xml]
----
<resolvers>
@@ -143,4 +144,5 @@ And setting the property `ivy.maven.lookup.javadoc` to `false` disable the looku
----
-Defines a filesystem resolver, named '1', which is then used in two chains, the first which combines the filesystem resolver with an ivyrep resolver, and second which combines the filesystem resolver with an ibiblio resolver, and which returns the first module found, and uses the whole chain to download artifacts (see corresponding resolvers documentation for details about them). Resolver 1 will use a cache named 'cache-1' which should have been defined under the caches element.
\ No newline at end of file
+Defines a filesystem resolver, named `1`, which is then used in two chains, the first which combines the filesystem resolver with an ivyrep resolver, and second which combines the filesystem resolver with an ibiblio resolver, and which returns the first module found, and uses the whole chain to download artifacts (see corresponding resolvers documentation for details about them). Resolver `1` will use a cache named `cache-1` which should have been defined under the caches element.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/settings.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/settings.adoc b/asciidoc/settings/settings.adoc
index 8bb38a5..046b178 100644
--- a/asciidoc/settings/settings.adoc
+++ b/asciidoc/settings/settings.adoc
@@ -1,15 +1,18 @@
+= settings
*Tag:* settings
-Configures some important ivy info: default resolver, latest strategy, conflict manager...
+Configures some important ivy info: default resolver, latest strategy, conflict manager and some others.
The default resolver is used whenever nothing else is configured in the modules section of the settings file. It should give the name of a dependency resolver defined in the link:../settings/resolvers.html[resolvers] section of the settings file.
The default latest strategy and conflict manager can also be configured here.
_validate_ indicates if ivy files should generally be validated against the xsd or not. This setting is only a default value, and can be overridden:
-1) in ant tasks
-2) in resolvers
+
+ 1. in ant tasks
+ 2. in resolvers
+
So if there is a setting in the resolver, it always wins against all other settings.
@@ -28,13 +31,13 @@ So if there is a setting in the resolver, it always wins against all other setti
|validate|Indicates if ivy files should be validated against ivy.xsd or not.|No, defaults to true
|useRemoteConfig|true to configure ivyrep and ibiblio resolver from a remote configuration file (updated with changes in those repository structure if any) (*__since 1.2__*)|No, defaults to false
|httpRequestMethod|specifies the HTTP method to use to retrieve information about an URL. Possible values are 'GET' and 'HEAD'. This setting can be used to solve problems with firewalls and proxies. (*__since 2.0__*)|No, defaults to 'HEAD'
-|[line-through]#defaultCache#|a path to a directory to use as default basedir for both resolution and repository cache(s).
+|[line-through]#defaultCache#|a path to a directory to use as default basedir for both resolution and repository cache(s). +
__Deprecated, we recommend using defaultCacheDir on the link:../settings/caches.html[caches] tag instead__|No, defaults to .ivy2/cache in user home
-|[line-through]#checkUpToDate#|Indicates if date should be checked before retrieving artifacts from cache.
+|[line-through]#checkUpToDate#|Indicates if date should be checked before retrieving artifacts from cache. +
__Deprecated, we recommend using overwriteMode on the link:../use/retrieve.html[retrieve] task instead__|No, defaults to true
-|[line-through]#cacheIvyPattern#|a pattern to indicate where ivy files should be put in cache.
+|[line-through]#cacheIvyPattern#|a pattern to indicate where ivy files should be put in cache. +
__Deprecated, we recommend using ivyPattern on the link:../settings/caches.html[caches] tag instead__|No, defaults to [organisation]/[module]/ivy-[revision].xml
-|[line-through]#cacheArtifactPattern#|a pattern to indicate where artifact files should be put in cache.
+|[line-through]#cacheArtifactPattern#|a pattern to indicate where artifact files should be put in cache. +
__Deprecated, we recommend using artifactPattern on the link:../settings/caches.html[caches] tag instead__|No, defaults to [organisation]/[module]/[type]s/[artifact]-[revision].[ext]
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/signers.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/signers.adoc b/asciidoc/settings/signers.adoc
index 5f371b5..2c4ad51 100644
--- a/asciidoc/settings/signers.adoc
+++ b/asciidoc/settings/signers.adoc
@@ -1,5 +1,7 @@
+= signers
*Tag:* signers
+
*__since 2.2__*
Defines a list of detached signature generators usable in ivy. Each generator is identified by its name, given as an attribute.
@@ -12,8 +14,6 @@ Ivy supports the following signature generator out of the box:
generates an OpenPGP compatible ASCII armored detached signature.
-
-
== Child elements
@@ -42,8 +42,8 @@ This generator is capable of generating an OpenPGP compatible ASCII armored deta
|=======
|Attribute|Description|Required
|name|The name of the signature generator.|Yes
-|secring|The location of the secret keyring.|No, defaults to ${user.home}/.gnupg/secring.gpg
-|keyId|The identifier of the key to use. The keyword 'auto' can be used to indicate a key will be selected automatically.|No, defaults to 'auto'.
+|secring|The location of the secret keyring.|No, defaults to `${user.home}/.gnupg/secring.gpg`
+|keyId|The identifier of the key to use. The keyword `auto` can be used to indicate a key will be selected automatically.|No, defaults to `auto`.
|password|The password of the private key.|Yes
|=======
@@ -52,7 +52,7 @@ This generator is capable of generating an OpenPGP compatible ASCII armored deta
== Examples
-[source]
+[source, xml]
----
<signers>
@@ -66,7 +66,7 @@ Defines a detached signature generator with name 'mypgp' which uses the secret k
'''
-[source]
+[source, xml]
----
<signers>
@@ -75,4 +75,4 @@ Defines a detached signature generator with name 'mypgp' which uses the secret k
----
-Same as before, but this time the key '123ABC45' is used to generate the detached signature.
\ No newline at end of file
+Same as before, but this time the key `123ABC45` is used to generate the detached signature.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/status.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/status.adoc b/asciidoc/settings/status.adoc
index d171c57..717f842 100644
--- a/asciidoc/settings/status.adoc
+++ b/asciidoc/settings/status.adoc
@@ -1,3 +1,4 @@
+= status
*Tag:* status
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/statuses.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/statuses.adoc b/asciidoc/settings/statuses.adoc
index 6c8bde7..ac2cb8e 100644
--- a/asciidoc/settings/statuses.adoc
+++ b/asciidoc/settings/statuses.adoc
@@ -1,15 +1,16 @@
+= statuses
*Tag:* statuses
Defines the list of available statuses. *__since 1.4__*
-By default, ivy has 3 statuses: release, milestone and integration. By adding a statuses section to your ivysettings file, you define the statuses you want to use. Note that in this case if you still want to have ivy default statuses you will have to declare them.
+By default, ivy has 3 statuses: `release`, `milestone` and `integration`. By adding a statuses section to your ivysettings file, you define the statuses you want to use. Note that in this case if you still want to have ivy default statuses you will have to declare them.
-The integration property on each status is only used for recursive delivery, an integration dependency being delivered if the caller is not in integration state itself.
+The `integration` property on each status is only used for recursive delivery, an integration dependency being delivered if the caller is not in integration state itself.
-The default status is the one used when none is defined in a module descriptor. If not specified, it defaults to the last defined status.
+The `default` status is the one used when none is defined in a module descriptor. If not specified, it defaults to the last defined status.
-The statuses order is important, the first is considered the more mature, the last the less mature. This is used to know if a status is compatible with a latest._<status>_ version matcher.
+NOTE: The statuses order is important, the first is considered the more mature, the last the less mature. This is used to know if a status is compatible with a `latest._<status>_` version matcher.
== Attributes
@@ -35,7 +36,7 @@ The statuses order is important, the first is considered the more mature, the la
== Examples
-[source]
+[source, xml]
----
<statuses default="bronze">
@@ -46,5 +47,5 @@ The statuses order is important, the first is considered the more mature, the la
----
-Defines 3 statuses, gold, silver and bronze. The default status used when none is declared in an ivy file will be bronze.
-It is also considered as an integration status, and thus doesn't trigger any recrusive delivery.
\ No newline at end of file
+Defines 3 statuses, `gold`, `silver` and `bronze`. The default status used when none is declared in an ivy file will be `bronze`.
+It is also considered as an integration status, and thus doesn't trigger any recrusive delivery.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/triggers.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/triggers.adoc b/asciidoc/settings/triggers.adoc
index 60ed6a5..2d5a32b 100644
--- a/asciidoc/settings/triggers.adoc
+++ b/asciidoc/settings/triggers.adoc
@@ -1,5 +1,7 @@
+= triggers
*Tag:* triggers
+
*__since 1.4__*
Defines a list of triggers to activate on some Ivy events.
@@ -8,14 +10,14 @@ A trigger is an action which is performed whenever a particular event occurs.
Ivy supports 3 type of triggers out of the box:
-* ant-call +
- calls a target in the same build as the original one whenever a particular event occurs.
+ * ant-call +
+ calls a target in the same build as the original one whenever a particular event occurs.
-* ant-build +
- calls an ant build which may be in another ant build script.
+ * ant-build +
+ calls an ant build which may be in another ant build script.
-* log +
- echo a message, usually in a file
+ * log +
+ echo a message, usually in a file
If you want to use a different trigger, you can link:../extend.html[implement your own].
@@ -410,7 +412,7 @@ the absolute path of the source file for the artifact
-The child tag used for the dependency resolver must be equal to a name of a trigger type (either built-in or added with the typedef tag).
+The child tag used for the dependency resolver must be equal to a name of a trigger type (either built-in or added with the `typedef` tag).
== Child elements
@@ -445,9 +447,10 @@ Ivy comes with 3 built-in triggers:
All triggers share some common attributes detailed here.
Among these attributes, you will find how to select when the trigger should be performed. You have to provide an event name, which is simple, but you can also use a filter expression. The syntax for this expression is very simple and limited:
-you can use the = operator to compare an attribute (left operande) with a value (right operande).
-you can use AND OR NOT as boolean operators
-you cannot use parenthesis to change the precedence
+
+ - you can use the = operator to compare an attribute (left operande) with a value (right operande).
+ - you can use AND OR NOT as boolean operators
+ - you cannot use parenthesis to change the precedence
[options="header",cols="15%,50%,35%"]
@@ -463,7 +466,7 @@ you cannot use parenthesis to change the precedence
== Examples
-[source]
+[source, xml]
----
<triggers>
@@ -473,13 +476,13 @@ you cannot use parenthesis to change the precedence
----
-Triggers an ant build of the ant file ${ivy.settings.dir}/[module]/build.xml (where [module] is replaced by the name of the dependency resolved) with the target "publish", just before resolving a dependency with a latest.integration revision.
+Triggers an ant build of the ant file `${ivy.settings.dir}/[module]/build.xml` (where `[module]` is replaced by the name of the dependency resolved) with the target "publish", just before resolving a dependency with a `latest.integration` revision.
Note that by default the ant build is triggered only once per build file. See below to see how to trigger the build more than once.
'''
-[source]
+[source, xml]
----
<triggers>
@@ -495,7 +498,7 @@ Same as before, but this time the builds will be triggered as many time as the d
'''
-[source]
+[source, xml]
----
<triggers>
@@ -505,10 +508,10 @@ Same as before, but this time the builds will be triggered as many time as the d
----
-Triggers an ant call of the target unzip just after downloading a zip artifact, prefixing all parameters to the target with 'dep'.
+Triggers an ant call of the target unzip just after downloading a zip artifact, prefixing all parameters to the target with `dep`.
Here is how the target can look like:
-[source]
+[source, xml]
----
<target name="unzip">
@@ -535,7 +538,7 @@ Here is how the target can look like:
'''
-[source]
+[source, xml]
----
<triggers>
@@ -548,4 +551,4 @@ Here is how the target can look like:
Logs any successful artifact download, with information on the source and destination, and details on download size and duration.
-The file attribute is optional, the log trigger will output messages to console if it isn't provided.
\ No newline at end of file
+The `file` attribute is optional, the log trigger will output messages to console if it isn't provided.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/typedef.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/typedef.adoc b/asciidoc/settings/typedef.adoc
index 7aacd45..986c359 100644
--- a/asciidoc/settings/typedef.adoc
+++ b/asciidoc/settings/typedef.adoc
@@ -1,8 +1,7 @@
+= typedef
*Tag:* typedef
-
-
Defines a new type in ivy. Useful to define new dependency resolvers, in particular, but also latest strategies.
See link:../extend.html[how to write and plug your own dependency resolver] for details.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/version-matchers.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/version-matchers.adoc b/asciidoc/settings/version-matchers.adoc
index e31632d..2f72534 100644
--- a/asciidoc/settings/version-matchers.adoc
+++ b/asciidoc/settings/version-matchers.adoc
@@ -1,9 +1,10 @@
+= version-matchers
*Tag:* version-matchers
Defines a list of version matchers. *__since 1.4__*
-The child tag used for the version matcher must be equal to a name of a report outputter type (added with the typedef tag).
+The child tag used for the version matcher must be equal to a name of a report outputter type (added with the `typedef` tag).
A version matcher is used to evaluate if a dependency version constraint matches a dependency version.
@@ -13,7 +14,7 @@ A version matcher is used to evaluate if a dependency version constraint matches
[options="header",cols="15%,50%,35%"]
|=======
-|Descrition|Required
+|Attribute|Descrition|Required
|usedefaults|when set to true, includes the built-in version matchers (Latest, Sub Revision, and Version Ranger Matcher). Exact Revision Matcher is always included|No, defaults to false
|=======
@@ -39,7 +40,7 @@ A matcher that matches a dependency revision id to the module revision id using
=== Sub Revision Matcher
-A matcher that matches all revisions starting with a specific prefix. The syntax is: [prefix]+
+A matcher that matches all revisions starting with a specific prefix. The syntax is: `[prefix]+`
[options="header"]
@@ -54,7 +55,7 @@ A matcher that matches all revisions starting with a specific prefix. The syntax
=== Latest (Status) Matcher
-A matcher that matches versions based on their status. The predefined statuses in Ivy are 'release', 'milestone' and 'integration'. It's possible to define your own statuses, see link:../settings/statuses.html[statuses] for more details.
+A matcher that matches versions based on their status. The predefined statuses in Ivy are `release`, `milestone` and `integration`. It's possible to define your own statuses, see link:../settings/statuses.html[statuses] for more details.
[options="header"]
@@ -79,7 +80,8 @@ Range types are exhaustively listed by example in the table below.
|Revision|Matches
| [1.0,2.0] | all versions greater or equal to 1.0 and lower or equal to 2.0
| [1.0,2.0[ | all versions greater or equal to 1.0 and lower than 2.0
-| ]1.0,2.0]
+| ]1.0,2.0] | all versions greater than 1.0 and lower or equal to 2.0
+| ]1.0,2.0[ | all versions greater than 1.0 and lower than 2.0
| [1.0,) | all versions greater or equal to 1.0
| ]1.0,) | all versions greater than 1.0
| (,2.0] | all versions lower or equal to 2.0
@@ -97,7 +99,7 @@ The version pattern matcher allows for more flexibility in pattern matching at t
==== Settings.xml
-[source]
+[source, xml]
----
<pattern-vm>
@@ -110,7 +112,7 @@ The version pattern matcher allows for more flexibility in pattern matching at t
==== Ivy.xml
-[source]
+[source, xml]
----
<dependency org="acme" name="tool" rev="foo(1, 3)" />
@@ -118,4 +120,4 @@ The version pattern matcher allows for more flexibility in pattern matching at t
----
The version pattern matcher may contain more than one match element. The matcher will attempt to match a dependency revision against each match in sequence, checking the revision tag (e.g. foo(..)) and then the pattern.
-Matcher types may be one of "regexp", "exact", "glob", or "exactOrRegexp". Glob pattern matching requires Apache ORO 2.0.8 or higher to be on the classpath.
\ No newline at end of file
+Matcher types may be one of "regexp", "exact", "glob", or "exactOrRegexp". Glob pattern matching requires Apache ORO 2.0.8 or higher to be on the classpath.
[2/2] ant-ivy git commit: [doc changes] Fix the "Reference ->
Settings File" section and children docs
Posted by ja...@apache.org.
[doc changes] Fix the "Reference -> Settings File" section and children docs
Project: http://git-wip-us.apache.org/repos/asf/ant-ivy/repo
Commit: http://git-wip-us.apache.org/repos/asf/ant-ivy/commit/e35f06c0
Tree: http://git-wip-us.apache.org/repos/asf/ant-ivy/tree/e35f06c0
Diff: http://git-wip-us.apache.org/repos/asf/ant-ivy/diff/e35f06c0
Branch: refs/heads/master
Commit: e35f06c0aae7ca105468c508569a9e9b00439310
Parents: 39431e2
Author: Jaikiran Pai <ja...@apache.org>
Authored: Tue Jun 20 10:49:49 2017 +0530
Committer: Jaikiran Pai <ja...@apache.org>
Committed: Tue Jun 20 14:27:43 2017 +0530
----------------------------------------------------------------------
asciidoc/resolver/bintray.adoc | 8 +-
asciidoc/resolver/chain.adoc | 13 +--
asciidoc/resolver/dual.adoc | 2 +-
asciidoc/resolver/filesystem.adoc | 35 ++++----
asciidoc/resolver/ibiblio.adoc | 21 ++---
asciidoc/resolver/ivyrep.adoc | 9 +-
asciidoc/resolver/jar.adoc | 12 +--
asciidoc/resolver/mirrored.adoc | 8 +-
asciidoc/resolver/obr.adoc | 13 +--
asciidoc/resolver/osgiagg.adoc | 11 +--
asciidoc/resolver/packager.adoc | 98 ++++------------------
asciidoc/resolver/sftp.adoc | 26 +++---
asciidoc/resolver/ssh.adoc | 17 ++--
asciidoc/resolver/updatesite.adoc | 10 +--
asciidoc/resolver/url.adoc | 10 +--
asciidoc/resolver/vfs.adoc | 11 +--
asciidoc/settings.adoc | 17 ++--
asciidoc/settings/caches.adoc | 13 +--
asciidoc/settings/caches/cache.adoc | 8 +-
asciidoc/settings/caches/ttl.adoc | 13 ++-
asciidoc/settings/classpath.adoc | 5 +-
asciidoc/settings/conflict-managers.adoc | 42 +++++-----
asciidoc/settings/credentials.adoc | 1 +
asciidoc/settings/include.adoc | 16 ++--
asciidoc/settings/latest-strategies.adoc | 17 ++--
asciidoc/settings/lock-strategies.adoc | 16 ++--
asciidoc/settings/macrodef.adoc | 19 +++--
asciidoc/settings/macrodef/attribute.adoc | 3 +-
asciidoc/settings/module.adoc | 30 +++----
asciidoc/settings/modules.adoc | 3 +-
asciidoc/settings/namespace.adoc | 8 +-
asciidoc/settings/namespace/dest.adoc | 16 ++--
asciidoc/settings/namespace/fromtosystem.adoc | 1 +
asciidoc/settings/namespace/rule.adoc | 1 +
asciidoc/settings/namespace/src.adoc | 1 +
asciidoc/settings/namespaces.adoc | 3 +-
asciidoc/settings/outputters.adoc | 14 ++--
asciidoc/settings/parsers.adoc | 7 +-
asciidoc/settings/properties.adoc | 7 +-
asciidoc/settings/property.adoc | 11 +--
asciidoc/settings/resolvers.adoc | 24 +++---
asciidoc/settings/settings.adoc | 17 ++--
asciidoc/settings/signers.adoc | 14 ++--
asciidoc/settings/status.adoc | 1 +
asciidoc/settings/statuses.adoc | 15 ++--
asciidoc/settings/triggers.adoc | 39 +++++----
asciidoc/settings/typedef.adoc | 3 +-
asciidoc/settings/version-matchers.adoc | 18 ++--
48 files changed, 333 insertions(+), 374 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/bintray.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/bintray.adoc b/asciidoc/resolver/bintray.adoc
index 9ed84b0..44a26dd 100644
--- a/asciidoc/resolver/bintray.adoc
+++ b/asciidoc/resolver/bintray.adoc
@@ -1,4 +1,4 @@
-
+= Bintray resolver
[]
|=======
@@ -33,7 +33,7 @@ This resolver uses Bintray DaaS (Distribution as a Service) platform to retrieve
----
-A default, defines a link:https://bintray.com/bintray/jcenter[JCenter] (http://jcenter.bintray.com/) resolver.
+A default, defines a link:https://bintray.com/bintray/jcenter[JCenter] bintray resolver.
In most circumstances you won't need any other resolvers as JCenter is already a super-set of many other repositories, including Maven Central.
@@ -41,7 +41,7 @@ In most circumstances you won't need any other resolvers as JCenter is already a
-[source]
+[source, xml]
----
<bintray subject="dsowerby" repo="maven"/>
@@ -50,4 +50,4 @@ In most circumstances you won't need any other resolvers as JCenter is already a
----
Defines two resolvers to use a link:https://bintray.com/dsowerby/maven[repository] "maven" of user "dsowerby" (https://dl.bintray.com/dsowerby/maven/)
-and link:https://bintray.com/igelgrun/batrak[repository] "batrak" of user "igelgrun" (https://dl.bintray.com/igelgrun/batrak/).
\ No newline at end of file
+and link:https://bintray.com/igelgrun/batrak[repository] "batrak" of user "igelgrun" (https://dl.bintray.com/igelgrun/batrak/).
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/chain.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/chain.adoc b/asciidoc/resolver/chain.adoc
index 77981d5..1f09748 100644
--- a/asciidoc/resolver/chain.adoc
+++ b/asciidoc/resolver/chain.adoc
@@ -1,4 +1,4 @@
-
+= Chain resolver
[]
|=======
@@ -8,7 +8,7 @@
|=======
-This resolver is only a container of a chain of other resolvers. The sub resolvers can be any resolver, including a chain. An attribute enable to indicate if the chain must be iterated after the first found or not (at least when asking for a latest revision). If the chain is iterated, then it's the latest among the ones found that is returned. If the chain is not iterated, then it's the first found which is returned.
+This resolver is only a container of a chain of other resolvers. The sub resolvers can be any resolver, including a chain. An attribute `enable` to indicate if the chain must be iterated after the first found or not (at least when asking for a latest revision). If the chain is iterated, then it's the latest among the ones found that is returned. If the chain is not iterated, then it's the first found which is returned.
== Attributes
@@ -35,7 +35,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Examples
-[source]
+[source, xml]
----
<chain name="test">
@@ -53,7 +53,7 @@ Both a filesystem and ivyrep will be used to look for ivy files. If a dynamic re
'''
-[source]
+[source, xml]
----
<chain name="test" returnFirst="true">
@@ -71,7 +71,7 @@ Same as before, except that if a revision is found in the filesystem then ivyrep
'''
-[source]
+[source, xml]
----
<chain name="test" dual="true">
@@ -84,4 +84,5 @@ Same as before, except that if a revision is found in the filesystem then ivyrep
----
-Same as first example, except that once a module is found by either filesystem or ivyrep, then it's the whole chain which will be queried to download the artifacts. So in this case ivy file and artifacts may be split across the two resolvers for the same module.
\ No newline at end of file
+Same as first example, except that once a module is found by either filesystem or ivyrep, then it's the whole chain which will be queried to download the artifacts. So in this case ivy file and artifacts may be split across the two resolvers for the same module.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/dual.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/dual.adoc b/asciidoc/resolver/dual.adoc
index 9459e6f..a12754f 100644
--- a/asciidoc/resolver/dual.adoc
+++ b/asciidoc/resolver/dual.adoc
@@ -1,4 +1,4 @@
-
+= Dual resolver
[]
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/filesystem.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/filesystem.adoc b/asciidoc/resolver/filesystem.adoc
index be9a992..c1e16e6 100644
--- a/asciidoc/resolver/filesystem.adoc
+++ b/asciidoc/resolver/filesystem.adoc
@@ -1,4 +1,4 @@
-
+= Filesystem resolver
[]
|=======
@@ -8,46 +8,43 @@
|=======
-
This resolver uses the file system to resolve ivy files and artifacts. An advantage of this resolver is that it usually provides very good performance. Moreover, it is easy to setup using basic OS file sharing mechanisms.
The configuration of such a resolver is mainly done through ivy and artifact patterns, indicating where ivy files and artifacts can be found in the file system. These patterns must be absolute paths (*__since 2.0__*). You can indicate a list of patterns which will be checked one after the other.
-*__since 1.3__* Using the m2compatible attribute, this resolver will convert dots found in organisation into slashes like maven2 does for groupId. For instance, it will transform the organisation from 'com.company' into 'com/company' when replacing the token [organisation] in your pattern.
-*Limitation*: in m2compatible mode, this resolver is not able list available organizations. It means some features like link:../use/repreport.html[repreport] are not available.
+*__since 1.3__* Using the `m2compatible` attribute, this resolver will convert dots found in organisation into slashes like maven2 does for groupId. For instance, it will transform the organisation from `com.company` into `com/company` when replacing the token `[organisation]` in your pattern.
+
+*Limitation*: in `m2compatible` mode, this resolver is not able list available organizations. It means some features like link:../use/repreport.html[repreport] are not available.
== Atomic publish support
*__since 2.0__* This resolver supports atomic publish, which is useful for environments with a lot of concurrent publish and resolve actions. The atomic publish relies on the atomicity of the rename operation in the underlying filesystem (which includes NTFS and POSIX based filesystems).
-In this case the resolver starts by publishing the module according to the pattern, but where a '.part' suffix is appended to the revision. Then the publish is committed with a rename to the final location.
+In this case the resolver starts by publishing the module according to the pattern, but where a `.part` suffix is appended to the revision. Then the publish is committed with a rename to the final location.
*Limitations*
Atomic publish is currently limited in several ways:
-* you need to use a pattern for both the artifact and the ivy files which uses the revision as a directory. For instance "${repository.dir}/[module]/[revision]/[artifact].[ext]" works, "${repository.dir}/[module]/[artifact]-[revision].[ext]" doesn't +
-
-* both the artifact and ivy pattern should have the same prefix until the [revision] token. +
-
-* overwrite during publish is not supported +
-
-* you should not use revision names ending with '.part' +
+ * you need to use a pattern for both the artifact and the ivy files which uses the revision as a directory. For instance `${repository.dir}/[module]/[revision]/[artifact].[ext]` works, `${repository.dir}/[module]/[artifact]-[revision].[ext]` doesn't +
+ * both the artifact and ivy pattern should have the same prefix until the `[revision]` token. +
-The *transactional* attribute can be used to configure the atomicity behavior:
+ * overwrite during publish is not supported +
+ * you should not use revision names ending with `.part` +
-* auto +
- use transaction if possible (according to limitation), otherwise don't
-* true +
- always use transaction, fail the build if a limitation is not fulfilled
+The `*transactional*` attribute can be used to configure the atomicity behavior:
-* false +
- don't use transaction at all
+ * auto +
+ use transaction if possible (according to limitation), otherwise don't
+ * true +
+ always use transaction, fail the build if a limitation is not fulfilled
+ * false +
+ don't use transaction at all
== Attributes
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/ibiblio.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/ibiblio.adoc b/asciidoc/resolver/ibiblio.adoc
index 4315fcd..1a1d917 100644
--- a/asciidoc/resolver/ibiblio.adoc
+++ b/asciidoc/resolver/ibiblio.adoc
@@ -1,4 +1,4 @@
-
+= Ibiblio resolver
[]
|=======
@@ -10,11 +10,11 @@
This resolver usually uses ibiblio to find artifacts.
-*__since 1.3__* Using the m2compatible attribute, you can benefit from maven 2 repository compatibility (convert dots in organisation into slashes, search for poms, use transitive dependencies of poms). This setting also affects the default place where the resolver looks for its artifacts to point to the maven2 repository. So setting this attribute to true is sufficient to use maven 2 ibiblio repository.
+*__since 1.3__* Using the `m2compatible` attribute, you can benefit from Maven2 repository compatibility (convert dots in organisation into slashes, search for poms, use transitive dependencies of poms). This setting also affects the default place where the resolver looks for its artifacts to point to the Maven2 repository. So setting this attribute to `true` is sufficient to use Maven2 ibiblio repository.
-*__since 1.4__* When using the m2compatible flag, you can disable the use of poms by setting the usepoms flag to false. It is then roughly equivalent to a url resolver configured like this:
+*__since 1.4__* When using the `m2compatible` flag, you can disable the use of poms by setting the usepoms flag to `false`. It is then roughly equivalent to a url resolver configured like this:
-[source]
+[source, xml]
----
<url name="test" m2compatible="true">
@@ -23,9 +23,9 @@ This resolver usually uses ibiblio to find artifacts.
----
-*__since 2.0__* When used in m2compatible mode with the default pattern, this resolver uses maven-metadata.xml files (if present) to list the revisions available on the repository. This is especially useful when using a maven specific proxy, which does not serve directory listing. This can be disabled by using the useMavenMetadata flag.
+*__since 2.0__* When used in `m2compatible` mode with the default pattern, this resolver uses `maven-metadata.xml` files (if present) to list the revisions available on the repository. This is especially useful when using a maven specific proxy, which does not serve directory listing. This can be disabled by using the `useMavenMetadata` flag.
-*Limitation*: in m2compatible mode, this resolver is not able list available organizations. It means some features like link:../use/repreport.html[repreport] are not available.
+*Limitation*: in `m2compatible` mode, this resolver is not able list available organizations. It means some features like link:../use/repreport.html[repreport] are not available.
== Attributes
@@ -47,24 +47,25 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Examples
-[source]
+[source, xml]
----
<ibiblio name="maven2" m2compatible="true"/>
----
-Defines a resolver called "maven2" using the maven 2 public repository to find module metadata (using maven 2 poms) and artifacts.
+Defines a resolver called `maven2` using the Maven2 public repository to find module metadata (using maven 2 poms) and artifacts.
'''
-[source]
+[source, xml]
----
<ibiblio name="maven" m2compatible="true" usepoms="false"/>
----
-Same as above, but doesn't use poms, only artifacts.
\ No newline at end of file
+Same as above, but doesn't use poms, only artifacts.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/ivyrep.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/ivyrep.adoc b/asciidoc/resolver/ivyrep.adoc
index 18c1d1d..7f51d7d 100644
--- a/asciidoc/resolver/ivyrep.adoc
+++ b/asciidoc/resolver/ivyrep.adoc
@@ -1,4 +1,4 @@
-
+= IvyRep resolver
[]
|=======
@@ -7,8 +7,7 @@
|Handle publish|no
|=======
-This resolver usually uses an URL based repository usually similar in structure to link:http://ivyrep.jayasoft.org/[ivyrep] to find ivy files, and ibiblio to find artifacts.
-It can also be configured to use other similar repositories.
+This resolver usually uses an URL based repository usually similar in structure to the, now defunct, `http://ivyrep.jayasoft.org/` repo, to find ivy files, and ibiblio to find artifacts. It can also be configured to use other similar repositories.
[NOTE]
@@ -37,11 +36,11 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Examples
-[source]
+[source, xml]
----
<ivyrep name="ivyrep" ivyroot="http://ivyrep.mycompany.com"/>
----
-Looks for ivy files on and ivyrep like web site located at http://ivyrep.mycompany.com.
\ No newline at end of file
+Looks for ivy files on and ivyrep like web site located at `http://ivyrep.mycompany.com`.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/jar.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/jar.adoc b/asciidoc/resolver/jar.adoc
index e5b31bc..a6b2038 100644
--- a/asciidoc/resolver/jar.adoc
+++ b/asciidoc/resolver/jar.adoc
@@ -1,4 +1,4 @@
-
+= Jar resolver
[]
|=======
@@ -8,14 +8,13 @@
|=======
-
*__since 2.3__*
This resolver uses a specified jar resolve ivy files and artifacts.
This kind of resolver helps the packaging of an entire repository. Since the entire "repository" jar is expected to be local at some point, the size of a such repository should be considered to be not too large if it is expected to be remote; hence the artifacts in a such repo should be little in size.
-The configuration of such a resolver is done via specifying the location of the jar, and through ivy and artifact patterns, indicating where ivy files and artifacts can be found in the jar. You can indicate a list of patterns which will be checked one after the other. Note that the patterns MUST NOT start with a slash.
+The configuration of such a resolver is done via specifying the location of the jar, and through ivy and artifact patterns, indicating where ivy files and artifacts can be found in the jar. You can indicate a list of patterns which will be checked one after the other. Note that the patterns *MUST NOT* start with a slash.
== Attributes
@@ -45,7 +44,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Examples
-[source]
+[source, xml]
----
<jar name="my-local-jar-resolver" file="/home/me/myrepo.jar">
@@ -60,7 +59,7 @@ A simple local jar repository.
'''
-[source]
+[source, xml]
----
<jar name="my-remote-jar-resolver" url="http://www.mywebsite.com/dist/myrepo.jar">
@@ -73,4 +72,5 @@ A simple local jar repository.
----
-A remote jar repository with multiple ivy and artifact patterns, patterns pointing in some sub directories in the jar.
\ No newline at end of file
+A remote jar repository with multiple ivy and artifact patterns, patterns pointing in some sub directories in the jar.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/mirrored.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/mirrored.adoc b/asciidoc/resolver/mirrored.adoc
index 32522c9..f9ab4e3 100644
--- a/asciidoc/resolver/mirrored.adoc
+++ b/asciidoc/resolver/mirrored.adoc
@@ -1,4 +1,4 @@
-
+= Mirrored resolver
[]
|=======
@@ -52,7 +52,7 @@ http://repo2.maven.org/maven2/
And the piece of settings:
-[source]
+[source, xml]
----
<mirroredurl name="mirrored-maven" m2compatible="true" mirrorListUrl="file:///Users/me/dev/repo/mavenrepolist.txt">
@@ -61,7 +61,7 @@ And the piece of settings:
----
-It will resolve first on the repo1 and if failing it will fall back on repo2.
+It will resolve first on the `repo1` and if failing it will fall back on `repo2`.
'''
@@ -69,7 +69,7 @@ It will resolve first on the repo1 and if failing it will fall back on repo2.
The mirror list can be retrieved from a geo-location aware url:
-[source]
+[source, xml]
----
<mirroredurl name="mirrored-asf" mirrorListUrl="http://www.apache.org/dyn/closer.cgi">
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/obr.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/obr.adoc b/asciidoc/resolver/obr.adoc
index d47b561..78ecf23 100644
--- a/asciidoc/resolver/obr.adoc
+++ b/asciidoc/resolver/obr.adoc
@@ -1,4 +1,4 @@
-
+= OSGi Bundle Repository
[]
|=======
@@ -31,16 +31,16 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
The requirement strategy is defining how the resolver should behave in front of several choices. In the OSGi dependency model, an `Import-Package` requirement can be satisfied by several different bundles. So when resolving such requirement, Ivy will first look into the already resolved bundles if one provides that package. If it fails to find one, then two behaviours can occur:
-* if the requirement strategy is `first`, among the bundles statifying the requirement, it will shoose the first one. A warn will be logged ahout the choice Ivy has to arbitrarily do. +
+ * if the requirement strategy is `first`, among the bundles statifying the requirement, it will shoose the first one. A warn will be logged ahout the choice Ivy has to arbitrarily do. +
-* if the requirement strategy is `noambiguity`, Ivy will make the resolution fail. +
+ * if the requirement strategy is `noambiguity`, Ivy will make the resolution fail. +
== Examples
-[source]
+[source, xml]
----
<obr name="felix-repo" repoXmlURL="http://felix.apache.org/obr/releases.xml" />
@@ -52,11 +52,12 @@ A simple repository configured to use the Felix OBR.
'''
-[source]
+[source, xml]
----
<obr name="my-osgi-repo" repoXmlFile="${ivy.settings.dir}/obr/obr.xml" requirementStrategy="first" />
----
-A local repository which is trusted to always provide correct dependency for the `Import-Package` requirements.
\ No newline at end of file
+A local repository which is trusted to always provide correct dependency for the `Import-Package` requirements.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/osgiagg.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/osgiagg.adoc b/asciidoc/resolver/osgiagg.adoc
index ffee874..1858703 100644
--- a/asciidoc/resolver/osgiagg.adoc
+++ b/asciidoc/resolver/osgiagg.adoc
@@ -1,4 +1,4 @@
-
+= Aggregate OSGi Repository
[]
|=======
@@ -12,7 +12,7 @@
This resolver is one of the resolver which supports link:../osgi.html[OSGi™] dependencies.
-This resolvers is like a classic link:[chain] resolver, but which better support OSGi metadata.
+This resolvers is like a classic link:../resolver/chain.html[chain] resolver, but which better support OSGi metadata.
== Attributes
@@ -22,13 +22,13 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Elements
-As sub element, this resolver accept any kind of OSGi resolver: link:../obr.html[obr], link:../updatesite.html[updatesite], or any other `osgi-agg`.
+As sub element, this resolver accept any kind of OSGi resolver: link:../resolver/obr.html[obr], link:../resolver/updatesite.html[updatesite], or any other `osgi-agg`.
== Examples
-[source]
+[source, xml]
----
<updatesite name="ivyde-updatesite" url="http://www.apache.org/dist/ant/ivyde/updatesite" />
@@ -40,4 +40,5 @@ As sub element, this resolver accept any kind of OSGi resolver: link:../obr.html
----
-An aggregated OSGi reporsory composed of the Apache IvyDE Eclipse update site and the Felix OBR.
\ No newline at end of file
+An aggregated OSGi reporsory composed of the Apache IvyDE Eclipse update site and the Felix OBR.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/packager.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/packager.adoc b/asciidoc/resolver/packager.adoc
index b5a6573..0165687 100644
--- a/asciidoc/resolver/packager.adoc
+++ b/asciidoc/resolver/packager.adoc
@@ -1,4 +1,4 @@
-
+= Packager resolver
[]
|=======
@@ -8,73 +8,29 @@
|=======
-
-
-
-
-
*__Since 2.0__*.
-
-
-
-
-
-
This resolver accesses ivy files and "packaging instructions" from an online "packager" repository. "Packager" repositories contain no actual artifacts. To get the artifacts, the packaging instructions are downloaded from the repository and executed locally. These instructions specify additional resource(s) to download and how to create the artifacts from them, for example, by downloading a project's original distribution archive directly from their web site and extracting the desired artifacts.
-
-
-
-
-
-
-Packager repositories allow the creation of Ivy repositories that require neither the participation of any of the modules' creators nor setting up a huge mirror site. One such repository on the web is link:http://ivyroundup.googlecode.com/[Ivy RoundUp]. Of course, private packager repositories are feasible as well.
-
-
-
-
-
+Packager repositories allow the creation of Ivy repositories that require neither the participation of any of the modules' creators nor setting up a huge mirror site.
The Packager resolver supports a "resource cache", where downloaded archives can be stored to avoid duplicate downloads. This cache is entirely separate from the link:../concept.html#cache[normal Ivy cache]: it is "private" to the Packager resolver, and it stores unmodified original software archives, not Ivy artifacts. See the `resourceCache` attribute below for details.
+The packaging instructions are contained in "packager.xml" in a simple XML format. At resolve time this file gets converted into a "build.xml" file via XSLT and then executed using link:https://ant.apache.org/[Ant]. Therefore, Ant must be available as an executable on the platform. The ant task executes in a separate ant project and so is not affected by properties, etc. that may be set in any existing ant environment in which Ivy is running. However, Ivy will define a few properties for convenience; see the "Properties" listed below.
+For security reasons, the XSLT transform ensures that
-
-
-
-The packaging instructions are contained in "packager.xml" in a simple XML format. At resolve time this file gets converted into a "build.xml" file via XSLT and then executed using link:http://ant.apache.org/[ant]. Therefore, ant must be available as an executable on the platform. The ant task executes in a separate ant project and so is not affected by properties, etc. that may be set in any existing ant environment in which Ivy is running. However, Ivy will define a few properties for convenience; see the "Properties" listed below.
-
-
-
-
-
-
-
-For security reasons, the XSLT transform ensures that (a) all downloaded archives have verified SHA1 checksums (including cached resources); and (b) only a very limited set of ant tasks can be performed during the artifact "build" phase; currently these include move, copy, mkdir, zip, unzip, tar, and untar (this restriction may be overridden however; see below).
-
-
-
-
-
+ a. all downloaded archives have verified SHA1 checksums (including cached resources); and
+
+ b. only a very limited set of ant tasks can be performed during the artifact "build" phase; currently these include move, copy, mkdir, zip, unzip, tar, and untar (this restriction may be overridden however; see below).
The Packager resolver is based on the link:url.html[URL resolver] and is configured similarly, except the artifact child tags specify where to find the packager.xml files, rather than the artifacts themselves.
-
-
-
-
-
-
Because the packaging process is relatively slow, it is important to use link:../concept.html#cache[Ivy's caching support] to avoid repeated execution of the packaging instructions.
-
-
-
-
== Attributes
This resolver shares the link:../settings/resolvers.html#common[common attributes] of standard resolvers, plus the following:
@@ -94,31 +50,13 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
-
-
-
-Setting a resourceURL will cause the resolver to override the URLs for resources specified by the packaging instructions. Instead, all resources will be downloaded from an URL constructed by first resolving the resourceURL pattern into a base URL, and then resolving the resource filename relative to that base URL. In other words, the resourceURL pattern specifies the URL "directory", so it should always end in a forward slash.
-
-
-
-
-
-
+Setting a `resourceURL` will cause the resolver to override the URLs for resources specified by the packaging instructions. Instead, all resources will be downloaded from an URL constructed by first resolving the resourceURL pattern into a base URL, and then resolving the resource filename relative to that base URL. In other words, the `resourceURL` pattern specifies the URL "directory", so it should always end in a forward slash.
If a resourceURL download fails, the resolver will fall back to the original URL from the packaging instructions.
-
-
-
-
-
-
Configure a resourceURL in situations where you don't want to rely on (or wait for) the web sites configured in the packaging instructions, and have access to a better (perhaps private) mirror site.
-
-
-
== Child elements
@@ -134,7 +72,7 @@ Configure a resourceURL in situations where you don't want to rely on (or wait f
== Examples
-[source]
+[source, xml]
----
<packager name="ivyroundup"
@@ -147,7 +85,7 @@ Configure a resourceURL in situations where you don't want to rely on (or wait f
----
-Defines a packager resolver which points to the link:http://ivyroundup.googlecode.com/[Ivy RoundUp] online repository. Builds will occur in a subdirectory of
+Defines a packager resolver which points to the `http://ivyroundup.googlecode.com/` online repository. Builds will occur in a subdirectory of
[source]
----
${user.home}/.ivy2/packager/build
@@ -171,19 +109,12 @@ will be tried first for all resources.
== Packaging Instructions
+The goal of the packaging instructions is to download the required archives, extract the artifacts, and put the artifacts into a subdirectory. Each artifact should be written to `artifacts/[type]s/[artifact].[ext]` when the ant build completes.
-The goal of the packaging instructions is to download the required archives, extract the artifacts, and put the artifacts into a subdirectory. Each artifact should be written to artifacts/[type]s/[artifact].[ext] when the ant build completes.
-
-
-
-
+Below is an example of packaging instructions for link:http://testng.org/[TestNG]:
-
-
-Below is an example of packaging instructions for link:http://testng.org/[TestNG 2.5]:
-
-[source]
+[source, xml]
----
<packager-module version="1.0">
@@ -327,7 +258,8 @@ The artifact children of m2resource tags support the following attributes:
|ext|Maven filename extension|No; defaults to "jar"
|classifier|Maven classifier (e.g., "sources", "javadoc")|No; defaults to none
|sha1|SHA1 checksum of the resource|Yes
-|dest|Defines the name of the subdirectory into which the artifact should be unpacked|Exactly one of "dest" or "tofile" must be supplied
+|dest|Defines the name of the subdirectory into which the artifact should be unpacked
+.2+|Exactly one of "dest" or "tofile" must be supplied
|tofile|Where to put the file; no extraction will be performed
|type|Type of archive: "zip", "jar", "war", "tar", "tgz", "tar.gz", "tar.bz2"|No; if not present, will be automatically determined from the filename suffix
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/sftp.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/sftp.adoc b/asciidoc/resolver/sftp.adoc
index 73528a7..681e11f 100644
--- a/asciidoc/resolver/sftp.adoc
+++ b/asciidoc/resolver/sftp.adoc
@@ -1,4 +1,4 @@
-
+= SFTP resolver
[]
|=======
@@ -7,16 +7,15 @@
|Handle publish|yes
|=======
+*__since 1.4__*
-
-
-This resolver can be used when your ivy repository is located on a server accessible via sftp. The secured nature of sftp and its widespread implementation on most *nix servers makes this resolver a very good candidate in an enterprise environment. *__since 1.4__*
+This resolver can be used when your ivy repository is located on a server accessible via sftp. The secured nature of sftp and its widespread implementation on most *nix servers makes this resolver a very good candidate in an enterprise environment.
If your server supports ssh but not sftp, there is also an link:../resolver/ssh.html[ssh resolver].
Note that sftp is also supported by vfs, so you can use a vfs resolver instead. The advantage of this resolver is that you have a better control over authentication, it can prompt for username/password credentials, or you can use private/public key authentication, which is not possible with the vfs resolver. When it prompts for username/password, it uses a Swing dialog, which is not possible in a headless environment. If you want to prompt for the credentials on the command line, use ant input task for example before calling ivy.
-All necessary connection parameters can be set here via attributes, or via an OpenSSH-style config file specified by sshConfig.
+All necessary connection parameters can be set here via attributes, or via an OpenSSH-style config file specified by `sshConfig`.
However all attributes defined in the pattern url of the resolver will have higher priority and will overwrite the values given here. To specify connection parameters in the pattern, you have to specify a full url and not just a path as pattern.
e.g. pattern="/path/to/my/repos/[artifact].[ext]" will use all connection parameters from this class
e.g. pattern="sftp://myserver.com/path/to/my/repos/[artifact].[ext]" will use all parameters from the attributes with the exception of the host, which will be "myserver.com"
@@ -26,7 +25,7 @@ e.g. pattern="sftp://user:geheim@myserver.com:8022/path/to/my/repos/[artifact].[
Note that the authentication features of this resolver are exactly the same as the ssh resolver. Choosing between the two is often a matter of server implementation. If your server supports sftp, usually it's preferrable.
-Internally this resolver relies on link:http://www.jcraft.com/jsch/[jsch] as ssh client, which is a popular java ssh client, used for example in eclipse.
+Internally this resolver relies on link:http://www.jcraft.com/jsch/[jsch] as ssh client, which is a popular java ssh client, used for example in Eclipse.
== Attributes
@@ -62,7 +61,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Example
-[source]
+[source, xml]
----
<sftp user="myuser" host="myhost.com">
@@ -77,7 +76,7 @@ Will connect to myhost.com using myuser and prompt for the password.
'''
-[source]
+[source, xml]
----
<sftp user="${myuser}" userPassword="${my.password}" host="myhost.com">
@@ -92,7 +91,7 @@ Will connect to myhost.com using user and password provided with ivy variables.
'''
-[source]
+[source, xml]
----
<sftp>
@@ -107,7 +106,7 @@ Will connect to yourserver.com on port 8022 with user 'user' and password 'gehei
'''
-[source]
+[source, xml]
----
<sftp keyFile="path/to/key/file" keyFilePassword="${password}">
@@ -117,10 +116,10 @@ Will connect to yourserver.com on port 8022 with user 'user' and password 'gehei
----
-Will connect to yourserver.com on port 8022 with user 'user' and use keyFile path/to/key/file for keyFile and the value of password variable for keyFilePassword authentication for ivy files, and to myserver.com on port 8022 using user 'user' with the same keyFile/keyFilePassword pair for the artifacts.
+Will connect to yourserver.com on port 8022 with user 'user' and use keyFile `path/to/key/file` for `keyFile` and the value of password variable for `keyFilePassword` authentication for ivy files, and to myserver.com on port 8022 using user 'user' with the same keyFile/keyFilePassword pair for the artifacts.
-[source]
+[source, xml]
----
<sftp host="myhost" sshConfig="/path/to/.ssh/config">
@@ -130,4 +129,5 @@ Will connect to yourserver.com on port 8022 with user 'user' and use keyFile pat
----
-Will connect to the host named by myhost according to the config file in /path/to/.ssh/config, using the hostname, username, and optionally IdentityFile specified in the config section "Host myhost". For example, if the corresponding Host section contains "Hostname yourserver.com" and "User myremoteusername", it will connect to yourserver.com using username myremoteusername.
\ No newline at end of file
+Will connect to the host named by myhost according to the config file in `/path/to/.ssh/config`, using the hostname, username, and optionally IdentityFile specified in the config section "Host myhost". For example, if the corresponding Host section contains "Hostname yourserver.com" and "User myremoteusername", it will connect to yourserver.com using username myremoteusername.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/ssh.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/ssh.adoc b/asciidoc/resolver/ssh.adoc
index 2b01dcf..0e265f3 100644
--- a/asciidoc/resolver/ssh.adoc
+++ b/asciidoc/resolver/ssh.adoc
@@ -1,4 +1,4 @@
-
+= SSH resolver
[]
|=======
@@ -7,10 +7,9 @@
|Handle publish|yes
|=======
+*__since 1.4__*
-
-
-This resolver can be used when your ivy repository is located on a server accessible via ssh. The secured nature of ssh and its widespread implementation on most *nix servers makes this resolver a very good candidate in an enterprise environment. *__since 1.4__*
+This resolver can be used when your ivy repository is located on a server accessible via ssh. The secured nature of ssh and its widespread implementation on most *nix servers makes this resolver a very good candidate in an enterprise environment.
If your server supports sftp, you can consider using the link:../resolver/sftp.html[sftp resolver].
@@ -51,7 +50,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Example
-[source]
+[source, xml]
----
<ssh user="myuser" host="myhost.com">
@@ -66,7 +65,7 @@ Will connect to myhost.com using myuser and prompt for the password.
'''
-[source]
+[source, xml]
----
<ssh keyFile="path/to/key/file" keyFilePassword="${password}">
@@ -76,10 +75,10 @@ Will connect to myhost.com using myuser and prompt for the password.
----
-Will connect to yourserver.com on port 8022 with user geheim and use keyFile path/to/key/file for keyFile and the value of password variable for keyFilePassword authentication for ivy files, and to myserver.com on port 8022 using user geheim with the same keyFile/keyFilePassword pair for the artifacts.
+Will connect to yourserver.com on port 8022 with user geheim and use `path/to/key/file` for `keyFile` and the value of password variable for `keyFilePassword` authentication for ivy files, and to myserver.com on port 8022 using user geheim with the same keyFile/keyFilePassword pair for the artifacts.
-[source]
+[source, xml]
----
<ssh host="myhost" sshConfig="/path/to/.ssh/config">
@@ -89,4 +88,4 @@ Will connect to yourserver.com on port 8022 with user geheim and use keyFile pat
----
-Will connect to the host named by myhost according to the config file in /path/to/.ssh/config, using the hostname, username, and optionally IdentityFile specified in the config section "Host myhost". For example, if the corresponding Host section contains "Hostname yourserver.com" and "User myremoteusername", it will connect to yourserver.com using username myremoteusername.
\ No newline at end of file
+Will connect to the host named by myhost according to the config file in `/path/to/.ssh/config`, using the hostname, username, and optionally IdentityFile specified in the config section "Host myhost". For example, if the corresponding Host section contains "Hostname yourserver.com" and "User myremoteusername", it will connect to yourserver.com using username myremoteusername.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/updatesite.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/updatesite.adoc b/asciidoc/resolver/updatesite.adoc
index 323deca..b5d5597 100644
--- a/asciidoc/resolver/updatesite.adoc
+++ b/asciidoc/resolver/updatesite.adoc
@@ -1,4 +1,4 @@
-
+= Eclipse Updatesite resolver
[]
|=======
@@ -33,20 +33,20 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
The requirement strategy is defining how the resolver should behave in front of several choices. In the OSGi dependency model, an `Import-Package` requirement can be satisfied by several different bundles. So when resolving such requirement, Ivy will first look into the already resolved bundles if one provides that package. If it fails to find one, then two behaviours can occur:
-* if the requirement strategy is `first`, among the bundles statifying the requirement, it will shoose the first one. A warn will be logged ahout the choice Ivy has to arbitrarily do. +
+ * if the requirement strategy is `first`, among the bundles statifying the requirement, it will shoose the first one. A warn will be logged ahout the choice Ivy has to arbitrarily do. +
-* if the requirement strategy is `noambiguity`, Ivy will make the resolution fail. +
+ * if the requirement strategy is `noambiguity`, Ivy will make the resolution fail. +
== Examples
-[source]
+[source, xml]
----
<updatesite name="ivyde-updatesite" url="http://www.apache.org/dist/ant/ivyde/updatesite" />
----
-A simple repository configured to load the Apache IvyDE Eclipse update site.
\ No newline at end of file
+A simple repository configured to load the Apache IvyDE Eclipse update site.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/url.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/url.adoc b/asciidoc/resolver/url.adoc
index 047391a..c730a4c 100644
--- a/asciidoc/resolver/url.adoc
+++ b/asciidoc/resolver/url.adoc
@@ -1,4 +1,4 @@
-
+= URL resolver
[]
|=======
@@ -8,11 +8,9 @@
|=======
-
-
This resolver is one of the most generic. In fact, most of the previous resolvers can be obtained by a particular configuration of this one. Indeed it uses urls to find ivy files and artifacts. The urls it uses are defined through ivy and artifact children, each giving a pattern to find ivy files or artifacts.
-*Limitation*: in m2compatible mode, this resolver is not able list available organizations. It means some features like link:../use/repreport.html[repreport] are not available.
+*Limitation*: in `m2compatible` mode, this resolver is not able list available organizations. It means some features like link:../use/repreport.html[repreport] are not available.
== Attributes
@@ -41,7 +39,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Example
-[source]
+[source, xml]
----
<url name="two-patterns-example">
@@ -52,4 +50,4 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
----
-Looks for ivy files in one place and for artifacts in two places: with or without revision in name (revision being already in the directory structure).
\ No newline at end of file
+Looks for ivy files in one place and for artifacts in two places: with or without revision in name (revision being already in the directory structure).
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/resolver/vfs.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/resolver/vfs.adoc b/asciidoc/resolver/vfs.adoc
index 1044f5c..eedbe4d 100644
--- a/asciidoc/resolver/vfs.adoc
+++ b/asciidoc/resolver/vfs.adoc
@@ -1,4 +1,4 @@
-
+= VFS resolver
[]
|=======
@@ -7,12 +7,8 @@
|Handle publish|depend on vfs capacity, usually yes
|=======
-
-
This resolver is certainly the most capable, since it relies on link:http://jakarta.apache.org/commons/vfs/[Apache commons VFS], which gives an uniform access to link:http://jakarta.apache.org/commons/vfs/filesystems.html[a good number of file systems], including ftp, webdav, zip, ... *__since 1.4__*
-__Note: commons vfs has not released a stable version yet, hence Ivy relies on a nightly build. Stability should thus be considered carefully before using this resolver in a production environment__
-
== Attributes
@@ -33,7 +29,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
== Example
-[source]
+[source, xml]
----
<vfs name="vfs-resolver">
@@ -43,4 +39,5 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
----
-Access ivy and artifacts files using sftp.
\ No newline at end of file
+Access ivy and artifacts files using sftp.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings.adoc b/asciidoc/settings.adoc
index a3e21d5..f03e584 100644
--- a/asciidoc/settings.adoc
+++ b/asciidoc/settings.adoc
@@ -1,11 +1,12 @@
+= Ivy Settings
In order to work as you want, ivy sometimes needs some settings. Actually, ivy can work with no specific settings at all, see the link:tutorial/defaultconf.html[default settings documentation] for details about that. But ivy is able to work in very different contexts. You just have to configure it properly.
-Settings are specified through an xml file, usually called ivysettings.xml. To configure ivy from ant, you just have to use the link:use/settings.html[settings] datatype with the path of your settings file.
+Settings are specified through an xml file, usually called `ivysettings.xml`. To configure ivy from ant, you just have to use the link:use/settings.html[settings] datatype with the path of your settings file.
Here is an example of the settings file:
-[source]
+[source, xml]
----
<ivysettings>
@@ -25,13 +26,12 @@ Here is an example of the settings file:
</ivysettings>
----
-
+__Note: To work, this settings file needs a property file named ivysettings-file.properties in the same directory as the settings file, with ivy variables you want in it.__
Mainly, the settings enable you to configure the default cache directory used by ivy and the dependency resolvers that it will use to resolve dependencies.
-__Note: To work, this settings file needs a property file named ivysettings-file.properties in the same directory as the settings file, with ivy variables you want in it.__
-Some useful variables are available in settings files:
+Some useful variables are available for use in settings files:
* ivy.settings.dir +
@@ -44,14 +44,13 @@ Some useful variables are available in settings files:
the URL pointing to the settings file. This is set both when it has been loaded as a file or a URL
-*__since 1.4__* Note that all link:http://java.sun.com/j2se/1.4.2/docs/api/java/lang/System.html#getProperties()[java system properties] are available as ivy variables in your settings file.
+*__since 1.4__* Note that all link:https://docs.oracle.com/javase/7/docs/api/java/lang/System.html#getProperties()[Java system properties] are available as ivy variables in your settings file.
== Settings file structure
-The settings file is structured in some parts and left open in others. Indeed, each resolver has its own structure, thus it's not the settings file itself which defines the structure for the resolvers.
-
+The settings file is structured in some parts and left open in others. In fact, each resolver has its own structure, thus it's not the settings file itself which defines the structure for the resolvers.
[source]
----
@@ -95,8 +94,6 @@ ivysettings
----
-
-
== ivysettings
*Tag:* ivysettings
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/caches.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/caches.adoc b/asciidoc/settings/caches.adoc
index 67b9730..0972b9f 100644
--- a/asciidoc/settings/caches.adoc
+++ b/asciidoc/settings/caches.adoc
@@ -1,18 +1,21 @@
+= caches
*Tag:* caches
Configures the Ivy cache system. *__since 2.0__*.
+
+
See link:../concept.html#cache[cache concept] for details on the Ivy cache concept.
-By default, Ivy defines one repository cache instance, called 'default-cache', which uses the default cache settings defined using attributes on this tag. This default instance is defined as long as you don't define your own default cache using the 'default' attribute, and have at least one dependency resolver which doesn't specify which cache instance to use.
+By default, Ivy defines one repository cache instance, called `default-cache`, which uses the default cache settings defined using attributes on this tag. This default instance is defined as long as you don't define your own default cache using the `default` attribute, and have at least one dependency resolver which doesn't specify which cache instance to use.
-_defaultCacheDir_ is the default directory used for both the resolution and repository cache(s). It usually points to a directory in your filesystem. If you want to isolate resolution cache from repository cache, we recommend setting both the resolutionCacheDir and repositoryCacheDir attributes on this tag instead of using defaultCacheDir.
+`defaultCacheDir` is the default directory used for both the resolution and repository cache(s). It usually points to a directory in your filesystem. If you want to isolate resolution cache from repository cache, we recommend setting both the `resolutionCacheDir` and `repositoryCacheDir` attributes on this tag instead of using `defaultCacheDir`.
Since repository cache implementations are pluggable, you can either define new cache instances based on the default implementation provided in Ivy using the link:../settings/caches/cache.html[cache] child element, or use custom cache implementations using child elements as you have defined using link:../settings/typedef.html[typedef].
-_ivyPattern_ and _artifactPattern_ are used to configure the default way Ivy stores ivy files and artifacts in repository cache(s). Usually you do not have to change this, unless you want to use the cache directly from another tool, which is not recommended. These patterns are relative to the repository cache base directory.
+`ivyPattern` and `artifactPattern` are used to configure the default way Ivy stores ivy files and artifacts in repository cache(s). Usually you do not have to change this, unless you want to use the cache directly from another tool, which is not recommended. These patterns are relative to the repository cache base directory.
-_checkUpToDate_ indicates to ivy if it must check date of artifacts before retrieving them (i.e. copying them from
+`checkUpToDate` indicates to ivy if it must check date of artifacts before retrieving them (i.e. copying them from
cache to another place in your filesystem). Usually it is a good thing to check date to avoid unnecessary copy, even if it's most of the time a local copy.
@@ -49,7 +52,7 @@ cache to another place in your filesystem). Usually it is a good thing to check
== Examples
-[source]
+[source, xml]
----
<caches>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/caches/cache.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/caches/cache.adoc b/asciidoc/settings/caches/cache.adoc
index e88fb61..6dbc837 100644
--- a/asciidoc/settings/caches/cache.adoc
+++ b/asciidoc/settings/caches/cache.adoc
@@ -1,3 +1,4 @@
+= cache
*Tag:* cache
@@ -43,7 +44,7 @@ To know if an artifact is local ivy asks to the resolver. Only filesystem resolv
== Examples
-[source]
+[source, xml]
----
<cache name="mycache"
@@ -60,6 +61,5 @@ To know if an artifact is local ivy asks to the resolver. Only filesystem resolv
----
-Defines a cache called 'mycache', storing files in the '/path/to/mycache' directory using '[module]/ivy-[revision].xml' as pattern to store Ivy files and '[module]/[artifact]-[revision].[ext]' as pattern to store other artifacts.
-The lock strategy used by this cache is the 'no-lock' strategy, which does not perform any locking.
-The defaultTTL used is of 1s, meaning that by default dynamic revision result will be stored and used for one second. TTL rules then define that all 'latest.integration' revisions will be stored and used for 200ms, while other dynamic revisions from org1 org2 and org3 modules will be stored respectively for 10 minutes 20 seconds; 5 hours; and 2 days and 12 hours.
\ No newline at end of file
+Defines a cache called `mycache`, storing files in the `/path/to/mycache` directory using `[module]/ivy-[revision].xml` as pattern to store Ivy files and `[module]/[artifact]-[revision].[ext]` as pattern to store other artifacts. The lock strategy used by this cache is the `no-lock` strategy, which does not perform any locking. The defaultTTL used is of 1s, meaning that by default dynamic revision result will be stored and used for one second. TTL rules then define that all `latest.integration` revisions will be stored and used for 200ms, while other dynamic revisions from `org1` `org2` and `org3` modules will be stored respectively for 10 minutes 20 seconds; 5 hours; and 2 days and 12 hours.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/caches/ttl.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/caches/ttl.adoc b/asciidoc/settings/caches/ttl.adoc
index 0ba6d7e..43b20a6 100644
--- a/asciidoc/settings/caches/ttl.adoc
+++ b/asciidoc/settings/caches/ttl.adoc
@@ -1,11 +1,14 @@
+= ttl
*Tag:* ttl
-*__Since 2.0__* Defines a TTL (Time To Live) rule for resolved revision caching.
+*__Since 2.0__*
-When Ivy resolves a dynamic version constraint (like latest.integration or a version range), it can store the result of the resolution (like latest.integration=1.5.1) for a given time, called TTL. It means that Ivy will reuse this dynamic revision resolution result without accessing the repositories for the duration of the TTL, unless running link:../../use/resolve.html[resolve] in refresh mode.
+Defines a TTL (Time To Live) rule for resolved revision caching.
-This tag let you define a rule to define a TTL specific to a set of dynamic revision, based on the whole module revision information (organization, module name, revision, ...). The revision considered in the rule is the revision before the resolution (for instance 'latest.integration') and not the resolved revision (for instance '1.5.1').
+When Ivy resolves a dynamic version constraint (like `latest.integration` or a version range), it can store the result of the resolution (like `latest.integration=1.5.1`) for a given time, called TTL. It means that Ivy will reuse this dynamic revision resolution result without accessing the repositories for the duration of the TTL, unless running link:../../use/resolve.html[resolve] in refresh mode.
+
+This tag let you define a rule to define a TTL specific to a set of dynamic revision, based on the whole module revision information (organization, module name, revision, ...). The revision considered in the rule is the revision before the resolution (for instance `latest.integration`) and not the resolved revision (for instance `1.5.1`).
The rules are evaluated in order, the first matching rule being used to define the TTL. If no rule matches, the cache defaultTTL will be used.
@@ -20,7 +23,7 @@ XXd XXh XXm XXs XXXms
Where 'd' stands for days, 'h' for hours, 'm' for minutes, 's' for seconds and 'ms' for milliseconds. Any part of the specification can be omitted, so '12d', '2h 5m' and '1d 5ms' are all valid.
-The TTL duration can also be set to 'eternal', in which case once resolved the revision is always use, except when resolving in refresh mode.
+The TTL duration can also be set to `eternal`, in which case once resolved the revision is always use, except when resolving in refresh mode.
Using a 0ms TTL disable resolved revision caching for the given rule.
@@ -38,3 +41,5 @@ Using a 0ms TTL disable resolved revision caching for the given rule.
|matcher|the link:../../concept.html#matcher[matcher] to use to match the modules to which the resolver should be applied|No, defaults to exact
|duration|the TTL to apply (see above for format)|Yes
|=======
+
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/classpath.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/classpath.adoc b/asciidoc/settings/classpath.adoc
index 18953ef..ccd72fa 100644
--- a/asciidoc/settings/classpath.adoc
+++ b/asciidoc/settings/classpath.adoc
@@ -1,3 +1,4 @@
+= classpath
*Tag:* classpath
@@ -20,7 +21,7 @@ This let you add ivy plugins without relying on an external classpath (the ant c
== Examples
-[source]
+[source, xml]
----
<ivysettings>
@@ -39,7 +40,7 @@ Adds the custom-resolver.jar (found in the same directory as the ivysettings.xml
'''
-[source]
+[source, xml]
----
<ivysettings>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/conflict-managers.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/conflict-managers.adoc b/asciidoc/settings/conflict-managers.adoc
index 40bd560..68d5fac 100644
--- a/asciidoc/settings/conflict-managers.adoc
+++ b/asciidoc/settings/conflict-managers.adoc
@@ -1,53 +1,54 @@
+= conflict-managers
*Tag:* conflict-managers
Defines a list of link:../concept.html#conflict[conflicts managers] usable in Ivy. Each conflict manager is identified by its name, given as an attribute.
-The child tag used for the conflict manager must be equal to a name of a conflict manager type (either built-in or added with the typedef tag).
+The child tag used for the conflict manager must be equal to a name of a conflict manager type (either built-in or added with the `typedef` tag).
Here is a list of built-in conflicts managers (which do not require anything in the configuration file):
-* all +
- this conflicts manager resolve conflicts by selecting all revisions. Also called the NoConflictManager, it doesn't evict any modules.
+ * all +
+ this conflicts manager resolve conflicts by selecting all revisions. Also called the `NoConflictManager`, it doesn't evict any modules.
-* latest-time +
- this conflict manager selects only the 'latest' revision, latest being defined as the latest in time. Note that latest in time is costly to compute, so prefer latest-revision if you can.
+ * latest-time +
+ this conflict manager selects only the `latest` revision, latest being defined as the latest in time. Note that latest in time is costly to compute, so prefer latest-revision if you can.
-* latest-revision +
- this conflict manager selects only the 'latest' revision, latest being defined by a string comparison of revisions.
+ * latest-revision +
+ this conflict manager selects only the `latest` revision, latest being defined by a string comparison of revisions.
-* latest-compatible +
- this conflict manager selects the latest version in the conflicts which can result in a compatible set of dependencies. This means that in the end, this conflict manager does not allow any conflicts (similar to the strict conflict manager), except that it follows a best effort strategy to try to find a set of compatible modules (according to the version constraints)
+ * latest-compatible +
+ this conflict manager selects the latest version in the conflicts which can result in a compatible set of dependencies. This means that in the end, this conflict manager does not allow any conflicts (similar to the strict conflict manager), except that it follows a best effort strategy to try to find a set of compatible modules (according to the version constraints)
-* strict +
- this conflict manager throws an exception (i.e. causes a build failure) whenever a conflict is found.
+ * strict +
+ this conflict manager throws an exception (i.e. causes a build failure) whenever a conflict is found.
The two "latest" conflict managers also take into account the force attribute of the dependencies.
-Indeed direct dependencies can declare a force attribute (see link:../ivyfile/dependency.html[dependency]), which indicates that the revision given in the direct dependency should be preferred over indirect dependencies.
+In fact direct dependencies can declare a force attribute (see link:../ivyfile/dependency.html[dependency]), which indicates that the revision given in the direct dependency should be preferred over indirect dependencies.
Here is a list of conflict manager types available, which can be used to define your own custom conflict managers:
-* latest-cm +
-The latest conflict manager uses a latest strategy to select the latest revision among several ones. Both latest-time and latest-revision conflict managers are based on this conflict manager type. It takes 'latest' as attribute to define which latest strategy should be used. Example:
+ * latest-cm +
+ The latest conflict manager uses a latest strategy to select the latest revision among several ones. Both `latest-time` and `latest-revision` conflict managers are based on this conflict manager type. It takes `latest` as attribute to define which latest strategy should be used. Example:
-[source]
+[source, xml]
----
<latest-cm name="mylatest-conflict-manager" latest="my-latest-strategy"/>
----
-* compatible-cm +
-The latest compatible conflict manager uses a latest strategy to select the latest revision among several ones. It takes 'latest' as an attribute to define which latest strategy should be used. Example:
+ * compatible-cm +
+ The latest compatible conflict manager uses a latest strategy to select the latest revision among several ones. It takes `latest` as an attribute to define which latest strategy should be used. Example:
-[source]
+[source, xml]
----
<compatible-cm name="my-latest-compatible-conflict-manager" latest="my-latest-strategy"/>
----
-* regexp-cm +
-This conflict manager is based on a regular expression and throws an exception (i.e. causes a build failure) when a conflict is found with versions with different matching group. For instance if a conflict is found between 1.2.x and 1.3.y it will throw an exception if the regular expression is (.*)\.\d, because the matching group will match different strings (1.2 and 1.3). 1.2.1 and 1.2.2 won't throw an exception with the same regular expression. The regular expression is set using the 'regexp' attribute. A 'ignoreNonMatching' attribute can also be set to simply warn when a version is found which does not match the regular expression, instead of throwing an exception.
+ * regexp-cm +
+ This conflict manager is based on a regular expression and throws an exception (i.e. causes a build failure) when a conflict is found with versions with different matching group. For instance if a conflict is found between 1.2.x and 1.3.y it will throw an exception if the regular expression is `(.*)\.\d`, because the matching group will match different strings (1.2 and 1.3). 1.2.1 and 1.2.2 won't throw an exception with the same regular expression. The regular expression is set using the `regexp` attribute. A `ignoreNonMatching` attribute can also be set to simply warn when a version is found which does not match the regular expression, instead of throwing an exception.
@@ -59,3 +60,4 @@ This conflict manager is based on a regular expression and throws an exception (
|Element|Description|Cardinality
|any conflict manager|adds a conflict manager to the list of available conflict managers|0..n
|=======
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/credentials.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/credentials.adoc b/asciidoc/settings/credentials.adoc
index a39b452..910db81 100644
--- a/asciidoc/settings/credentials.adoc
+++ b/asciidoc/settings/credentials.adoc
@@ -1,3 +1,4 @@
+= credentials
*Tag:* credentials
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/include.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/include.adoc b/asciidoc/settings/include.adoc
index 0deebcb..9a627a7 100644
--- a/asciidoc/settings/include.adoc
+++ b/asciidoc/settings/include.adoc
@@ -1,15 +1,11 @@
+= include
*Tag:* include
Includes another ivysettings file as if it were part of this one. *__since 1.3__*
-The included ivysettings file has to be a complete well formed ivysettings file, i.e. it does have to include the
-[source]
-----
-<ivysettings>
-----
-tag.
+The included ivysettings file has to be a complete well formed ivysettings file, i.e. it does have to include the `<ivysettings>` tag.
== Attributes
@@ -27,7 +23,7 @@ tag.
== Examples
-[source]
+[source, xml]
----
<ivysettings>
@@ -40,7 +36,7 @@ tag.
with ivysettings-default.xml:
-[source]
+[source, xml]
----
<ivysettings>
@@ -52,12 +48,12 @@ with ivysettings-default.xml:
----
-The included ivysettings defines a resolver named default, which is an ivyrep resolver, with its root configured as being the value of myrepository variable. This variable is given the value path/to/rep in the included file, but because the attribute overwrite is set to false, it will not override the value given in the main ivysettings including this one, so the value used for myrepository will be path/to/my/real/rep.
+The included ivysettings defines a resolver named default, which is an ivyrep resolver, with its root configured as being the value of myrepository variable. This variable is given the value `path/to/rep` in the included file, but because the attribute overwrite is set to false, it will not override the value given in the main ivysettings including this one, so the value used for myrepository will be `path/to/my/real/rep`.
'''
-[source]
+[source, xml]
----
<ivysettings>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/latest-strategies.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/latest-strategies.adoc b/asciidoc/settings/latest-strategies.adoc
index c514047..9e68102 100644
--- a/asciidoc/settings/latest-strategies.adoc
+++ b/asciidoc/settings/latest-strategies.adoc
@@ -1,19 +1,20 @@
+= Latest strategies
*Tag:* latest-strategies
Defines a list of link:../concept.html#latest[latest strategies] usable in Ivy. Each latest strategy is identified by its name, given as an attribute.
-The child tag used for the latest strategy must be equal to a name of a latest strategy type (usually added with the typedef tag).
+
+The child tag used for the latest strategy must be equal to a name of a latest strategy type (usually added with the `typedef` tag).
The latest strategies which are included in Ivy by default are:
* latest-time +
- compares the revisions date to know which is the latest. While this is often a good strategy in terms of pertinence, it's drawback is that it can be slow when dealing with remote repositories. If you use ivyrep,
-for example, Ivy has to ask the http server for the date of each ivy file before knowing which is the latest.
+ compares the revisions date to know which is the latest. While this is often a good strategy in terms of pertinence, it's drawback is that it can be slow when dealing with remote repositories. If you use ivyrep, for example, Ivy has to ask the http server for the date of each ivy file before knowing which is the latest.
* latest-revision +
compares the revisions as strings, using an algorithm close to the one used in php's version_compare function.
-This algorithm takes into account the special meaning of some text. For instance, with this strategy, 1.0-dev1 is considered before 1.0-alpha1, which in turn is before 1.0-rc1, which is before 1.0, which is before 1.0.1.
+This algorithm takes into account the special meaning of some text. For instance, with this strategy, `1.0-dev1` is considered before `1.0-alpha1`, which in turn is before `1.0-rc1`, which is before `1.0`, which is before `1.0.1`.
* latest-lexico +
compares the revisions as strings, using lexicographic order (the one used by java string comparison).
@@ -37,7 +38,7 @@ This algorithm takes into account the special meaning of some text. For instance
Here is an example of how you can do so:
-[source]
+[source, xml]
----
<latest-strategies>
@@ -52,7 +53,7 @@ Here is an example of how you can do so:
Knowing that the default "special meaning" words are the following:
-[source]
+[source, xml]
----
<specialMeaning name="dev" value="-1"/>
@@ -61,10 +62,10 @@ Knowing that the default "special meaning" words are the following:
----
-You can even remove or redefine the default special meanings by setting usedefaultspecialmeanings="false" on the latest-revision tag.
+You can even remove or redefine the default special meanings by setting `usedefaultspecialmeanings="false"` on the `latest-revision` tag.
Example:
-[source]
+[source, xml]
----
<latest-strategies>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/lock-strategies.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/lock-strategies.adoc b/asciidoc/settings/lock-strategies.adoc
index c53a0d8..8edef4d 100644
--- a/asciidoc/settings/lock-strategies.adoc
+++ b/asciidoc/settings/lock-strategies.adoc
@@ -1,9 +1,13 @@
+= Lock Strategies
+
+*Tag:* lock-strategies
+
+*__since 2.0__*
-*Tag:* lock-strategies *__since 2.0__*
Defines a list of lock strategies usable in Ivy.
-A lock strategy is used by a cache manager to decide when and how locking should be performed (see settings/cache to see how to configure the lock strategy to use).
+A lock strategy is used by a cache manager to decide when and how locking should be performed (see link:../settings/cache[caches] to see how to configure the lock strategy to use).
The following strategies are registered by default:
@@ -14,14 +18,14 @@ The following strategies are registered by default:
* *artifact-lock* +
This strategy acquires a lock whenever a module descriptor or an artifact is downloaded to the cache, which makes a good solution when you want to share your repository cache.
-Note that this strategy is based on file locking, performed by default using the java.io.File.createNewFile() atomicity (which is documented as atomic in the javadoc, but not recommended to perform locks).
+Note that this strategy is based on file locking, performed by default using the `java.io.File.createNewFile()` atomicity (which is documented as atomic in the javadoc, but not recommended to perform locks).
-* *artifact-lock-nio (*__since 2.4__*)* +
- Like the __artifact-lock__-strategy, this one also acquires a lock whenever a module descriptor or artifact is downloaded to the cache. But here the implementation is done with a java.nio.FileLock.
+* *artifact-lock-nio (__since 2.4__)* +
+ Like the `artifact-lock` strategy, this one also acquires a lock whenever a module descriptor or artifact is downloaded to the cache. But here the implementation is done with a `java.nio.FileLock`.
-The child tag used for the lock strategy must be equal to a name of a lock strategy type (added with the typedef tag).
+The child tag used for the lock strategy must be equal to a name of a lock strategy type (added with the `typedef` tag).
== Child elements
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/macrodef.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/macrodef.adoc b/asciidoc/settings/macrodef.adoc
index 096843e..9f55784 100644
--- a/asciidoc/settings/macrodef.adoc
+++ b/asciidoc/settings/macrodef.adoc
@@ -1,9 +1,10 @@
+= macrodef
*Tag:* macrodef
Defines a new dependency resolver type based upon another. This definition is very similar to the macrodef feature of ant for defining macro tasks. *__since 1.3__*
-This task eases the process of creating a new dependency resolver, because it avoids writing java code.
+This task eases the process of creating a new dependency resolver, because it avoids writing Java code.
It is generally used in combination with the link:../settings/include.html[include] feature to help reuse a macro in multiple settings files.
@@ -22,16 +23,16 @@ Since you can use the same macro several times it can define several resolvers (
Here is how Ivy deals with the names of the resolvers defined in a macro:
-* if there is no name attribute on a resolver in the macrodef, then Ivy will use the name given when using the macro. This is what usually should be done for the main resolver defined in the macro +
+ * if there is no name attribute on a resolver in the macrodef, then Ivy will use the name given when using the macro. This is what usually should be done for the main resolver defined in the macro
-* if there is a name attribute on a resolver in the macrodef, but this name doesn't contain a @{name} inside, then Ivy will use the provided name prefixed with the name of the macro separated by a dash +
+ * if there is a name attribute on a resolver in the macrodef, but this name doesn't contain a `@{name}` inside, then Ivy will use the provided name prefixed with the name of the macro separated by a dash
-* if there is a name attribute on a resolver in the macrodef, and this name contains @{name} somewhere, then Ivy will use this name, and replace @{name} with the name provided when using the macro. +
+ * if there is a name attribute on a resolver in the macrodef, and this name contains `@{name}` somewhere, then Ivy will use this name, and replace `@{name}` with the name provided when using the macro.
Example:
-[source]
+[source, xml]
----
<ivysettings>
@@ -52,7 +53,7 @@ Example:
This is equivalent to:
-[source]
+[source, xml]
----
<ivysettings>
@@ -96,7 +97,7 @@ This is equivalent to:
Defining a simple macro:
-[source]
+[source, xml]
----
<macrodef name="mymacro">
@@ -111,7 +112,7 @@ Defining a simple macro:
Using it:
-[source]
+[source, xml]
----
<resolvers>
@@ -125,7 +126,7 @@ Using it:
A complete example:
-[source]
+[source, xml]
----
<ivysettings>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/macrodef/attribute.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/macrodef/attribute.adoc b/asciidoc/settings/macrodef/attribute.adoc
index fca0465..54b937b 100644
--- a/asciidoc/settings/macrodef/attribute.adoc
+++ b/asciidoc/settings/macrodef/attribute.adoc
@@ -1,7 +1,8 @@
+= attribute
*Tag:* attribute
-Defines a macrodef attribute. See macrodef for details.
+Defines a macrodef attribute. See link:../macrodef.html[macrodef] for details.
== Attributes
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/module.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/module.adoc b/asciidoc/settings/module.adoc
index 0cd7b5e..97d4362 100644
--- a/asciidoc/settings/module.adoc
+++ b/asciidoc/settings/module.adoc
@@ -1,7 +1,8 @@
+= module
*Tag:* module
-Define a module set rule. The tag defines a module set, by giving an expression and the matcher to use for organisation, name, revision and any extra attribute identifying your modules. The rule matching is performed in order, and is using a pattern matcher. Hence you can use * to specify all, or simply avoid specifying the attribute.
+Define a module set rule. The tag defines a module set, by giving an expression and the matcher to use for organisation, name, revision and any extra attribute identifying your modules. The rule matching is performed in order, and is using a pattern matcher. Hence you can use `*` to specify all, or simply avoid specifying the attribute.
The revision and extra attributes are only used for rules defining the resolver to use. For other settings, use only organisation and module name.
@@ -10,13 +11,13 @@ It also gives the specific setting to use for this module set.
For each module set, you can configure:
-* the link:../settings/resolvers.html[resolver] to use +
+ * the link:../settings/resolvers.html[resolver] to use +
-* the link:../settings/conflict-managers.html[conflict manager] to use +
+ * the link:../settings/conflict-managers.html[conflict manager] to use +
-* the default link:../terminology.html#branch[branch] to use +
+ * the default link:../terminology.html#branch[branch] to use +
-* the link:../use/resolve.html[resolve mode] to use +
+ * the link:../use/resolve.html[resolve mode] to use +
@@ -41,7 +42,7 @@ For each module set, you can configure:
== Examples
-[source]
+[source, xml]
----
<modules>
@@ -55,7 +56,7 @@ Uses myprojectresolver for all modules from __apache__.
'''
-[source]
+[source, xml]
----
<modules>
@@ -64,12 +65,12 @@ Uses myprojectresolver for all modules from __apache__.
----
-Uses myapachecommonsresolver for all modules beginning with 'commons-' from 'apache'.
+Uses myapachecommonsresolver for all modules beginning with `commons-` from `apache`.
'''
-[source]
+[source, xml]
----
<modules>
@@ -78,12 +79,12 @@ Uses myapachecommonsresolver for all modules beginning with 'commons-' from 'apa
----
-Uses myapachecommonsresolver for all modules from __apache__ beginning with 'commons-' followed by any number of alphabetic lowercase characters, and with the extra attribute 'myextra' having a value beginning with 'val.'.
+Uses `myapachecommonsresolver` for all modules from `apache` beginning with `commons-` followed by any number of alphabetic lowercase characters, and with the extra attribute `myextra` having a value beginning with `val.`.
'''
-[source]
+[source, xml]
----
<modules>
@@ -92,12 +93,12 @@ Uses myapachecommonsresolver for all modules from __apache__ beginning with 'com
----
-Uses latest-time conflict manager for all modules from __apache__ whose name begins with 'ivy'.
+Uses `latest-time` conflict manager for all modules from `apache` whose name begins with `ivy`.
'''
-[source]
+[source, xml]
----
<modules>
@@ -106,4 +107,5 @@ Uses latest-time conflict manager for all modules from __apache__ whose name beg
----
-Uses 'fix-103' as default branch for all modules from __apache__ whose name begins with 'ivy'.
\ No newline at end of file
+Uses `fix-103` as default branch for all modules from `apache` whose name begins with `ivy`.
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/modules.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/modules.adoc b/asciidoc/settings/modules.adoc
index 58f1141..7010f99 100644
--- a/asciidoc/settings/modules.adoc
+++ b/asciidoc/settings/modules.adoc
@@ -1,3 +1,4 @@
+= modules
*Tag:* modules
@@ -7,7 +8,7 @@ The rules are given by defining a module set, using a pattern for module organis
If no rules match a given module, the default setting will be used.
-Note: You can greatly improve the performance of dependency resolution by configuring multiple smaller resolvers instead of one large resolver (i.e. chain). For instance, if you have a local repository for your modules and a remote repository for third party libraries, it is a good idea to have two separate resolvers, one for all of your modules and another for the rest (the default one).
+NOTE: You can greatly improve the performance of dependency resolution by configuring multiple smaller resolvers instead of one large resolver (i.e. chain). For instance, if you have a local repository for your modules and a remote repository for third party libraries, it is a good idea to have two separate resolvers, one for all of your modules and another for the rest (the default one).
== Child elements
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/namespace.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/namespace.adoc b/asciidoc/settings/namespace.adoc
index 0f5e7e1..3045a91 100644
--- a/asciidoc/settings/namespace.adoc
+++ b/asciidoc/settings/namespace.adoc
@@ -33,7 +33,7 @@ There are two main possibilities for using these rules. By default, a namespace
== Example
-[source]
+[source, xml]
----
<namespace name="test">
@@ -52,7 +52,7 @@ There are two main possibilities for using these rules. By default, a namespace
----
-[source]
+[source, xml]
----
<namespace name="test">
@@ -71,7 +71,7 @@ There are two main possibilities for using these rules. By default, a namespace
----
-[source]
+[source, xml]
----
<namespace name="test" chainrules="true">
@@ -109,3 +109,5 @@ There are two main possibilities for using these rules. By default, a namespace
----
+
+
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/namespace/dest.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/namespace/dest.adoc b/asciidoc/settings/namespace/dest.adoc
index c185c42..19cea60 100644
--- a/asciidoc/settings/namespace/dest.adoc
+++ b/asciidoc/settings/namespace/dest.adoc
@@ -1,13 +1,14 @@
+= dest
*Tag:* dest
Defines the translation part of a translation rule. If a name has matched a corresponding src, it will be translated using this dest part.
-The new names can contain references to groups of the matched name, using a slightly modified regexp syntax. Indeed, referenced groups can be part of either the organisation, module or revision part of the original name. So, to reference the groups, you just have to add a letter identifying the part in which the group should be selected: o for organisation, m for module, and r for revision.
+The new names can contain references to groups of the matched name, using a slightly modified regexp syntax. In fact, referenced groups can be part of either the organisation, module or revision part of the original name. So, to reference the groups, you just have to add a letter identifying the part in which the group should be selected: o for organisation, m for module, and r for revision.
-For instance, $o0 matches the whole matched organisation, and $m0 the whole matched module name. $o1 matches the first group of the matched organisation.
+For instance, `$o0` matches the whole matched organisation, and `$m0` the whole matched module name. `$o1` matches the first group of the matched organisation.
-For details about regexp and groups, see the link:http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html[Pattern class documentation] in the jdk.
+For details about regexp and groups, see the link:https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[Pattern class documentation] in the JDK.
== Attributes
@@ -24,7 +25,7 @@ For details about regexp and groups, see the link:http://java.sun.com/j2se/1.4.2
== Examples
-[source]
+[source, xml]
----
<fromsystem>
@@ -34,10 +35,5 @@ For details about regexp and groups, see the link:http://java.sun.com/j2se/1.4.2
----
-Matches modules from systemorg2 which have a name beginning with system followed by a minus and anything else, and translate it to organisation B and module the part following
-[source]
-----
-system-
-----
+Matches modules from `systemorg2` which have a name beginning with `system` followed by a `minus` and anything else, and translate it to organisation `B` and module the part following `system-` of the original name.
-of the original name.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/namespace/fromtosystem.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/namespace/fromtosystem.adoc b/asciidoc/settings/namespace/fromtosystem.adoc
index 511e5fd..e720c33 100644
--- a/asciidoc/settings/namespace/fromtosystem.adoc
+++ b/asciidoc/settings/namespace/fromtosystem.adoc
@@ -1,3 +1,4 @@
+= fromsystem / tosystem
*Tag:* fromsystem / tosystem
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/namespace/rule.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/namespace/rule.adoc b/asciidoc/settings/namespace/rule.adoc
index 5d69a7d..a8526ea 100644
--- a/asciidoc/settings/namespace/rule.adoc
+++ b/asciidoc/settings/namespace/rule.adoc
@@ -1,3 +1,4 @@
+= rule
*Tag:* rule
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/namespace/src.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/namespace/src.adoc b/asciidoc/settings/namespace/src.adoc
index fadb799..fbca139 100644
--- a/asciidoc/settings/namespace/src.adoc
+++ b/asciidoc/settings/namespace/src.adoc
@@ -1,3 +1,4 @@
+= src
*Tag:* src
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/e35f06c0/asciidoc/settings/namespaces.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/settings/namespaces.adoc b/asciidoc/settings/namespaces.adoc
index 9c0e763..aae9b12 100644
--- a/asciidoc/settings/namespaces.adoc
+++ b/asciidoc/settings/namespaces.adoc
@@ -1,9 +1,10 @@
+= namespaces
*Tag:* namespaces
Namespaces are an advanced feature of Ivy which let you use resolvers in which module names and organisations are not consistent between each other.
-For instance, if you want to use both a maven2 repository and an ivyrep, you will face some naming issues. For example, all apache commons projects are declared to be part of the organisation __apache__ in ivyrep whereas in maven2 ibiblio repository, their organisation is same as the module.
+For instance, if you want to use both a Maven2 repository and an ivyrep, you will face some naming issues. For example, all apache commons projects are declared to be part of the organisation __apache__ in ivyrep whereas in maven2 ibiblio repository, their organisation is same as the module.
So if you try to use both maven2 and ivyrep repositories, you will face some issues like:
[quote]