fix the asciidoc files for the "Ivy File" section
Project: http://git-wip-us.apache.org/repos/asf/ant-ivy/repo Commit: http://git-wip-us.apache.org/repos/asf/ant-ivy/commit/7428f5fd Tree: http://git-wip-us.apache.org/repos/asf/ant-ivy/tree/7428f5fd Diff: http://git-wip-us.apache.org/repos/asf/ant-ivy/diff/7428f5fd Branch: refs/heads/master Commit: 7428f5fd1ecbcee82e1bf64db7eaba67b196c12f Parents: bddf82b Author: Nicolas LaleveÌe <nicolas.lale...@hibnet.org> Authored: Sun Jun 25 00:59:46 2017 +0200 Committer: Nicolas LaleveÌe <nicolas.lale...@hibnet.org> Committed: Sun Jun 25 00:59:46 2017 +0200 ---------------------------------------------------------------------- asciidoc/ivyfile.adoc | 2 +- asciidoc/ivyfile/artifact-conf.adoc | 3 +- asciidoc/ivyfile/artifact-exclude.adoc | 12 +-- asciidoc/ivyfile/artifact.adoc | 6 +- asciidoc/ivyfile/conf.adoc | 10 +-- asciidoc/ivyfile/configurations.adoc | 115 +++---------------------- asciidoc/ivyfile/conflict.adoc | 4 +- asciidoc/ivyfile/conflicts.adoc | 3 +- asciidoc/ivyfile/dependencies.adoc | 4 +- asciidoc/ivyfile/dependency-artifact.adoc | 4 +- asciidoc/ivyfile/dependency-conf.adoc | 5 +- asciidoc/ivyfile/dependency-include.adoc | 6 +- asciidoc/ivyfile/dependency.adoc | 64 +++++++------- asciidoc/ivyfile/exclude.adoc | 10 +-- asciidoc/ivyfile/extends.adoc | 4 +- asciidoc/ivyfile/info.adoc | 3 +- asciidoc/ivyfile/manager.adoc | 5 +- asciidoc/ivyfile/mapped.adoc | 3 +- asciidoc/ivyfile/override.adoc | 4 +- asciidoc/ivyfile/publications.adoc | 5 +- 20 files changed, 85 insertions(+), 187 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile.adoc b/asciidoc/ivyfile.adoc index 843ddd0..23722ec 100644 --- a/asciidoc/ivyfile.adoc +++ b/asciidoc/ivyfile.adoc @@ -39,7 +39,7 @@ For those familiar with xml schema, the schema used to validate ivy files can be == Dynamic and [[resolved]]resolved ivy files -A module descriptor (ivy file) is needed both before and after the publication of each revision of the module. Depending on the case, a module descriptor can be either _dynamic_ or _resolved_: +A module descriptor (ivy file) is needed both before and after the publication of each revision of the module. Depending on the case, a module descriptor can be either _dynamic_ or _resolved_. === Dynamic descriptor for module development http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/artifact-conf.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/artifact-conf.adoc b/asciidoc/ivyfile/artifact-conf.adoc index 2ac2c06..1e9e799 100644 --- a/asciidoc/ivyfile/artifact-conf.adoc +++ b/asciidoc/ivyfile/artifact-conf.adoc @@ -12,8 +12,7 @@ Indicates a public configuration in which enclosing artifact is published. |======= |Attribute|Description|Required |name|the name of the module public configuration in which this artifact is published. - '*' wildcard can be used to designate all public configurations of this module|Yes + '`$$*$$`' wildcard can be used to designate all public configurations of this module|Yes |======= - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/artifact-exclude.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/artifact-exclude.adoc b/asciidoc/ivyfile/artifact-exclude.adoc index 760c7ea..5c55961 100644 --- a/asciidoc/ivyfile/artifact-exclude.adoc +++ b/asciidoc/ivyfile/artifact-exclude.adoc @@ -28,21 +28,21 @@ Note that exclusion is always done AFTER inclusion has been done. [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 * -|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 * +|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 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 |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 + '`$$*$$`' wildcard can be used to designate all configurations of this module|No, defaults to '`$$*$$`', unless nested conf are specified |======= == Child elements -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/artifact-exclude-conf.html[conf]|configuration in which the artifact should be excluded|0..n http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/artifact.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/artifact.adoc b/asciidoc/ivyfile/artifact.adoc index 6d74c14..1036081 100644 --- a/asciidoc/ivyfile/artifact.adoc +++ b/asciidoc/ivyfile/artifact.adoc @@ -39,7 +39,7 @@ If this is the only artifact declared, then it's equivalent to having no publica |type|the type of the published artifact. It's usually its extension, but not necessarily. For instance, ivy files are of type 'ivy' but have 'xml' extension|No, defaults to jar |ext|the extension of the published artifact|No, defaults to type |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. + '`$$*$$`' wildcard can be used to designate all public configurations of this module|No, defaults to defaultconf attribute value on parent publications element. |url|a 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 |======= @@ -48,7 +48,7 @@ If this is the only artifact declared, then it's equivalent to having no publica == Child elements -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/artifact-conf.html[conf]|indicates a public configuration in which this artifact is published|0..n @@ -91,4 +91,4 @@ Declares an artifact foo-src, of type 'source' with extension 'zip', and publish ---- -Declares an artifact foo, of type and extension 'jar' located at the url http://www.acme.com/repository/barbaz/foo-1.2-bar.jar. This url will only be used if the artifact cannot be found at its standard location. \ No newline at end of file +Declares an artifact foo, of type and extension 'jar' located at the url http://www.acme.com/repository/barbaz/foo-1.2-bar.jar. This url will only be used if the artifact cannot be found at its standard location. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/conf.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/conf.adoc b/asciidoc/ivyfile/conf.adoc index 2c2c146..b3c8287 100644 --- a/asciidoc/ivyfile/conf.adoc +++ b/asciidoc/ivyfile/conf.adoc @@ -14,9 +14,9 @@ This notion is very helpful to define configurations which are similar with some *__since 1.4__* The extends attribute can use the following wildcards: [cols="15%,50%"] |======= -|*|all other configurations -|*(public)|all other public configurations -|*(private)|all other private configurations +|`*`|all other configurations +|`*(public)`|all other public configurations +|`*(private)`|all other private configurations |======= @@ -41,7 +41,7 @@ This is very useful to build a compile configuration, for instance, forcing 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 |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 + It should be given in this format: `yyyyMMddHHmmss`|No, by default the conf is not deprecated |======= @@ -59,4 +59,4 @@ This is very useful to build a compile configuration, for instance, forcing the ---- Declares three configurations, core compile and runtime, with only the runtime one accessible from other modules, and with the compile one being non transitive. -Therefore the core configuration will only be composed of dependencies declared in the core configuration itself, the compile configuration will be composed of all dependencies required in either core or compile configuration, but without transivity (neither for core nor compile dependencies), and runtime will be composed of all dependencies, all transitively, including the dependencies declared only in compile. \ No newline at end of file +Therefore the core configuration will only be composed of dependencies declared in the core configuration itself, the compile configuration will be composed of all dependencies required in either core or compile configuration, but without transivity (neither for core nor compile dependencies), and runtime will be composed of all dependencies, all transitively, including the dependencies declared only in compile. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/configurations.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/configurations.adoc b/asciidoc/ivyfile/configurations.adoc index 5c6cade..1e876d9 100644 --- a/asciidoc/ivyfile/configurations.adoc +++ b/asciidoc/ivyfile/configurations.adoc @@ -34,7 +34,7 @@ See link:#defaultconfmapping[examples below] to clarify the behavior of these tw == Child elements -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/conf.html[conf]|declares a configuration of this module|0..n @@ -85,110 +85,17 @@ When you now resolve the conf2 configuration, you'll get the other2 dependencies == Examples involving defaultconf and defaultconfmapping The table below indicates how Ivy interprets the conf attribute according to how link:../ivyfile/configurations.html[defaultconfmapping] and link:../ivyfile/configurations.html[defaultconf] are set: -[options="header",cols="15%,50%,18%,18%"] +[options="header",cols="15%,40%,15%,30%"] |======= |defaultconf|defaultconfmapping|conf|ivy interpretation -||| -a| -[source] ----- -*->* ----- - -|||runtime -a| -[source] ----- -runtime->runtime ----- - -|||test -a| -[source] ----- -test->test ----- - -a| -[source] ----- -runtime ----- -|| -a| -[source] ----- -runtime->runtime ----- - -a| -[source] ----- -runtime ----- -a| -[source] ----- -runtime->*;test->default ----- -| -a| -[source] ----- -runtime->* ----- - -a| -[source] ----- -runtime ----- -a| -[source] ----- -runtime->*;test->default ----- -|test|test->default - - -| -a| -[source] ----- -runtime->*;test->default ----- -| -a| -[source] ----- -runtime->*;test->default ----- - -| -a| -[source] ----- -runtime->*;test->default ----- -|runtime -a| -[source] ----- -runtime->* ----- - -| -a| -[source] ----- -runtime->*;test->default ----- -|test -a| -[source] ----- -test->default ----- - +| | | |`$$*->*$$` +| | |`runtime`|`$$runtime->runtime$$` +| | |`test`|`$$test->test$$` +|`runtime`| | |`$$runtime->runtime$$` +|`runtime`|`$$runtime->*;test->default$$`| |`$$runtime->*$$` +|`runtime`|`$$runtime->*;test->default$$`|`test`|`$$test->default$$` +| |`$$runtime->*;test->default$$`| |`$$runtime->*;test->default$$` +| |`$$runtime->*;test->default$$`|`runtime`|`$$runtime->*$$` +| |`$$runtime->*;test->default$$`|`test`|`$$test->default$$` |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/conflict.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/conflict.adoc b/asciidoc/ivyfile/conflict.adoc index 13fa6e9..ef483b1 100644 --- a/asciidoc/ivyfile/conflict.adoc +++ b/asciidoc/ivyfile/conflict.adoc @@ -26,8 +26,8 @@ The current default conflict manager is the "latest-revision" conflict manager. [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|org|the name, or an expression matching the name of organisation to which this conflict manager should apply (see matcher attribute below)|No, defaults to * (match all) -|module|the name, or an expression matching the name of module to which this conflict manager should apply (see matcher attribute below)|No, defaults to * (match all) +|org|the name, or an expression matching the name of organisation to which this conflict manager should apply (see matcher attribute below)|No, defaults to '`$$*$$`' (match all) +|module|the name, or an expression matching the name of module to which this conflict manager should apply (see matcher attribute below)|No, defaults to '`$$*$$`' (match all) |manager|the name of the conflict manager to use|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|No, defaults to exact http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/conflicts.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/conflicts.adoc b/asciidoc/ivyfile/conflicts.adoc index 9c063df..79ef673 100644 --- a/asciidoc/ivyfile/conflicts.adoc +++ b/asciidoc/ivyfile/conflicts.adoc @@ -41,11 +41,10 @@ The current default conflict manager is the "latest-revision" conflict manager. == Child elements -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/manager.html[manager]|declares a conflict manager for this module|1..n |======= - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/dependencies.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependencies.adoc b/asciidoc/ivyfile/dependencies.adoc index 8e722ea..c0f16ab 100644 --- a/asciidoc/ivyfile/dependencies.adoc +++ b/asciidoc/ivyfile/dependencies.adoc @@ -31,7 +31,7 @@ In Ivy 2.1.0 and earlier, if both defaultconf and defaultconfmapping are defined [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 *->* +|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 |======= @@ -42,7 +42,7 @@ In Ivy 2.1.0 and earlier, if both defaultconf and defaultconfmapping are defined Note: as specified by the ivy.xsd, the children elements are ordered; must come first the `link:../ivyfile/dependency.html[dependency]` elements, then the `link:../ivyfile/exclude.html[exclude]` elements, then the `link:../ivyfile/override.html[override]` elements, and then the `link:../ivyfile/conflict.html[conflict]` elements. -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/dependency.html[dependency]|declares a dependency for this module|0..n http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/dependency-artifact.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependency-artifact.adoc b/asciidoc/ivyfile/dependency-artifact.adoc index 6b56350..abcf1a3 100644 --- a/asciidoc/ivyfile/dependency-artifact.adoc +++ b/asciidoc/ivyfile/dependency-artifact.adoc @@ -47,7 +47,7 @@ Example: == Child elements -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/dependency-artifact-conf.html[conf]|configuration in which the artifact should be included|0..n @@ -97,4 +97,4 @@ Same as above, except that if the artifact is not found at its standard location ---- -Declares a dependency on module bar for which all artifacts declared will be used (thanks to the include tag) plus an artifact baz of type source and ext jar (which is not declared in module bar module descriptor). \ No newline at end of file +Declares a dependency on module bar for which all artifacts declared will be used (thanks to the include tag) plus an artifact baz of type source and ext jar (which is not declared in module bar module descriptor). http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/dependency-conf.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependency-conf.adoc b/asciidoc/ivyfile/dependency-conf.adoc index f4e5209..8e5203a 100644 --- a/asciidoc/ivyfile/dependency-conf.adoc +++ b/asciidoc/ivyfile/dependency-conf.adoc @@ -14,7 +14,7 @@ in dependency element. |======= |Attribute|Description|Required |name|the name of the master configuration to map. - '*' wildcard can be used to designate all configurations of this module|Yes + '`$$*$$`' wildcard can be used to designate all configurations of this module|Yes |mapped|a comma separated list of dependency configurations to which this master configuration should be mapped|No, default to the same configuration as master one, unless nested mapped elements are specified |======= @@ -23,11 +23,10 @@ in dependency element. == Child elements -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/mapped.html[mapped]|map dependency configurations for this master configuration|0..n |======= - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/dependency-include.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependency-include.adoc b/asciidoc/ivyfile/dependency-include.adoc index cca23ca..35b723b 100644 --- a/asciidoc/ivyfile/dependency-include.adoc +++ b/asciidoc/ivyfile/dependency-include.adoc @@ -27,12 +27,12 @@ Example: [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|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 .* +|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 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 |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 + '`$$*$$`' 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/7428f5fd/asciidoc/ivyfile/dependency.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/dependency.adoc b/asciidoc/ivyfile/dependency.adoc index b1971d3..0cd2dd0 100644 --- a/asciidoc/ivyfile/dependency.adoc +++ b/asciidoc/ivyfile/dependency.adoc @@ -9,31 +9,28 @@ Declares a dependency for this module. A dependency is described by the module o The revision can be given as a fixed one (1.5.2, for instance) or as a latest (or dynamic) one. Several possibilities for dynamic revisions are implemented in Ivy: -* latest.integration + +* `latest.integration` + selects the latest revision of the dependency module. -* latest.[any status] *__since 1.4__* + - selects the latest revision of the dependency module with at least the specified status. - +* `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 selects 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. - -* end the revision with a + + +* end the revision with a '`+`' + 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__* + - 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 -[1.0,2.0[ matches all versions greater or equal to 1.0 and lower than 2.0 -]1.0,2.0] matches all versions greater than 1.0 and lower or equal to 2.0 -]1.0,2.0[ matches all versions greater than 1.0 and lower than 2.0 -[1.0,) matches all versions greater or equal to 1.0 -]1.0,) matches all versions greater than 1.0 -(,2.0] matches all versions lower or equal to 2.0 -(,2.0[ matches all versions lower than 2.0 + 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 + +`[1.0,2.0[` matches all versions greater or equal to 1.0 and lower than 2.0 + +`]1.0,2.0]` matches all versions greater than 1.0 and lower or equal to 2.0 + +`]1.0,2.0[` matches all versions greater than 1.0 and lower than 2.0 + +`[1.0,)` matches all versions greater or equal to 1.0 + +`]1.0,)` matches all versions greater than 1.0 + +`(,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]. 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. @@ -57,34 +54,33 @@ The first way to declare this mapping is called the inline mapping. It is maybe * Specify one configuration name + - This means that in this master configuration the same dependency configuration is needed (except if a defaultconfmapping has been specified in this ivy file, see link:../ivyfile/configurations.html[configurations] for details, or table below for examples). -For instance, if the current module has defined a configuration named 'runtime', and the dependency too, then having an inline mapping configuration set to 'runtime' means that in the runtime master configuration the runtime dependency configuration is required. - + This means that in this master configuration the same dependency configuration is needed (except if a `defaultconfmapping` has been specified in this ivy file, see link:../ivyfile/configurations.html[configurations] for details, or table below for examples). +For instance, if the current module has defined a configuration named '`runtime`', and the dependency too, then having an inline mapping configuration set to '`runtime`' means that in the runtime master configuration the runtime dependency configuration is required. + The link:../ivyfile/configurations.html#defaultconfmapping[examples on the dependency on the configurations page] explain how ivy interprets the conf attribute according to how link:../ivyfile/configurations.html[defaultconfmapping] and link:../ivyfile/configurations.html[defaultconf] is set. -* Specify a configuration mapping using the '->' operator separating a comma separated list of master configurations (left operand) of a comma separated list of dependency configurations (right operand). + -A good way to remember which side is for the master configuration (i.e. the configuration of the module defining the dependency) and which side is for the dependency configuration is to read the '->' as 'depends on'. +* Specify a configuration mapping using the `$$->$$` operator separating a comma separated list of master configurations (left operand) of a comma separated list of dependency configurations (right operand). + +A good way to remember which side is for the master configuration (i.e. the configuration of the module defining the dependency) and which side is for the dependency configuration is to read the '$$->$$' as 'depends on'. In this case, all specified dependency configurations are required in all specified master configurations. -For instance, 'A, B, C -> E, F' means that dependency configurations E & F are required in master configurations A, B and C. +For instance, `$$A, B, C -> E, F$$` means that dependency configurations E and F are required in master configurations A, B and C. -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. +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). +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 usefull when you only have a specific mapping for some configurations and a default mapping for all the others. +*__since 1.4__* '`%`' can be used as left side operand to mean 'all the other configurations'. This can be usefull when you only have a specific mapping for some configurations and a default mapping for all the others. Example: @@ -147,11 +143,11 @@ 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 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. 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. +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. @@ -230,7 +226,7 @@ conf for dependencies of organisation 'B'. * Specify a semi-column separated list of any of the previous specs. + - In this case, it is the union of the mapping which is kept. For instance, 'A -> B; * -> C' means that B conf is needed in A conf and C conf is need in all master conf... so both B & C dep conf are required in A master conf + In this case, it is the union of the mapping which is kept. For instance, '`$$A -> B; * -> C$$`' means that B conf is needed in A conf and C conf is need in all master conf... so both B & C dep conf are required in A master conf If you prefer more verbose mapping declaration, everything is also possible with sub elements mapping declaration. @@ -272,7 +268,7 @@ See link:../ivyfile/conflicts.html[conflicts manager] for details. == Child elements -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/dependency-conf.html[conf]|defines configuration mapping has sub element|0..n @@ -406,4 +402,4 @@ changing="true" default ---- -conf will be used. \ No newline at end of file +conf will be used. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/exclude.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/exclude.adoc b/asciidoc/ivyfile/exclude.adoc index 4300f90..0521448 100644 --- a/asciidoc/ivyfile/exclude.adoc +++ b/asciidoc/ivyfile/exclude.adoc @@ -13,12 +13,12 @@ It is very similar to the link:../ivyfile/artifact-exclude.html[dependency exclu [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|org|the organization of the dependency module or artifact to exclude, or a regexp matching this organization|No, defaults to * -|module|the name of the dependency module or the artifact to exclude, or a regexp matching this module name|No, defaults to * -|artifact|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 * +|org|the organization of the dependency module or artifact to exclude, or a regexp matching this organization|No, defaults to '`$$*$$`' +|module|the name of the dependency module or the artifact to exclude, or a regexp matching this module name|No, defaults to '`$$*$$`' +|artifact|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 type |matcher|the link:../concept.html#matcher[matcher] to use to match the modules to excludes|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 + '`$$*$$`' 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/7428f5fd/asciidoc/ivyfile/extends.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/extends.adoc b/asciidoc/ivyfile/extends.adoc index ad514e1..4cd927f 100644 --- a/asciidoc/ivyfile/extends.adoc +++ b/asciidoc/ivyfile/extends.adoc @@ -1,7 +1,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. Supported __extendType__ values are: +*__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: [options="header",cols="15%,50%"] |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/info.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/info.adoc b/asciidoc/ivyfile/info.adoc index 8744ccf..e5f4c6a 100644 --- a/asciidoc/ivyfile/info.adoc +++ b/asciidoc/ivyfile/info.adoc @@ -24,7 +24,7 @@ Gives identification and basic information about the module this ivy file descri == Child elements -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/extends.html[extends]|identifies a parent Ivy file from which this descriptor inherits content|0..n @@ -36,4 +36,3 @@ Gives identification and basic information about the module this ivy file descri After the description, you can also place your own tags in your own namespace. This allow to provide some custom information about the module. - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/manager.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/manager.adoc b/asciidoc/ivyfile/manager.adoc index 0dab30e..9e2efc2 100644 --- a/asciidoc/ivyfile/manager.adoc +++ b/asciidoc/ivyfile/manager.adoc @@ -23,12 +23,11 @@ See link:../ivyfile/conflicts.html[Conflicts Manager] for details on conflicts m [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|org|the name, or an expression matching the name of organisation to which this conflict manager should apply (see matcher attribute below)|No, defaults to * (match all) -|module|the name, or an expression matching the name of module to which this conflict manager should apply (see matcher attribute below)|No, defaults to * (match all) +|org|the name, or an expression matching the name of organisation to which this conflict manager should apply (see matcher attribute below)|No, defaults to '`$$*$$`' (match all) +|module|the name, or an expression matching the name of module to which this conflict manager should apply (see matcher attribute below)|No, defaults to '`$$*$$`' (match all) |name|the name of the conflict manager to use|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 |======= - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/mapped.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/mapped.adoc b/asciidoc/ivyfile/mapped.adoc index 9dce4f9..b397c4d 100644 --- a/asciidoc/ivyfile/mapped.adoc +++ b/asciidoc/ivyfile/mapped.adoc @@ -13,8 +13,7 @@ Describes a mapped dependency configuration for a master configuration. |======= |Attribute|Description|Required |name|the name of the dependency configuration mapped. - '*' wildcard can be used to designate all configurations of this module|Yes + '`$$*$$`' wildcard can be used to designate all configurations of this module|Yes |======= - \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/override.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/override.adoc b/asciidoc/ivyfile/override.adoc index d2f3ae3..1a3bc0e 100644 --- a/asciidoc/ivyfile/override.adoc +++ b/asciidoc/ivyfile/override.adoc @@ -20,8 +20,8 @@ Note that even though no attribute is required, it makes no sense to set no attr [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|org|the name, or an expression matching the name of organisation to which overriding should be applied (see matcher attribute below)|No, defaults to * (match all) -|module|the name, or an expression matching the name of module to which overriding should be applied (see matcher attribute below)|No, defaults to * (match all) +|org|the name, or an expression matching the name of organisation to which overriding should be applied (see matcher attribute below)|No, defaults to '`$$*$$`' (match all) +|module|the name, or an expression matching the name of module to which overriding should be applied (see matcher attribute below)|No, defaults to '`$$*$$`' (match all) |branch|the branch to set for all the overriden dependency descriptors|No, by default branch is not overriden |rev|the revision to set for all the overriden dependency descriptors|No, by default revision is not overriden |matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used|No, defaults to exact http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/7428f5fd/asciidoc/ivyfile/publications.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/ivyfile/publications.adoc b/asciidoc/ivyfile/publications.adoc index fdd510d..f23ccac 100644 --- a/asciidoc/ivyfile/publications.adoc +++ b/asciidoc/ivyfile/publications.adoc @@ -17,18 +17,17 @@ 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 -[options="header"] +[options="header",cols="20%,60%,20%"] |======= |Element|Description|Cardinality |link:../ivyfile/artifact.html[artifact]|declares a published artifact for this module|0..n |======= - \ No newline at end of file
