Documentation review: uniform style of âsinceâ (inline) and [block]; working links for derelict projects
Project: http://git-wip-us.apache.org/repos/asf/ant-ivy/repo Commit: http://git-wip-us.apache.org/repos/asf/ant-ivy/commit/45046b5f Tree: http://git-wip-us.apache.org/repos/asf/ant-ivy/tree/45046b5f Diff: http://git-wip-us.apache.org/repos/asf/ant-ivy/diff/45046b5f Branch: refs/heads/master Commit: 45046b5fdeb826dd4ecad23de726d6bb4169c175 Parents: fc8ef4d Author: Gintas Grigelionis <[email protected]> Authored: Thu Sep 14 23:03:44 2017 +0200 Committer: Gintas Grigelionis <[email protected]> Committed: Thu Sep 14 23:03:44 2017 +0200 ---------------------------------------------------------------------- asciidoc/ant.adoc | 2 +- asciidoc/concept.adoc | 33 ++++---- asciidoc/ivyfile/artifact-exclude.adoc | 10 +-- asciidoc/ivyfile/artifact.adoc | 15 ++-- asciidoc/ivyfile/conf.adoc | 11 ++- asciidoc/ivyfile/configurations.adoc | 12 +-- asciidoc/ivyfile/conflict.adoc | 2 +- asciidoc/ivyfile/conflicts.adoc | 2 +- asciidoc/ivyfile/dependencies.adoc | 14 ++-- asciidoc/ivyfile/dependency-artifact.adoc | 8 +- asciidoc/ivyfile/dependency-include.adoc | 2 +- asciidoc/ivyfile/dependency.adoc | 40 +++++----- asciidoc/ivyfile/exclude.adoc | 4 +- asciidoc/ivyfile/extends.adoc | 4 +- asciidoc/ivyfile/include.adoc | 4 +- asciidoc/ivyfile/info.adoc | 4 +- asciidoc/ivyfile/manager.adoc | 4 +- asciidoc/ivyfile/override.adoc | 2 +- asciidoc/ivyfile/publications.adoc | 2 +- asciidoc/moreexamples.adoc | 6 +- asciidoc/resolver/bintray.adoc | 1 + asciidoc/resolver/chain.adoc | 2 +- asciidoc/resolver/filesystem.adoc | 15 ++-- asciidoc/resolver/ibiblio.adoc | 12 +-- asciidoc/resolver/ivyrep.adoc | 2 +- asciidoc/resolver/jar.adoc | 3 +- asciidoc/resolver/mirrored.adoc | 2 +- asciidoc/resolver/obr.adoc | 3 +- asciidoc/resolver/osgiagg.adoc | 2 +- asciidoc/resolver/packager.adoc | 2 +- asciidoc/resolver/sftp.adoc | 2 +- asciidoc/resolver/ssh.adoc | 4 +- asciidoc/resolver/updatesite.adoc | 2 +- asciidoc/resolver/url.adoc | 2 +- asciidoc/resolver/vfs.adoc | 4 +- asciidoc/settings.adoc | 2 +- asciidoc/settings/caches.adoc | 3 +- asciidoc/settings/caches/cache.adoc | 2 +- asciidoc/settings/caches/ttl.adoc | 2 +- asciidoc/settings/classpath.adoc | 4 +- asciidoc/settings/credentials.adoc | 4 +- asciidoc/settings/include.adoc | 5 +- asciidoc/settings/latest-strategies.adoc | 4 +- asciidoc/settings/lock-strategies.adoc | 7 +- asciidoc/settings/macrodef.adoc | 4 +- asciidoc/settings/module.adoc | 12 +-- asciidoc/settings/properties.adoc | 6 +- asciidoc/settings/property.adoc | 6 +- asciidoc/settings/resolvers.adoc | 36 ++++----- asciidoc/settings/settings.adoc | 6 +- asciidoc/settings/signers.adoc | 2 +- asciidoc/settings/statuses.adoc | 4 +- asciidoc/settings/timeout-constraints.adoc | 2 +- asciidoc/settings/triggers.adoc | 102 +++++++++--------------- asciidoc/settings/version-matchers.adoc | 10 ++- asciidoc/standalone.adoc | 8 +- asciidoc/terminology.adoc | 2 +- asciidoc/tutorial.adoc | 2 +- asciidoc/use/artifactproperty.adoc | 13 +-- asciidoc/use/artifactreport.adoc | 7 +- asciidoc/use/buildlist.adoc | 56 ++++++------- asciidoc/use/buildnumber.adoc | 7 +- asciidoc/use/buildobr.adoc | 10 ++- asciidoc/use/cachefileset.adoc | 6 +- asciidoc/use/cachepath.adoc | 2 +- asciidoc/use/cleancache.adoc | 3 +- asciidoc/use/configure.adoc | 11 +-- asciidoc/use/convertmanifest.adoc | 4 +- asciidoc/use/convertpom.adoc | 4 +- asciidoc/use/deliver.adoc | 14 ++-- asciidoc/use/dependencytree.adoc | 4 +- asciidoc/use/findrevision.adoc | 5 +- asciidoc/use/fixdeps.adoc | 3 +- asciidoc/use/info.adoc | 37 +++++---- asciidoc/use/install.adoc | 14 ++-- asciidoc/use/listmodules.adoc | 7 +- asciidoc/use/makepom.adoc | 22 ++--- asciidoc/use/postresolvetask.adoc | 34 ++++---- asciidoc/use/publish.adoc | 17 ++-- asciidoc/use/report.adoc | 12 +-- asciidoc/use/repreport.adoc | 6 +- asciidoc/use/resolve.adoc | 56 ++++++------- asciidoc/use/resources.adoc | 3 +- asciidoc/use/retrieve.adoc | 31 ++++--- asciidoc/use/settings.adoc | 2 +- asciidoc/use/var.adoc | 2 +- 86 files changed, 439 insertions(+), 427 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ant.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ant.adoc b/asciidoc/ant.adoc index 7975537..325e2a1 100644 --- a/asciidoc/ant.adoc +++ b/asciidoc/ant.adoc @@ -109,7 +109,7 @@ ivy.checksums=sha1,md5 _For the latest version of these properties, you can check the link:https://git-wip-us.apache.org/repos/asf?p=ant-ivy.git;a=blob;f=src/java/org/apache/ivy/core/settings/ivy.properties[Git version]._ -*__since 2.0__* After calling the first Ivy task, the property `ivy.version` will be available and contains the version of the used Ivy library. +(*__since 2.0__*) After calling the first Ivy task, the property `ivy.version` will be available and contains the version of the used Ivy library. == Ivy tasks attributes : generalities http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/concept.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/concept.adoc b/asciidoc/concept.adoc index 14f11d9..878aa46 100644 --- a/asciidoc/concept.adoc +++ b/asciidoc/concept.adoc @@ -89,7 +89,7 @@ But here are all the tokens currently available: the organisation name `[orgPath]`:: -*__(since 2.3)__* + +(*__since 2.3__*) + the organisation name where '.' has been replaced by '/'. This can be used to configure Maven 2-like repositories. `[module]`:: @@ -114,14 +114,14 @@ the artifact file extension the configuration name `[originalname]`:: -*__(since 1.4)__* + +(*__since 1.4__*) + the original artifact name (including the extension) The difference between type and extension is explained in the Ivy file documentation. -*__since 1.2__* `[organization]` can be used instead of `[organisation]`. +(*__since 1.2__*) `[organization]` can be used instead of `[organisation]`. -*__since 1.3__* Optional parts can be used in patterns. +(*__since 1.3__*) Optional parts can be used in patterns. This provides the possibility to avoid some input when a token is not defined, instead of having only the token as blank. Parenthesis are used to delimit the optional part, and only one token can be found inside the parenthesis. @@ -135,7 +135,7 @@ For instance, suppose the pattern: `abc(def[type]ghi)` A more real life example: The pattern `[artifact](-[revision]).[ext]` lets you accept both `myartifact-1.0.jar` when a revision is set, and `myartifact.jar` (instead of `myartifact-.jar`) when no revision is set. This is particularly useful when you need to keep control of artifact names. -*__since 1.4__* Extra attributes can be used as any other token in a pattern. +(*__since 1.4__*) Extra attributes can be used as any other token in a pattern. == [[latest]]Latest Strategy @@ -174,8 +174,7 @@ For more details on how to setup your conflict managers by module, see the link: == [[matcher]]Pattern matcher -*__since 1.3__* -In several places Ivy uses a pattern to match a set of objects. For instance, you can exclude several modules at once when declaring a dependency by using a pattern matching all the modules to exclude. +(*__since 1.3__*) In several places Ivy uses a pattern to match a set of objects. For instance, you can exclude several modules at once when declaring a dependency by using a pattern matching all the modules to exclude. Ivy uses a pluggable pattern matcher to match those object names. 3 are defined by default: @@ -192,11 +191,10 @@ Note also that with any matcher, the character '*' has the special meaning of ma == [[extra]]Extra attributes -*__since 1.4__* -Several tags in Ivy XML files are extensible with what is called extra attributes. +(*__since 1.4__*) Several tags in Ivy XML files are extensible with what is called extra attributes. The idea is very simple: if you need some more information to define your modules, you can add the attribute you want and you will then be able to access it as any other attribute in your patterns. -*__since 2.0__* +(*__since 2.0__*) It's possible and recommended to use XML namespaces for your extra attributes. Using an Ivy extra namespace is the easiest way to add your own extra attributes. Example: here is an Ivy file with the attribute `color` set to blue: @@ -233,7 +231,7 @@ If you don't want to use XML namespaces, it's possible but you will need to disa == [[checksum]]Checksums -*__since 1.4__* +(*__since 1.4__*) Ivy allows the use of checksums, also known as digests, to verify the correctness of a downloaded file. The configuration of using the algorithm can be done globally or by dependency resolver. @@ -251,18 +249,16 @@ If you want to change this default, you can set the variable `ivy.checksums`. He === Supported algorithms -*__since 1.4__* +(*__since 1.4__*) * md5 * sha1 -*__since 2.5__* -Starting 2.5 version, in addition to md5 and sha1, Ivy supports SHA-256, SHA-512 and SHA-384 algorithms, if the Java runtime in which Ivy is running, supports those. For example, Java 6 runtime supports SHA-256 and SHA-512 as standard algorithms. If Ivy 2.5 and later versions are run under Java 6 or higher runtimes, these algorithms are supported by Ivy too. +(*__since 2.5__*) In addition to md5 and sha1, Ivy supports SHA-256, SHA-512 and SHA-384 algorithms, if the Java runtime in which Ivy is running, supports those. For example, Java 6 runtime supports SHA-256 and SHA-512 as standard algorithms. If Ivy 2.5 and later versions run in Java 6 or higher runtimes, these algorithms are supported by Ivy too. == [[event]]Events and Triggers -*__since 1.4__* -When Ivy performs the dependency resolution and some other tasks, it fires events before and after the most important steps. You can listen to these events using Ivy API, or you can even register a trigger to perform a particular action when a particular event occur. +(*__since 1.4__*) When Ivy performs the dependency resolution and some other tasks, it fires events before and after the most important steps. You can listen to these events using Ivy API, or you can even register a trigger to perform a particular action when a particular event occur. This is a particularly powerful and flexible feature which allows, for example, you to perform a build of a dependency just before it is resolved, or follow what's happening during the dependency resolution process accurately, and so on. @@ -270,10 +266,9 @@ For more details about events and triggers, see the link:settings/triggers.html[ == [[circular]]Circular Dependencies -*__since 1.4__* -Circular dependencies can be either direct or indirect. For instance, if A depends on A, it's a circular dependency, and if A depends on B which itself depends on A, this is also a circular dependency. +(*__since 1.4__*) Circular dependencies can be either direct or indirect. For instance, if A depends on A, it's a circular dependency, and if A depends on B which itself depends on A, this is also a circular dependency. -Prior to Ivy 1.4 circular dependencies where causing a failure in Ivy. As of Ivy 1.4, the behaviour of Ivy when it finds a circular dependency is configurable through a circular dependency strategy. +Prior to Ivy 1.4 circular dependencies caused a failure in Ivy. As of Ivy 1.4, the behaviour of Ivy when it finds a circular dependency is configurable through a circular dependency strategy. 3 built-in strategies are available: http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/artifact-exclude.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/artifact-exclude.adoc b/asciidoc/ivyfile/artifact-exclude.adoc index 772535c..6d4098e 100644 --- a/asciidoc/ivyfile/artifact-exclude.adoc +++ b/asciidoc/ivyfile/artifact-exclude.adoc @@ -26,7 +26,7 @@ The same principle concerning configuration as for include applies to this exclu Note that exclusion is always done AFTER inclusion has been done. -*__since 1.3__* This exclude feature can also be used not only to exclude artifacts but also to exclude whole modules. Indeed when you exclude artifacts, it doesn't prevent Ivy from searching for the module itself, and resolving the dependencies of the module. But you can also exclude the entire module, which means that the module will not be downloaded at all, and so its own dependencies will not be resolved. For sure, this is usually done to exclude not a direct dependency but an indirect one. To exclude a whole module, you just have to not specify any artifact name, type and ext in your exclude rule. For instance: +(*__since 1.3__*) This exclude feature can also be used not only to exclude artifacts but also to exclude whole modules. Indeed when you exclude artifacts, it doesn't prevent Ivy from searching for the module itself, and resolving the dependencies of the module. But you can also exclude the entire module, which means that the module will not be downloaded at all, and so its own dependencies will not be resolved. For sure, this is usually done to exclude not a direct dependency but an indirect one. To exclude a whole module, you just have to not specify any artifact name, type and ext in your exclude rule. For instance: [source,xml] ---- @@ -35,19 +35,19 @@ Note that exclusion is always done AFTER inclusion has been done. </dependency> ---- -*__since 2.0__* A link:../ivyfile/exclude.html[module wide exclude] can also be used to exclude dependencies for the whole module (and not only in the context of one dependency as it is the case here). +(*__since 2.0__*) A link:../ivyfile/exclude.html[module wide exclude] can also be used to exclude dependencies for the whole module (and not only in the context of one dependency as it is the case here). == Attributes [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|org|the organisation of the dependency module or artifact to exclude, or a regexp matching this organisation *__since 1.3__*|No, defaults to `$$*$$` -|module|the name of the dependency module or the artifact to exclude, or a regexp matching this module name *__since 1.3__*|No, defaults to `$$*$$` +|org|the organisation of the dependency module or artifact to exclude, or a regexp matching this organisation (*__since 1.3__*)|No, defaults to `$$*$$` +|module|the name of the dependency module or the artifact to exclude, or a regexp matching this module name (*__since 1.3__*)|No, defaults to `$$*$$` |name|the name of an artifact of the dependency module to add to the exclude list, or an expression matching this name (see `matcher` attribute below)|No, defaults to `$$*$$` |type|the type of the artifact of the dependency module to add to the exclude list, or a regexp matching this name|No, defaults to `$$*$$` |ext|the extension of the artifact of the dependency module to add to the exclude list, or an expression matching this name (see `matcher` attribute below)|No, defaults to the value of `type` -|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to excludes *__since 1.3__*|No, defaults to `exactOrRegexp` in pre 1.3 Ivy files, and `exact` in 1.3 and superior +|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to excludes (*__since 1.3__*)|No, defaults to `exactOrRegexp` in pre 1.3 Ivy files, and `exact` in 1.3 and superior |conf|comma separated list of the master configurations in which this artifact should be excluded. `$$*$$` wildcard can be used to designate all configurations of this module|No, defaults to `$$*$$`, unless nested conf are specified http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/artifact.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/artifact.adoc b/asciidoc/ivyfile/artifact.adoc index 931aa34..8893fe3 100644 --- a/asciidoc/ivyfile/artifact.adoc +++ b/asciidoc/ivyfile/artifact.adoc @@ -28,7 +28,10 @@ The configurations in which an artifact is published can be configured in two wa The two are equivalent, it is only a matter of preference. However, do not mix both for one artifact. -*__since 1.4__* The artifact element has default values for all its attributes, so if you want to declare a default artifact you can just declare it like that: +[*__since 1.4__*] + +The artifact element has default values for all its attributes, so if you want to declare a default artifact you can just declare it like that: + [source,xml] ---- <artifact/> @@ -36,11 +39,11 @@ The two are equivalent, it is only a matter of preference. However, do not mix b If this is the only artifact declared, then it's equivalent to having no publication section at all. -*__since 1.4__* It is possible to give an `url` at which artifacts can be found. This is not mandatory, and even not recommended. This is only a convenient way to deal with an existing repository with a bad layout, but should not be avoided in an enterprise repository. +It is possible to give an `url` at which artifacts can be found. This is not mandatory, and even not recommended. This is only a convenient way to deal with an existing repository with a bad layout, but should not be avoided in an enterprise repository. -*__since 1.4__* This tag supports link:../concept.html#extra[extra attributes]. +This tag supports link:../concept.html#extra[extra attributes]. -*__since 2.4__* This tag supports the 'packaging' attributes; complete documentation can be found in the link:../concept.html#packaging[concept page]. +(*__since 2.4__*) This tag supports the 'packaging' attributes; complete documentation can be found in the link:../concept.html#packaging[concept page]. == Attributes @@ -53,8 +56,8 @@ If this is the only artifact declared, then it's equivalent to having no publica |conf|comma separated list of public configurations in which this artifact is published. `$$*$$` wildcard can be used to designate all public configurations of this module|No, defaults to `defaultconf` attribute value on parent publications element. -|url|an URL at which this artifact can be found if it isn't located at the standard location in the repository *__since 1.4__*|No, defaults to no URL -|packaging|a comma separated list of link:../concept.html#packaging[packaging] types *__since 2.4__*|No, defaults to no packaging +|url|an URL at which this artifact can be found if it isn't located at the standard location in the repository (*__since 1.4__*)|No, defaults to no URL +|packaging|a comma separated list of link:../concept.html#packaging[packaging] types (*__since 2.4__*)|No, defaults to no packaging |======= == Child elements http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/conf.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/conf.adoc b/asciidoc/ivyfile/conf.adoc index 1d7aa01..665d4eb 100644 --- a/asciidoc/ivyfile/conf.adoc +++ b/asciidoc/ivyfile/conf.adoc @@ -29,7 +29,10 @@ A configuration can also extend one or several other ones of the same module. Wh This notion is very helpful to define configurations which are similar with some differences. -*__since 1.4__* The extends attribute can use the following wildcards: +[*__since 1.4__*] + +The extends attribute can use the following wildcards: + [cols="15%,50%"] |======= |`*`|all other configurations @@ -37,10 +40,10 @@ This notion is very helpful to define configurations which are similar with some |`*(private)`|all other private configurations |======= -*__since 1.4__* A whole configuration can be declared as non transitive, so that all dependencies resolved in this configuration will be resolved with transitivity disabled. Note that the transitivity is disabled for all the configuration dependencies (including those obtained because this conf extends other ones), and only for this configuration (which means that a conf extending this one with transitivity enabled will get transitive dependencies even for dependencies being part of the non transitive configuration). +A whole configuration can be declared as non transitive, so that all dependencies resolved in this configuration will be resolved with transitivity disabled. Note that the transitivity is disabled for all the configuration dependencies (including those obtained because this conf extends other ones), and only for this configuration (which means that a conf extending this one with transitivity enabled will get transitive dependencies even for dependencies being part of the non transitive configuration). This is very useful to build a compile configuration, for instance, forcing the dependency declaration on each direct dependency, with no risk to forget some because of transitivity. -*__since 1.4__* This tag supports link:../concept.html#extra[extra attributes]. +This tag supports link:../concept.html#extra[extra attributes]. == Attributes @@ -53,7 +56,7 @@ This is very useful to build a compile configuration, for instance, forcing the `public` means that this configuration can be used by other modules, while `private` means that this configuration is used only in the module itself, and is not exposed to other modules|No, defaults to `public` |extends|a comma separated list of configurations of this module that the current configuration extends|No, defaults to none -|transitive|a boolean to indicate if this conf is transitive or not *__since 1.4__*|No, defaults to `true` +|transitive|a boolean to indicate if this conf is transitive or not (*__since 1.4__*)|No, defaults to `true` |deprecated|indicates that this conf has been deprecated by giving the date of the deprecation. It should be given in this format: `yyyyMMddHHmmss`|No, by default the conf is not deprecated http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/configurations.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/configurations.adoc b/asciidoc/ivyfile/configurations.adoc index f979688..481f068 100644 --- a/asciidoc/ivyfile/configurations.adoc +++ b/asciidoc/ivyfile/configurations.adoc @@ -21,9 +21,9 @@ A container for configuration elements. If this container is not present, it is assumed that the module has one public configuration called `default`. -*__since 2.2__* You can define the default conf on this container by specifying the `defaultconf` attribute. This attribute defines the conf mapping to use when no conf mapping is specified for a dependency in this Ivy file. +(*__since 2.2__*) You can define the default conf on this container by specifying the `defaultconf` attribute. This attribute defines the conf mapping to use when no conf mapping is specified for a dependency in this Ivy file. -*__since 1.3__* You can define a default conf mapping on this container by specifying the `defaultconfmapping` attribute. +(*__since 1.3__*) You can define a default conf mapping on this container by specifying the `defaultconfmapping` attribute. This attribute modifies the way Ivy interprets conf mapping with no mapped conf. In this case, Ivy will look in the default conf mapping and use the conf mapping defined in the default conf mapping for the conf for which there is no mapped conf. @@ -33,16 +33,16 @@ If several `defaultconfmapping` or `defaultconf` attributes are defined (in the See link:#defaultconfmapping[examples below] to clarify the behavior of these two attributes together. -*__since 1.4__* You can activate a `confmappingoverride` mode for all configurations, in which case the extending configurations will override the mappings of the configurations they extend from. +(*__since 1.4__*) You can activate a `confmappingoverride` mode for all configurations, in which case the extending configurations will override the mappings of the configurations they extend from. == Attributes [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|defaultconf|the default conf to use in this Ivy file *__since 2.2__*|No, defaults to no default conf -|defaultconfmapping|the default conf mapping to use in this Ivy file *__since 1.3__*|No, defaults to no default conf mapping -|confmappingoverride|`true` to activate configuration mapping override, `false` otherwise *__since 1.4__*|No, defaults to `false` +|defaultconf|the default conf to use in this Ivy file (*__since 2.2__*)|No, defaults to no default conf +|defaultconfmapping|the default conf mapping to use in this Ivy file (*__since 1.3__*)|No, defaults to no default conf mapping +|confmappingoverride|`true` to activate configuration mapping override, `false` otherwise (*__since 1.4__*)|No, defaults to `false` |======= == Child elements http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/conflict.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/conflict.adoc b/asciidoc/ivyfile/conflict.adoc index a8cabe4..adc429a 100644 --- a/asciidoc/ivyfile/conflict.adoc +++ b/asciidoc/ivyfile/conflict.adoc @@ -19,7 +19,7 @@ *Tag:* conflict *Parent:* link:../ivyfile/dependencies.html[dependencies] -*__(since 2.0)__* +[*__since 2.0__*] Specify a a conflict manager for one or several dependencies. The way to specify a conflict manager is by giving indication to which dependencies the conflict manager applies (by giving organisation and module names or name regexp), and then specifying the conflict manager, either by giving its name or by specifying a fixed revision list, in which case a fixed conflict manager is used. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/conflicts.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/conflicts.adoc b/asciidoc/ivyfile/conflicts.adoc index 57253d6..a58042e 100644 --- a/asciidoc/ivyfile/conflicts.adoc +++ b/asciidoc/ivyfile/conflicts.adoc @@ -19,7 +19,7 @@ *Tag:* conflicts *Parent:* link:../ivyfile.html[ivy-module] -*__(since 2.0)__* the conflicts section is deprecated. Use link:../ivyfile/conflict.html[conflict] instead. +(*__since 2.0__*) The conflicts section is deprecated. Use link:../ivyfile/conflict.html[conflict] instead. Container for conflict manager elements, used to indicate how conflicts should be resolved for this module. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/dependencies.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependencies.adoc b/asciidoc/ivyfile/dependencies.adoc index 04ae6aa..9b8857d 100644 --- a/asciidoc/ivyfile/dependencies.adoc +++ b/asciidoc/ivyfile/dependencies.adoc @@ -24,9 +24,9 @@ If this container is not present, it is assumed that the module has no dependenc This container provides two similar behaviors described below. (See link:../ivyfile/configurations.html[configurations doc page] for more details about these behaviors). -*__since 1.1__* `defaultconf` defines the `conf` attribute to use when no conf is defined for a dependency in this Ivy file. It is only used when no conf mapping is defined, and has no influence in other cases. +(*__since 1.1__*) `defaultconf` defines the `conf` attribute to use when no conf is defined for a dependency in this Ivy file. It is only used when no conf mapping is defined, and has no influence in other cases. -*__since 1.3__* `defaultconfmapping` influences the way that a conf mapping with no mapped conf is interpreted. +(*__since 1.3__*) `defaultconfmapping` influences the way that a conf mapping with no mapped conf is interpreted. In Ivy 2.1.0 and earlier, if both `defaultconf` and `defaultconfmapping` are defined, it's the `defaultconfmapping` that is used. Since Ivy 2.2.0, these attributes can be used together. @@ -35,8 +35,8 @@ In Ivy 2.1.0 and earlier, if both `defaultconf` and `defaultconfmapping` are def [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|defaultconf|the default configuration to use when none is specified in a dependency. *__since 1.1__*|No, defaults to `$$*->*$$` -|defaultconfmapping|the default configuration mapping to use in this Ivy file. *__since 1.3__*|No, defaults to no default conf mapping +|defaultconf|the default configuration to use when none is specified in a dependency. (*__since 1.1__*)|No, defaults to `$$*->*$$` +|defaultconfmapping|the default configuration mapping to use in this Ivy file. (*__since 1.3__*)|No, defaults to no default conf mapping |======= @@ -50,7 +50,7 @@ Note: as specified by the ivy.xsd, the children elements are ordered; first must |======= |Element|Description|Cardinality |link:../ivyfile/dependency.html[dependency]|declares a dependency for this module|0..n -|link:../ivyfile/exclude.html[exclude]|excludes artifacts, modules or whole organizations from the set of dependencies of this module *__since 2.0__*|0..n -|link:../ivyfile/override.html[override]|specifies an override mediation rule, overriding the revision and/or branch requested for a transitive dependency *__since 2.0__*|0..n -|link:../ivyfile/conflict.html[conflict]|specifies a conflict manager for one or several dependencies *__since 2.0__*|0..n +|link:../ivyfile/exclude.html[exclude]|excludes artifacts, modules or whole organizations from the set of dependencies of this module (*__since 2.0__*)|0..n +|link:../ivyfile/override.html[override]|specifies an override mediation rule, overriding the revision and/or branch requested for a transitive dependency (*__since 2.0__*)|0..n +|link:../ivyfile/conflict.html[conflict]|specifies a conflict manager for one or several dependencies (*__since 2.0__*)|0..n |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/dependency-artifact.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependency-artifact.adoc b/asciidoc/ivyfile/dependency-artifact.adoc index 4ef0795..e9a1f48 100644 --- a/asciidoc/ivyfile/dependency-artifact.adoc +++ b/asciidoc/ivyfile/dependency-artifact.adoc @@ -37,11 +37,11 @@ Example: </dependency> ---- -*__since 1.4__* It's possible to indicate the URL at which the artifact can be found. This is not mandatory, and even not recommended with an enterprise repository. Note that Ivy will always look at the location where the artifact should be and only use the URL if it cannot be found at the standard location in the repository. +(*__since 1.4__*) It's possible to indicate the URL at which the artifact can be found. This is not mandatory, and even not recommended with an enterprise repository. Note that Ivy will always look at the location where the artifact should be and only use the URL if it cannot be found at the standard location in the repository. -*__since 1.4__* This tag supports link:../concept.html#extra[extra attributes]. +(*__since 1.4__*) This tag supports link:../concept.html#extra[extra attributes]. -*__since 2.0__* This feature can also be used for modules having their own module descriptor, but which doesn't declare an artifact you know that is published. Note that in this case artifacts declared to be published by the dependency will be ignored, so do not forget to include all artifacts you want. +(*__since 2.0__*) This feature can also be used for modules having their own module descriptor, but which doesn't declare an artifact you know that is published. Note that in this case artifacts declared to be published by the dependency will be ignored, so do not forget to include all artifacts you want. == Attributes @@ -54,7 +54,7 @@ Example: |conf|comma separated list of the master configurations in which this artifact should be included. `$$*$$` wildcard can be used to designate all configurations of this module|No, defaults to `$$*$$`, unless nested conf are specified -|url|an URL where this artifact can be found if it isn't present at the standard location in the repository *__since 1.4__*|No, defaults to no URL +|url|an URL where this artifact can be found if it isn't present at the standard location in the repository (*__since 1.4__*)|No, defaults to no URL |======= == Child elements http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/dependency-include.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependency-include.adoc b/asciidoc/ivyfile/dependency-include.adoc index 22e015b..896fb3a 100644 --- a/asciidoc/ivyfile/dependency-include.adoc +++ b/asciidoc/ivyfile/dependency-include.adoc @@ -44,7 +44,7 @@ Example: |name|the name of an artifact of the dependency module to add to the include list, or an expression matching this name (see `matcher` attribute below)|No, defaults to `$$.*$$` |type|the type of the artifact of the dependency module to add to the include list, or an expression matching this name (see `matcher` attribute below)|No, defaults to `$$.*$$` |ext|the extension of the artifact of the dependency module to add to the include list, or an expression matching this name (see `matcher` attribute below)|No, defaults to the value of `type` -|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to include *__since 2.0__*|No, defaults to `exactOrRegexp` in pre 1.3 Ivy files, and `exact` in 1.3 and superior +|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to include (*__since 2.0__*)|No, defaults to `exactOrRegexp` in pre 1.3 Ivy files, and `exact` in 1.3 and superior |conf|comma separated list of the master configurations in which this artifact should be included. `$$*$$` wildcard can be used to designate all configurations of this module|No, defaults to `$$*$$`, unless nested conf are specified http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/dependency.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependency.adoc b/asciidoc/ivyfile/dependency.adoc index f4c45cc..8a189fc 100644 --- a/asciidoc/ivyfile/dependency.adoc +++ b/asciidoc/ivyfile/dependency.adoc @@ -28,7 +28,7 @@ The revision can be given as a fixed one (1.5.2, for instance) or as a latest (o * `latest.integration` + selects the latest revision of the dependency module. -* `latest.[any status]` *__since 1.4__* + +* `latest.[any status]` (*__since 1.4__*) + selects the latest revision of the dependency module with at least the specified status. + For instance, `latest.milestone` will select the latest version being either a `milestone` or a `release`, and `latest.release` will only select the latest `release`. Note that in order to find the latest revision with the appropriate status Ivy has to parse all the Ivy files in your repository from the last one until it finds such a revision. Hence don't be surprised if the resolution slow down. See also link:../settings/statuses.html[statuses] to see how to configure module statuses. @@ -37,7 +37,7 @@ See also link:../settings/statuses.html[statuses] to see how to configure module selects the latest sub-revision of the dependency module. For instance, if the dependency module exists in revision 1.0.3, 1.0.7 and 1.1.2, "1.0.+" will select 1.0.7. -* version ranges *__since 1.4__* + +* version ranges (*__since 1.4__*) + mathematical notation for ranges can be used to match a range of version. + Examples: + `[1.0,2.0]` matches all versions greater or equal to 1.0 and lower or equal to 2.0 + @@ -49,12 +49,14 @@ Examples: + `(,2.0]` matches all versions lower or equal to 2.0 + `(,2.0[` matches all versions lower than 2.0 + -*__since 1.4__* If you don't find a way to expression your dependency version constraint among these, you can link:../settings/version-matchers.html[plug your own]. +(*__since 1.4__*) If you don't find a way to expression your dependency version constraint among these, you can link:../settings/version-matchers.html[plug your own]. The way to determine which revision is the "latest" between two is configurable through the use of pluggable LatestStrategy. See link:../reference.html[Ivy main concepts] for details about this. == [[revision-constraint]]Revision constraint -*__since 2.0__* The `dependency` tag supports two revision attributes: `rev`, corresponding to the default required dependency revision, and `revConstraint`, corresponding to a dynamic revision constraint applied on this dependency. +[*__since 2.0__*] + +The `dependency` tag supports two revision attributes: `rev`, corresponding to the default required dependency revision, and `revConstraint`, corresponding to a dynamic revision constraint applied on this dependency. Depending on the link:../use/resolve.html[resolve mode] used, the actual revision used during dependency resolution may vary. These revisions usually differ only for modules published in a repository. When link:../use/deliver.html[deliver] is used, dynamic version constraints are replaced by a static version constraint, to help build reproducibility. However, the information of the original version constraint is not lost, but rather put in the `revConstraint` attribute. This ensures better metadata in the repository while still allowing easier build reproducibility. @@ -85,30 +87,32 @@ For instance, `$$A, B, C -> E, F$$` means that dependency configurations E and F Note that you can use the wildcard `$$*$$` as a configuration name, meaning that all configurations (either master or dependency public ones depending on the side) are wanted. For instance, `$$* -> B, C$$` means that B & C dependency configurations are required in all master configurations. -*__since 1.4__* you can use * wildcard followed by negated configurations to mean all but xxx. For instance, `$$*, !A, !B -> X$$` means that X dependency configuration is required in all master configurations except A and B. +(*__since 1.4__*) you can use `$$*$$` wildcard followed by negated configurations to mean all but xxx. For instance, `$$*, !A, !B -> X$$` means that X dependency configuration is required in all master configurations except A and B. -*__since 1.2__* `@` also has a special meaning as a right operand of the dependency mapping, it means map to self. This is particularly useful with `$$*$$`, `$$*->@$$` meaning that all configurations of the module maps to their equivalent (same name) in the dependency. +(*__since 1.2__*) `@` also has a special meaning as a right operand of the dependency mapping, it means map to self. This is particularly useful with `$$*$$`, `$$*->@$$` meaning that all configurations of the module maps to their equivalent (same name) in the dependency. -*__since 1.4__* `#` can be used as right side operand to mean _this_ configuration, and thus refers to the configuration being resolved. It is slightly similar to `@`, except that it takes into account the configuration being actually resolved in case of a configuration extending another one. +(*__since 1.4__*) `#` can be used as right side operand to mean _this_ configuration, and thus refers to the configuration being resolved. It is slightly similar to `@`, except that it takes into account the configuration being actually resolved in case of a configuration extending another one. Example: Let's foo be a module with two configurations, A and B, B extending A. Then a dependency declaring conf `$$A->#$$` will get A dep conf in its confs A (when resolving A, Ivy will find interpret the `#` symbol as A) and B dep conf in its conf B (when resolving B, Ivy will interpret the `#` symbol as B, even if this dependency is only required because of the A dependency). If you don't understand really how this works, do not use it :-) -*__since 1.4__* `%` can be used as left side operand to mean "all the other configurations". This can be useful when you only have a specific mapping for some configurations and a default mapping for all the others. For instance, `$$test->runtime;%->default$$` means that the `test` configuration is mapped to the `runtime` configuration, but all the other configurations are mapped to the `default` configuration. +(*__since 1.4__*) `%` can be used as left side operand to mean "all the other configurations". This can be useful when you only have a specific mapping for some configurations and a default mapping for all the others. For instance, `$$test->runtime;%->default$$` means that the `test` configuration is mapped to the `runtime` configuration, but all the other configurations are mapped to the `default` configuration. -*__since 1.3__* a fallback mechanism can be used when you are not sure that the dependency will have the required conf. You can indicate to Ivy that you want one configuration, but if it isn't present, use another one. +(*__since 1.3__*) a fallback mechanism can be used when you are not sure that the dependency will have the required conf. You can indicate to Ivy that you want one configuration, but if it isn't present, use another one. The syntax for specifying this adds the fallback conf between parenthesis right after the required conf. For instance, `$$test->runtime(default)$$` means that in the test configuration of the module the `runtime` conf of the dependency is required, but if doesn't exist, it will use the `default` conf instead. If `default` conf doesn't exist then it will be considered as an error. Note that the `*` wildcard can be used as fallback conf. -*__since 2.1__* It is also possible to define dependencies on configurations intersection. A configuration intersection is defined using a `+` sign to separate the configuration (eg `A+B` means the intersection of configuration A and B). In that case only artifacts and dependencies defined in both configurations in the dependency will be part of the master configuration defining the dependency on the configuration intersection. +[*__since 2.1__*] + +It is also possible to define dependencies on configuration intersections. A configuration intersection is defined using a `+` sign to separate the configuration (eg `A+B` means the intersection of configuration A and B). In that case only artifacts and dependencies defined in both configurations in the dependency will be part of the master configuration defining the dependency on the configuration intersection. Configuration intersections can also be used when specifying the confs to link:../use/resolve.html[resolve]. Moreover, the mapping `$$*->@$$` is handled as a specific case with configuration intersections: it maps also the intersections. So if one resolve conf `A+B` in a module which defines a dependency with mapping `$$*->@$$`, the mapping `$$*->@$$` is interpreted as `$$A+B->A+B$$` so the intersection of A and B will be resolved in the dependency. -*__since 2.1__* you can refer to a group of configurations sharing the same value for an attribute as left side part of the dependency mapping. The syntax is `*[att=value]` where `att` is the name of the attribute shared by the configurations of the group, and `value` is the value for this attribute that configurations must have to be part of the group. This is especially useful with extra attributes. +You can refer to a group of configurations sharing the same value for an attribute as left side part of the dependency mapping. The syntax is `*[att=value]` where `att` is the name of the attribute shared by the configurations of the group, and `value` is the value for this attribute that configurations must have to be part of the group. This is especially useful with extra attributes. For instance, if you have: [source,xml] @@ -130,7 +134,7 @@ Then you can do: To map the windows and linux configurations (the one which have the attribute axis equal to platform) to the default configuration of foo. -*__since 1.4__* you can add simple conditions in the right side of the dependency mapping. This is done by adding a condition between `[` and `]`. If the condition evaluates to `true`, the mapping is performed. If the condition evaluates to `false`, the mapping will be ignored. For instance, `$$test->[org=A]runtime,[org=B]default$$` means that the `test` configuration will be mapped to the `runtime` conf for the dependencies of organisation A and to the `default` conf for dependencies of organisation B. +(*__since 1.4__*) You can add simple conditions in the right side of the dependency mapping. This is done by adding a condition between `[` and `]`. If the condition evaluates to `true`, the mapping is performed. If the condition evaluates to `false`, the mapping will be ignored. For instance, `$$test->[org=A]runtime,[org=B]default$$` means that the `test` configuration will be mapped to the `runtime` conf for the dependencies of organisation A and to the `default` conf for dependencies of organisation B. === Specify a semi-column separated list of any of the previous specs. @@ -150,7 +154,7 @@ Finally, the dependency element also supports an a force attribute (since 0.8), to conflict manager to force the revision of a dependency to the one given here. See link:../ivyfile/conflicts.html[conflict manager] for details. -*__since 1.4__* this tag supports link:../concept.html#extra[extra attributes] +(*__since 1.4__*) This tag supports link:../concept.html#extra[extra attributes] == Attributes @@ -159,7 +163,7 @@ See link:../ivyfile/conflicts.html[conflict manager] for details. |Attribute|Description|Required |org|the name of the organisation of the dependency.|No, defaults to the master module organisation |name|the module name of the dependency|Yes -|branch|the branch of the dependency. *__since 1.4__*|No, defaults to the default branch setting for the dependency. +|branch|the branch of the dependency. (*__since 1.4__*)|No, defaults to the default branch setting for the dependency. |rev|the revision of the dependency. See link:#revision[above] for details.|Yes |revConstraint|the dynamic revision constraint originally used for this dependency. See link:#revision-constraint[above] for details.|No, defaults to the value of `rev` |force|a boolean to give an indication to conflict manager that this dependency should be forced to this revision (see link:../ivyfile/conflicts.html[conflict manager])|No, defaults to `false` @@ -185,7 +189,7 @@ See link:../ivyfile/conflicts.html[conflict manager] for details. <dependency org="jayasoft" name="swtbinding" revision="0.2"/> ---- -Declares a dependency on the module swtbinding from jayasoft in its revision 0.2. All the configuration of this dependency will be included in all configurations of the module in which the dependency is declared. +Declares a dependency on the module `swtbinding` from `jayasoft` in its revision 0.2. All the configuration of this dependency will be included in all configurations of the module in which the dependency is declared. ''' @@ -212,7 +216,7 @@ Declares a dependency on the module `mymodule` from the same organisation as the <dependency org="apache" name="commons-lang" revision="2.0" force="true" conf="default"/> ---- -Declares a dependency on the module `commons-lang` from apache, in revision 2.0. The revision 2.0 will be used even if another dependency declares itself a dependency on another version of `commons-lang`. Moreover, if no `defaultconfmapping` is defined, only the `default` conf of `commons-lang` will be used in the `default` conf of the master module. If `$$*->runtime$$` was declared as `defaultconfmapping`, then the `runtime` conf of `commons-lang` would be included in the `default` conf of the master module. Note that whatever the `defaultconfmapping` is, the dependency only be included in the default conf of the master module. The `defaultconfmapping` only changes the required dependency confs. +Declares a dependency on the module `commons-lang` from `apache`, in revision 2.0. The revision 2.0 will be used even if another dependency declares itself a dependency on another version of `commons-lang`. Moreover, if no `defaultconfmapping` is defined, only the `default` conf of `commons-lang` will be used in the `default` conf of the master module. If `$$*->runtime$$` was declared as `defaultconfmapping`, then the `runtime` conf of `commons-lang` would be included in the `default` conf of the master module. Note that whatever the `defaultconfmapping` is, the dependency only be included in the default conf of the master module. The `defaultconfmapping` only changes the required dependency confs. ''' @@ -221,7 +225,7 @@ Declares a dependency on the module `commons-lang` from apache, in revision 2.0. <dependency org="foo" name="bar" revision="3.0" transitive="false" conf="default->@;runtime,test->runtime"/> ---- -Declares a dependency on the module `bar` from foo, in revision 3.0. The dependencies of bar will themselves not be included due to the setting of transitive. The `default` dependency conf will be included in the `default` master conf, and the `runtime` dependency conf will be included in both the `runtime` and `test` master conf. +Declares a dependency on the module `bar` from `foo`, in revision 3.0. The dependencies of `bar` will themselves not be included due to the setting of transitive. The `default` dependency conf will be included in the `default` master conf, and the `runtime` dependency conf will be included in both the `runtime` and `test` master conf. ''' @@ -230,4 +234,4 @@ Declares a dependency on the module `bar` from foo, in revision 3.0. The depende <dependency org="foo" name="bar" revision="3.0" changing="true" conf="compile->runtime(default)"/> ---- -Declares a dependency on the module `bar` from `foo`, in revision 3.0. This revision is considered to be able to change (`changing="true"`), so even if it is already in Ivy's cache, Ivy will check if a revision is a more recent last modified date is available on the repository. The `runtime` conf of bar is required in the `compile` conf of the master module, but if bar doesn't define a `runtime` conf, then the `default` conf will be used. +Declares a dependency on the module `bar` from `foo`, in revision 3.0. This revision is considered to be able to change (`changing="true"`), so even if it is already in Ivy's cache, Ivy will check if a revision is a more recent last modified date is available on the repository. The `runtime` conf of `bar` is required in the `compile` conf of the master module, but if `bar` doesn't define a `runtime` conf, then the `default` conf will be used. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/exclude.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/exclude.adoc b/asciidoc/ivyfile/exclude.adoc index 60d3057..5048041 100644 --- a/asciidoc/ivyfile/exclude.adoc +++ b/asciidoc/ivyfile/exclude.adoc @@ -19,7 +19,9 @@ *Tag:* exclude *Parent:* link:../ivyfile/dependencies.html[dependencies] -*__since 2.0__* This feature gives you more control on a dependency for which you do not control its Ivy file. +[*__since 2.0__*] + +This feature gives you more control on a dependency for which you do not control its Ivy file. It allows to exclude artifacts, modules or organizations from the list of dependencies for the whole module. It is very similar to the link:../ivyfile/artifact-exclude.html[dependency exclude] element, except that it applies to a whole module, which can be very useful when a lot of dependencies transitively bring a module you don't want. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/extends.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/extends.adoc b/asciidoc/ivyfile/extends.adoc index 5b969fe..49867d2 100644 --- a/asciidoc/ivyfile/extends.adoc +++ b/asciidoc/ivyfile/extends.adoc @@ -19,7 +19,9 @@ *Tag:* extends *Parent:* link:../ivyfile/info.html[info] -*__since 2.2__* Identifies an optional parent descriptor for this module. For complicated projects composed of many modules that have common configurations or dependencies, inheritance allows modules to share this information. Which parts of the parent descriptor are inherited can be controlled with the `extendType` attribute. +[*__since 2.2__*] + +Identifies an optional parent descriptor for this module. For complicated projects composed of many modules that have common configurations or dependencies, inheritance allows modules to share this information. Which parts of the parent descriptor are inherited can be controlled with the `extendType` attribute. Supported `extendType` values are: http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/include.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/include.adoc b/asciidoc/ivyfile/include.adoc index eaabc6f..891532f 100644 --- a/asciidoc/ivyfile/include.adoc +++ b/asciidoc/ivyfile/include.adoc @@ -19,7 +19,9 @@ *Tag:* include *Parent:* link:../ivyfile/configurations.html[configurations] -Include configurations specified in another file. *__since 1.3__* +[*__since 1.3__*] + +Include configurations specified in another file. The included file should have a `configurations` tag as root tag, which follow the same specification as the link:../ivyfile/configurations.html[configurations] tag of the Ivy file. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/info.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/info.adoc b/asciidoc/ivyfile/info.adoc index 5f6bc66..ce7a247 100644 --- a/asciidoc/ivyfile/info.adoc +++ b/asciidoc/ivyfile/info.adoc @@ -21,7 +21,7 @@ Gives identification and basic information about the module this Ivy file describes. -*__since 1.4__* This tag supports link:../concept.html#extra[extra attributes]. +(*__since 1.4__*) This tag supports link:../concept.html#extra[extra attributes]. == Attributes @@ -30,7 +30,7 @@ Gives identification and basic information about the module this Ivy file descri |Attribute|Description|Required |organisation|the name of the organisation that is the owner of this module.|Yes |module|the name of the module described by this Ivy file.|Yes -|branch|the branch of this module. *__since 1.4__*|No, defaults to the default branch setting, or nothing if no default branch is configured +|branch|the branch of this module. (*__since 1.4__*)|No, defaults to the default branch setting, or nothing if no default branch is configured |revision|the revision of this module.|Yes in repository Ivy files, no in Ivy files to resolve |status|the status of this module. See link:../reference.html[terminology] section for details|No, default to `integration` |publication|the date of publication of this module. It should be given in this format: `yyyyMMddHHmmss`|No, but it's a good practice to set it with delivered Ivy files http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/manager.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/manager.adoc b/asciidoc/ivyfile/manager.adoc index d47ee22..d30035e 100644 --- a/asciidoc/ivyfile/manager.adoc +++ b/asciidoc/ivyfile/manager.adoc @@ -19,7 +19,7 @@ *Tag:* manager *Parent:* link:../ivyfile/conflicts.html[conflicts] -*__(since 2.0)__* the conflicts section is deprecated. Use link:../ivyfile/conflict.html[conflict] instead. +(*__since 2.0__*) the conflicts section is deprecated. Use link:../ivyfile/conflict.html[conflict] instead. Specify a conflict manager for one or several dependencies. @@ -41,5 +41,5 @@ See link:../ivyfile/conflicts.html[Conflict Manager] for details on conflict man |name|the name of the conflict manager to use .2+.^|Exactly one of two |rev|a comma separated list of revisions this conflict manager should select -|matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used *__since 1.3__*|No, defaults to `exactOrRegexp` in pre 1.3 Ivy files, and `exact` in 1.3 and superior +|matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used (*__since 1.3__*)|No, defaults to `exactOrRegexp` in pre 1.3 Ivy files, and `exact` in 1.3 and superior |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/override.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/override.adoc b/asciidoc/ivyfile/override.adoc index 03797ae..4297045 100644 --- a/asciidoc/ivyfile/override.adoc +++ b/asciidoc/ivyfile/override.adoc @@ -19,7 +19,7 @@ *Tag:* override *Parent:* link:../ivyfile/dependencies.html[dependencies] -*__(since 2.0)__* +[*__since 2.0__*] Specify an override mediation rule, overriding the revision and/or branch requested for a transitive dependency. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/ivyfile/publications.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/publications.adoc b/asciidoc/ivyfile/publications.adoc index 70bc7cc..06548b1 100644 --- a/asciidoc/ivyfile/publications.adoc +++ b/asciidoc/ivyfile/publications.adoc @@ -31,7 +31,7 @@ Thus if you have a module which publishes no artifacts (a sort of virtual module |======= |Attribute|Description|Required |defaultconf|comma separated list of public configurations in which artifacts are published by default (when no specific configurations are set on the artifact element). -`$$*$$` wildcard can be used to designate all public configurations of this module. *__since 2.0__*|No, defaults to `$$*$$` +`$$*$$` wildcard can be used to designate all public configurations of this module. (*__since 2.0__*)|No, defaults to `$$*$$` |======= == Child elements http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/moreexamples.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/moreexamples.adoc b/asciidoc/moreexamples.adoc index 015a227..e904c46 100644 --- a/asciidoc/moreexamples.adoc +++ b/asciidoc/moreexamples.adoc @@ -24,17 +24,17 @@ Here are some links which might be interesting: == SAnt -link:http://wiki.hippo.nl/display/OS/SAnt+build+system[SAnt] is an experimental build system based on Ant and Ivy. It can be interesting to use "as is", or to get insight on an interesting approach to manage your builds. +link:https://web.archive.org/web/20091012101947/https://wiki.onehippo.com/display/OS/SAnt+build+system[SAnt] is an experimental build system based on Ant and Ivy. It can be interesting to use "as is", or to get insight on an interesting approach to manage your builds. == Spring Modules -The link:https://springmodules.dev.java.net/[Spring Modules] project build system is based on Ant and Ivy, and it's really interesting to have a look at how a modularized project can take advantage of advanced Ant and Ivy features to make the build simpler. +The link:https://web.archive.org/web/20130613141751/https://java.net/projects/springmodules[Spring Modules] project build system is based on Ant and Ivy, and it's really interesting to have a look at how a modularized project can take advantage of advanced Ant and Ivy features to make the build simpler. == Webwork -The link:http://www.opensymphony.com/webwork/[Webwork project] (which became Struts Action framework) uses Ant+Ivy for their build, and thus makes their framework very easy to use in an Ant+Ivy build system. They have a link:http://wiki.opensymphony.com/display/WW/Dependencies[page documenting how to use Ivy with their framework], which can be an interesting reading, even if you don't plan to use Webwork. +The link:https://web.archive.org/web/20101203144930/http://www.opensymphony.com/webwork/[Webwork project] (which became Struts Action framework) uses Ant+Ivy for their build, and thus makes their framework very easy to use in an Ant+Ivy build system. They have a link:http://wiki.opensymphony.com/display/WW/Dependencies[page documenting how to use Ivy with their framework], which can be an interesting reading, even if you don't plan to use Webwork. == Easing multi-module development http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/bintray.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/bintray.adoc b/asciidoc/resolver/bintray.adoc index dd1d5c5..640d2e3 100644 --- a/asciidoc/resolver/bintray.adoc +++ b/asciidoc/resolver/bintray.adoc @@ -26,6 +26,7 @@ |Handle publish|no |======= +[*__since 2.4__*] This resolver uses Bintray DaaS (Distribution as a Service) platform to retrieve artifacts. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/chain.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/chain.adoc b/asciidoc/resolver/chain.adoc index a228ccb..20f8893 100644 --- a/asciidoc/resolver/chain.adoc +++ b/asciidoc/resolver/chain.adoc @@ -37,7 +37,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute |======= |Attribute|Description|Required |returnFirst|true if the first found should be returned.|No, defaults to false -|dual|true if the chain should behave like a dual chain. *__since 1.3__*|No, defaults to false +|dual|true if the chain should behave like a dual chain. (*__since 1.3__*)|No, defaults to false |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/filesystem.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/filesystem.adoc b/asciidoc/resolver/filesystem.adoc index f1ea725..723e370 100644 --- a/asciidoc/resolver/filesystem.adoc +++ b/asciidoc/resolver/filesystem.adoc @@ -31,20 +31,21 @@ This resolver uses the file system to resolve Ivy files and artifacts. An advant 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 Maven 2 does for groupId. For instance, it will transform the organisation from `com.company` into `com/company` when replacing the token `[organisation]` in your pattern. +(*__since 1.3__*) Using the `m2compatible` attribute, this resolver will convert dots found in organisation into slashes like Maven 2 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). +[*__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. *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. + @@ -53,7 +54,6 @@ Atomic publish is currently limited in several ways: * you should not use revision names ending with `.part` + - The `*transactional*` attribute can be used to configure the atomicity behavior: * auto + @@ -65,7 +65,6 @@ The `*transactional*` attribute can be used to configure the atomicity behavior: * false + don't use transaction at all - == Attributes This resolver shares the link:../settings/resolvers.html#common[common attributes] of standard resolvers. @@ -73,9 +72,9 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|m2compatible|True if this resolver should be Maven 2 compatible, false otherwise *__since 1.3__*|No, defaults to false -|local|True if this resolver should be considered local, false otherwise *__since 1.4__*. See useOrigin attribute on the link:../settings/caches.html[caches] element for details.|No, defaults to true -|transactional|true to force the use of transaction, false to prevent the use of transaction, auto to get transaction when possible *__since 2.0__*. See above for details.|No, defaults to auto +|m2compatible|True if this resolver should be Maven 2 compatible, false otherwise (*__since 1.3__*)|No, defaults to false +|local|True if this resolver should be considered local, false otherwise (*__since 1.4__*). See useOrigin attribute on the link:../settings/caches.html[caches] element for details.|No, defaults to true +|transactional|true to force the use of transaction, false to prevent the use of transaction, auto to get transaction when possible (*__since 2.0__*). See above for details.|No, defaults to auto |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/ibiblio.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/ibiblio.adoc b/asciidoc/resolver/ibiblio.adoc index 2ed7ea8..617b496 100644 --- a/asciidoc/resolver/ibiblio.adoc +++ b/asciidoc/resolver/ibiblio.adoc @@ -29,9 +29,9 @@ 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 Maven 2 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 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 Maven 2 repository. So setting this attribute to `true` is sufficient to use Maven 2 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, xml] ---- @@ -42,7 +42,7 @@ 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. @@ -56,9 +56,9 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute |Attribute|Description|Required |root|the root of the artifact repository.|No, defaults to ${ivy.ibiblio.default.artifact.root} |pattern|a pattern describing the layout of the artifact repository.|No, defaults to ${ivy.ibiblio.default.artifact.pattern} -|m2compatible|True if this resolver should be Maven 2 compatible, false otherwise *__since 1.3__*|No, defaults to false -|usepoms|True if this resolver should use Maven POMs when it is already in m2compatible mode, false otherwise *__since 1.4__*|No, defaults to true -|useMavenMetadata|True if this resolver should use maven-metadata.xml files to list available revisions, false to use directory listing *__since 2.0__*|No, defaults to true +|m2compatible|True if this resolver should be Maven 2 compatible, false otherwise (*__since 1.3__*)|No, defaults to false +|usepoms|True if this resolver should use Maven POMs when it is already in m2compatible mode, false otherwise (*__since 1.4__*)|No, defaults to true +|useMavenMetadata|True if this resolver should use maven-metadata.xml files to list available revisions, false to use directory listing (*__since 2.0__*)|No, defaults to true |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/ivyrep.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/ivyrep.adoc b/asciidoc/resolver/ivyrep.adoc index 46f06da..dd64dee 100644 --- a/asciidoc/resolver/ivyrep.adoc +++ b/asciidoc/resolver/ivyrep.adoc @@ -45,7 +45,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|ivyroot|the root of the Ivy repository.|Yes, but may be provided through ${ivy.ivyrep.default.ivy.root} *__since 2.0__* +|ivyroot|the root of the Ivy repository.|Yes, but may be provided through ${ivy.ivyrep.default.ivy.root} (*__since 2.0__*) |ivypattern|a pattern describing the layout of the Ivy repository.|No, defaults to ${ivy.ivyrep.default.ivy.pattern} |artroot|the root of the artifacts repository.|No, defaults to ${ivy.ivyrep.default.artifact.root} |artpattern|a pattern describing the layout of the artifacts repository.|No, defaults to ${ivy.ivyrep.default.artifact pattern} http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/jar.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/jar.adoc b/asciidoc/resolver/jar.adoc index 581e36c..fc51a51 100644 --- a/asciidoc/resolver/jar.adoc +++ b/asciidoc/resolver/jar.adoc @@ -26,8 +26,7 @@ |Handle publish|no |======= - -*__since 2.3__* +[*__since 2.3__*] This resolver uses a specified jar resolve Ivy files and artifacts. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/mirrored.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/mirrored.adoc b/asciidoc/resolver/mirrored.adoc index 8be2d96..fc6a900 100644 --- a/asciidoc/resolver/mirrored.adoc +++ b/asciidoc/resolver/mirrored.adoc @@ -27,7 +27,7 @@ |======= -*__since 2.3__* +[*__since 2.3__*] This resolver can resolve dependencies against several mirrors of the same repository. From a list of mirror URLs, it will iteratively try to resolve the dependencies against each one. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/obr.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/obr.adoc b/asciidoc/resolver/obr.adoc index d33bbb3..c087a8a 100644 --- a/asciidoc/resolver/obr.adoc +++ b/asciidoc/resolver/obr.adoc @@ -27,7 +27,7 @@ |======= -*__since 2.3__* +[*__since 2.3__*] This resolver is one of the resolver which supports link:../osgi.html[OSGi™] dependencies. A part of the OSGi specification defines OBR (OSGi Bundle Repository). OBR aggregates the OSGi metadata of every bundle included in a repository. So contrary to the other resolvers, this resolver needs to get the descriptor of the repository (an obr.xml) before starting to resolve modules. @@ -55,7 +55,6 @@ The requirement strategy is defining how the resolver should behave when facing * if the requirement strategy is `noambiguity`, Ivy will make the resolution fail. + - == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/osgiagg.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/osgiagg.adoc b/asciidoc/resolver/osgiagg.adoc index 6cf33b3..02f89ed 100644 --- a/asciidoc/resolver/osgiagg.adoc +++ b/asciidoc/resolver/osgiagg.adoc @@ -27,7 +27,7 @@ |======= -*__since 2.4__* +[*__since 2.4__*] This resolver is one of the resolvers which support link:../osgi.html[OSGi™] dependencies. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/packager.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/packager.adoc b/asciidoc/resolver/packager.adoc index 5580431..d4c2764 100644 --- a/asciidoc/resolver/packager.adoc +++ b/asciidoc/resolver/packager.adoc @@ -27,7 +27,7 @@ |======= -*__Since 2.0__*. +(*__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. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/sftp.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/sftp.adoc b/asciidoc/resolver/sftp.adoc index cdb0090..c58090d 100644 --- a/asciidoc/resolver/sftp.adoc +++ b/asciidoc/resolver/sftp.adoc @@ -26,7 +26,7 @@ |Handle publish|yes |======= -*__since 1.4__* +[*__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. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/ssh.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/ssh.adoc b/asciidoc/resolver/ssh.adoc index 02c7ee8..98fe6e3 100644 --- a/asciidoc/resolver/ssh.adoc +++ b/asciidoc/resolver/ssh.adoc @@ -26,7 +26,7 @@ |Handle publish|yes |======= -*__since 1.4__* +[*__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. @@ -48,7 +48,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute |host|The host to connect to|No, defaults to host given on the patterns, fail if none is set |port|The port to connect to|No, defaults to 22 |sshConfig|Path to an OpenSSH-style config file containing additional configuration|No -|publishPermissions|A four digit string (e.g., 0644, see "man chmod", "man open") specifying the permissions of the published files. *__(since 2.0)__* +|publishPermissions|A four digit string (e.g., 0644, see "man chmod", "man open") specifying the permissions of the published files. (*__since 2.0__*) |No, defaults to scp standard behaviour |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/updatesite.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/updatesite.adoc b/asciidoc/resolver/updatesite.adoc index aa5182e..92a3822 100644 --- a/asciidoc/resolver/updatesite.adoc +++ b/asciidoc/resolver/updatesite.adoc @@ -27,7 +27,7 @@ |======= -*__since 2.3__* +[*__since 2.3__*] This resolver is one of the resolvers which support link:../osgi.html[OSGi™] dependencies. It resolves modules (OSGi bundles) which are hosted in an Eclipse™ update site. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/url.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/url.adoc b/asciidoc/resolver/url.adoc index f8b7faf..c4bcf6c 100644 --- a/asciidoc/resolver/url.adoc +++ b/asciidoc/resolver/url.adoc @@ -39,7 +39,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|m2compatible|True if this resolver should be Maven 2 compatible, false otherwise *__since 1.3__*|No, defaults to false +|m2compatible|True if this resolver should be Maven 2 compatible, false otherwise (*__since 1.3__*)|No, defaults to false |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/resolver/vfs.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/resolver/vfs.adoc b/asciidoc/resolver/vfs.adoc index 0a77893..c320579 100644 --- a/asciidoc/resolver/vfs.adoc +++ b/asciidoc/resolver/vfs.adoc @@ -26,7 +26,9 @@ |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__* +[*__since 1.4__*] + +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, ... == Attributes http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings.adoc b/asciidoc/settings.adoc index 179163e..99edfbe 100644 --- a/asciidoc/settings.adoc +++ b/asciidoc/settings.adoc @@ -63,7 +63,7 @@ Some useful variables are available for use 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: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. +(*__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 http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/caches.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/caches.adoc b/asciidoc/settings/caches.adoc index f156f19..c55e2dc 100644 --- a/asciidoc/settings/caches.adoc +++ b/asciidoc/settings/caches.adoc @@ -21,8 +21,9 @@ *Tag:* caches -Configures the Ivy cache system. *__since 2.0__*. +[*__since 2.0__*] +Configures the Ivy cache system. See link:../concept.html#cache[cache concept] for details on the Ivy cache concept. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/caches/cache.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/caches/cache.adoc b/asciidoc/settings/caches/cache.adoc index 0313719..8cb31c3 100644 --- a/asciidoc/settings/caches/cache.adoc +++ b/asciidoc/settings/caches/cache.adoc @@ -21,7 +21,7 @@ *Tag:* cache -*__Since 2.0__*. +[*__since 2.0__*] Defines a repository cache instance based on the default repository cache implementation. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/caches/ttl.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/caches/ttl.adoc b/asciidoc/settings/caches/ttl.adoc index 5a8a092..acac5c8 100644 --- a/asciidoc/settings/caches/ttl.adoc +++ b/asciidoc/settings/caches/ttl.adoc @@ -21,7 +21,7 @@ *Tag:* ttl -*__Since 2.0__* +[*__since 2.0__*] Defines a TTL (Time To Live) rule for resolved revision caching. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/classpath.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/classpath.adoc b/asciidoc/settings/classpath.adoc index 3d20a4d..94f9d89 100644 --- a/asciidoc/settings/classpath.adoc +++ b/asciidoc/settings/classpath.adoc @@ -21,7 +21,9 @@ *Tag:* classpath -Includes a jar in the classpath used to load plugins. *__since 1.4__* +[*__since 1.4__*] + +Includes a jar in the classpath used to load plugins. This lets you add Ivy plugins without relying on an external classpath (the Ant classpath, for instance), therefore easing the use of Ivy in multiple execution environments (Ant, standalone, IDE plugins, ...). http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/credentials.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/credentials.adoc b/asciidoc/settings/credentials.adoc index e1c242e..c7616c7 100644 --- a/asciidoc/settings/credentials.adoc +++ b/asciidoc/settings/credentials.adoc @@ -21,7 +21,9 @@ *Tag:* credentials -Configures HTTP authentication credentials. *__since 2.0__*. +[*__since 2.0__*] + +Configures HTTP authentication credentials. == Attributes http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/include.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/include.adoc b/asciidoc/settings/include.adoc index ebe142d..7d279cf 100644 --- a/asciidoc/settings/include.adoc +++ b/asciidoc/settings/include.adoc @@ -21,8 +21,9 @@ *Tag:* include -Includes another Ivy settings file as if it were part of this one. *__since 1.3__* +[*__since 1.3__*] +Includes another Ivy settings file as if it were part of this one. The included Ivy settings file has to be a complete well formed Ivy settings file, i.e. it does have to include the `<ivysettings>` tag. @@ -35,7 +36,7 @@ The included Ivy settings file has to be a complete well formed Ivy settings fil |Attribute|Description|Required |url|a URL to the Ivy settings file to include|Yes, unless file is specified |file|a path to the Ivy settings file to include|Yes, unless url is specified -|optional|indicates whether Ivy should throw an error if the specified file doesn't exist. *__(Since 2.4)__*.|No, default to false +|optional|indicates whether Ivy should throw an error if the specified file doesn't exist (*__since 2.4__*).|No, default to false |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/latest-strategies.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/latest-strategies.adoc b/asciidoc/settings/latest-strategies.adoc index 5e6226c..793ea11 100644 --- a/asciidoc/settings/latest-strategies.adoc +++ b/asciidoc/settings/latest-strategies.adoc @@ -53,7 +53,9 @@ This algorithm takes into account the special meaning of some text. For instance == latest-revision -*__since 1.4__* The latest-revision can now be configured to handle more words with special meanings than the one defined in PHP `version_compare` function. +[*__since 1.4__*] + +The latest-revision can now be configured to handle more words with special meanings than the one defined in PHP `version_compare` function. Here is an example of how you can do so: http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/lock-strategies.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/lock-strategies.adoc b/asciidoc/settings/lock-strategies.adoc index 971cf53..9c2480a 100644 --- a/asciidoc/settings/lock-strategies.adoc +++ b/asciidoc/settings/lock-strategies.adoc @@ -21,8 +21,7 @@ *Tag:* lock-strategies -*__since 2.0__* - +[*__since 2.0__*] Defines a list of lock strategies usable in Ivy. @@ -30,17 +29,15 @@ A lock strategy is used by a cache manager to decide when and how locking should The following strategies are registered by default: - * *no-lock* + This lock strategy actually performs no locking at all, and thus should not be used in an environment where the cache is shared by multiple processes. - * *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). -* *artifact-lock-nio (__since 2.4__)* + +* *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`. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/macrodef.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/macrodef.adoc b/asciidoc/settings/macrodef.adoc index 589ecef..faef35f 100644 --- a/asciidoc/settings/macrodef.adoc +++ b/asciidoc/settings/macrodef.adoc @@ -21,7 +21,9 @@ *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__* +[*__since 1.3__*] + +Defines a new dependency resolver type based upon another. This definition is very similar to the macrodef feature of Ant for defining macro tasks. This task eases the process of creating a new dependency resolver, because it avoids writing Java code.
