http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/module.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/module.adoc b/asciidoc/settings/module.adoc index e96c718..606db3f 100644 --- a/asciidoc/settings/module.adoc +++ b/asciidoc/settings/module.adoc @@ -48,13 +48,13 @@ For each module set, you can configure: |Attribute|Description|Required |organisation|the organisation to match to apply the rule.|No, defaults to * |name|the module's name to match to apply the rule.|No, defaults to * -|revision|the module's revision to match to apply the rule. Note that the version may not be resolved yet (be `latest.integration`, for instance), so be very careful when using this attribute. *__since 2.0__*|No, defaults to * -|_any extra attribute_|an extra attribute to match to apply the rule. *__since 2.0__*|No, defaults to * -|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to which the resolver should be applied *__since 1.3__*|No, defaults to exactOrRegexp +|revision|the module's revision to match to apply the rule. Note that the version may not be resolved yet (be `latest.integration`, for instance), so be very careful when using this attribute (*__since 2.0__*).|No, defaults to * +|_any extra attribute_|an extra attribute to match to apply the rule (*__since 2.0__*).|No, defaults to * +|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to which the resolver should be applied (*__since 1.3__*).|No, defaults to exactOrRegexp |resolver|the name of the resolver to apply. The resolver must have been defined in the resolvers section of the settings file.|No -|conflict-manager|the name of the conflict manager to apply. *__since 1.4__*|No -|branch|the default branch to apply. *__since 1.4__*|No -|resolveMode|the resolve mode to use. *__since 2.0__*|No +|conflict-manager|the name of the conflict manager to apply (*__since 1.4__*).|No +|branch|the default branch to apply (*__since 1.4__*).|No +|resolveMode|the resolve mode to use (*__since 2.0__*).|No |=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/properties.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/properties.adoc b/asciidoc/settings/properties.adoc index 562b52a..463e200 100644 --- a/asciidoc/settings/properties.adoc +++ b/asciidoc/settings/properties.adoc @@ -24,7 +24,7 @@ Loads a properties file into Ivy variables. See the variables chapter above for details about Ivy variables. -*__Since 2.0__*: it is possible to access environment variables. This can be done by specifying the environment attribute. This attribute specifies the prefix which can be used to access these environment variables. For instance, if you specify `environment="env"`, you can access the `PATH` environment variable with the `env.PATH` property name. +(*__since 2.0__*) It is possible to access environment variables. This can be done by specifying the environment attribute. This attribute specifies the prefix which can be used to access these environment variables. For instance, if you specify `environment="env"`, you can access the `PATH` environment variable with the `env.PATH` property name. == Attributes @@ -35,6 +35,6 @@ Loads a properties file into Ivy variables. See the variables chapter above for |Attribute|Description|Required |file|a path to a properties file to load .2+|One of these -|environment|the prefix to use when retrieving environment variables *__(since 2.0)__* -|override|indicates if the variable found in the properties file should override its previous value, if any *__(since 1.3)__*|No, defaults to true +|environment|the prefix to use when retrieving environment variables (*__since 2.0__*) +|override|indicates if the variable found in the properties file should override its previous value, if any (*__since 1.3__*)|No, defaults to true |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/property.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/property.adoc b/asciidoc/settings/property.adoc index a1ba6f9..5cd0c2e 100644 --- a/asciidoc/settings/property.adoc +++ b/asciidoc/settings/property.adoc @@ -23,7 +23,7 @@ Defines an Ivy variable. -*__since 1.3__*: The optional override attribute enables you to avoid overriding the previous value of the variable, which makes the definition to behave like an Ant property, which is particularly useful to define default values (values which are used only if they haven't been defined yet). +(*__since 1.3__*) The optional override attribute enables you to avoid overriding the previous value of the variable, which makes the definition to behave like an Ant property, which is particularly useful to define default values (values which are used only if they haven't been defined yet). == Attributes @@ -34,8 +34,8 @@ Defines an Ivy variable. |name|the name of the variable to define|Yes |value|the new value the variable must take|Yes |override|true if the previous value (if any) of the variable should overridden, false otherwise|No, defaults to true -|ifset|the variable will be set only if the provided 'ifset' variable is already set (Since 2.4)|No -|unlessset|the variable will not be set unless the provided 'unlessset' variable is set (Since 2.4)|No +|ifset|the variable will be set only if the provided 'ifset' variable is already set (*__since 2.4__*)|No +|unlessset|the variable will not be set unless the provided 'unlessset' variable is set (*__since 2.4__*)|No |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/resolvers.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/resolvers.adoc b/asciidoc/settings/resolvers.adoc index 541eba9..a81bd58 100644 --- a/asciidoc/settings/resolvers.adoc +++ b/asciidoc/settings/resolvers.adoc @@ -25,7 +25,7 @@ Defines a list of dependency resolvers usable in Ivy. Each dependency resolver i The child tag used for the dependency resolver must be equal to a name of a dependency resolver type (either built-in or added with the typedef tag). -*__since 1.3__* Once defined, resolvers can be referenced by their name, using the following syntax: +(*__since 1.3__*) Once defined, resolvers can be referenced by their name, using the following syntax: [source, xml] ---- @@ -101,12 +101,11 @@ The `checksums` attribute is used to define the list of checksums files to use t Any standard resolver can be used in `force` mode, which is used mainly to handle local development builds. In force mode, the resolver attempts to find a dependency whatever the requested revision is (internally it replace the requested revision by `latest.integration`), and if it finds one, it forces this revision to be returned, even when used in a chain with `returnFirst=false`. -By using such a resolver at the beginning of a chain, you can be sure that Ivy will pick up whatever module is available in this resolver (usually a private local build) instead of the real requested revision. This allows to handle use case like a developer working on modules `A` and `C`, where `A -> B -> C`, and pick up the local build for `C` without having to publish a local version of `B`. -*__since 2.0__* +By using such a resolver at the beginning of a chain, you can be sure that Ivy will pick up whatever module is available in this resolver (usually a private local build) instead of the real requested revision. This allows to handle use case like a developer working on modules `A` and `C`, where `A -> B -> C`, and pick up the local build for `C` without having to publish a local version of `B`. (*__since 2.0__*) ==== timeoutConstraint -*__since 2.5__* +[*__since 2.5__*] All standard resolvers support the `timeoutConstraint` attribute. The value for this attribute is the name of the link:timeout-constraint.html[timeout-constraint] that's been defined in the Ivy settings. @@ -114,36 +113,33 @@ Resolvers can be optionally configured to use a `timeoutConstraint` so that the ==== Maven - Any resolver which is able to parse a Maven pom.xml file has to detect the related sources or javadocs artifacts. This often involves several network connections even if neither the sources nor the javadoc are requested to be downloaded. -*__since 2.5__* Setting the property `ivy.maven.lookup.sources` to `false` disables the lookup of the sources artifact. +(*__since 2.5__*) Setting the property `ivy.maven.lookup.sources` to `false` disables the lookup of the sources artifact. And setting the property `ivy.maven.lookup.javadoc` to `false` disables the lookup of the javadoc artifact. - === Attributes - [options="header",cols="15%,50%,12%,12%,12%"] |======= |Attribute|Description|Required|Composite|Standard |name|the name which identifies the resolver|Yes|Yes|Yes |validate|indicates if resolved Ivy files should be validated against Ivy XSD|No, defaults to call setting|Yes|Yes -|force|Indicates if this resolver should be used in force mode (see above). *__since 2.0__*|No, defaults to false|No|Yes +|force|Indicates if this resolver should be used in force mode (see above). (*__since 2.0__*)|No, defaults to false|No|Yes |checkmodified|Indicates if this resolver should check lastmodified date to know if an Ivy file is up to date.|No, defaults to ${ivy.resolver.default.check.modified}|No|Yes -|changingPattern|Indicates for which revision pattern this resolver should check lastmodified date to know if an artifact file is up to date. *__since 1.4__*. See link:../concept.html#change[cache and change management] for details.|No, defaults to none|Yes|Yes -|changingMatcher|The name of the link:../concept.html#matcher[pattern matcher] to use to match a revision against the configured changingPattern. *__since 1.4__*. See link:../concept.html#change[cache and change management] for details.|No, defaults to exactOrRegexp|Yes|Yes -|alwaysCheckExactRevision|Indicates if this resolver should check the given revision even if it's a special one (like latest.integration). *__since 1.3__*|No, defaults to ${ivy.default.always.check.exact.revision}|No|Yes -|namespace|The name of the namespace to which this resolver belongs *__since 1.3__*|No, defaults to 'system'|Yes|Yes -|checkconsistency|true to check consistency of module descriptors found by this resolver, false to avoid consistency check *__since 1.3__*|No, defaults to true|No|Yes -|descriptor|'optional' if a module descriptor (usually an Ivy file) is optional for this resolver, 'required' to refuse modules without module descriptor *__since 2.0__*|No, defaults to 'optional'|No (except dual)|Yes -|allownomd|__Deprecated. Use descriptor="required \| optional" instead.__ - true if the absence of module descriptor (usually an Ivy file) is authorised for this resolver, false to refuse modules without module descriptor *__since 1.4__*|No, defaults to true|No (except dual)|Yes -|checksums|a comma separated list of link:../concept.html#checksum[checksum algorithms] to use both for publication and checking *__since 1.4__*|No, defaults to ${ivy.checksums}|No|Yes +|changingPattern|Indicates for which revision pattern this resolver should check lastmodified date to know if an artifact file is up to date (*__since 1.4__*). See link:../concept.html#change[cache and change management] for details.|No, defaults to none|Yes|Yes +|changingMatcher|The name of the link:../concept.html#matcher[pattern matcher] to use to match a revision against the configured changingPattern (*__since 1.4__*). See link:../concept.html#change[cache and change management] for details.|No, defaults to exactOrRegexp|Yes|Yes +|alwaysCheckExactRevision|Indicates if this resolver should check the given revision even if it's a special one (like latest.integration) (*__since 1.3__*).|No, defaults to ${ivy.default.always.check.exact.revision}|No|Yes +|namespace|The name of the namespace to which this resolver belongs (*__since 1.3__*)|No, defaults to 'system'|Yes|Yes +|checkconsistency|true to check consistency of module descriptors found by this resolver, false to avoid consistency check (*__since 1.3__*)|No, defaults to true|No|Yes +|descriptor|'optional' if a module descriptor (usually an Ivy file) is optional for this resolver, 'required' to refuse modules without module descriptor (*__since 2.0__*)|No, defaults to 'optional'|No (except dual)|Yes +|[line-through]#allownomd#|__Deprecated. Use descriptor="required \| optional" instead.__ +true if the absence of module descriptor (usually an Ivy file) is authorised for this resolver, false to refuse modules without module descriptor (*__since 1.4__*)|No, defaults to true|No (except dual)|Yes +|checksums|a comma separated list of link:../concept.html#checksum[checksum algorithms] to use both for publication and checking (*__since 1.4__*)|No, defaults to ${ivy.checksums}|No|Yes |latest|The name of the latest strategy to use.|No, defaults to 'default'|Yes|Yes |cache|The name of the cache manager to use.|No, defaults to the value of the default attribute of caches|No|Yes -|signer|The name of the link:../settings/signers.html[detached signature generator] to use when publishing artifacts. *__(since 2.2)__*|No, by default published artifacts will not get signed by Ivy.|No|Yes -|timeoutConstraint|The name of the link:timeout-constraint.html[timeout-constraint] to use for the resolver. *__(since 2.5)__*|No. In the absence of a `timeoutConstraint`, the resolver's behaviour with timeouts is implementation specific.|No|Yes +|signer|The name of the link:../settings/signers.html[detached signature generator] to use when publishing artifacts. (*__since 2.2__*)|No, by default published artifacts will not get signed by Ivy.|No|Yes +|timeoutConstraint|The name of the link:timeout-constraint.html[timeout-constraint] to use for the resolver. (*__since 2.5__*)|No. In the absence of a `timeoutConstraint`, the resolver's behaviour with timeouts is implementation specific.|No|Yes |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/settings.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/settings.adoc b/asciidoc/settings/settings.adoc index 900fb5b..3204740 100644 --- a/asciidoc/settings/settings.adoc +++ b/asciidoc/settings/settings.adoc @@ -44,9 +44,9 @@ So if there is a setting in the resolver, it always wins against all other setti |defaultResolver|the name of the default resolver to use|No, but all modules should be configured in the modules section if not provided |defaultLatestStrategy|the name of the default latest strategy to use|No, defaults to latest-revision |defaultConflictManager|the name of the default conflict manager to use|No, defaults to latest-revision -|defaultBranch|the default branch to use for all modules, except if they have a link:../settings/module.html[module specific branch setting]. *__since 1.4__*|No, defaults to no default branch -|defaultResolveMode|the default link:../use/resolve.html[resolve mode] to use for all modules, except if they have a link:../settings/module.html[module specific resolve mode setting]. *__since 2.0__*|No, defaults to 'default' -|[[circularDependencyStrategy]]circularDependencyStrategy|the name of the link:../concept.html#circular[circular dependency strategy] to use *__since 1.4__*|No, defaults to warn +|defaultBranch|the default branch to use for all modules, except if they have a link:../settings/module.html[module specific branch setting]. (*__since 1.4__*)|No, defaults to no default branch +|defaultResolveMode|the default link:../use/resolve.html[resolve mode] to use for all modules, except if they have a link:../settings/module.html[module specific resolve mode setting]. (*__since 2.0__*)|No, defaults to 'default' +|[[circularDependencyStrategy]]circularDependencyStrategy|the name of the link:../concept.html#circular[circular dependency strategy] to use (*__since 1.4__*)|No, defaults to warn |validate|Indicates if Ivy files should be validated against ivy.xsd or not.|No, defaults to true |useRemoteConfig|true to configure ivyrep and ibiblio resolver from a remote settings file (updated with changes in those repository structure if any) (*__since 1.2__*)|No, defaults to false |httpRequestMethod|specifies the HTTP method to use to retrieve information about an URL. Possible values are 'GET' and 'HEAD'. This setting can be used to solve problems with firewalls and proxies. (*__since 2.0__*)|No, defaults to 'HEAD' http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/signers.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/signers.adoc b/asciidoc/settings/signers.adoc index 8a0f5d0..49f42dd 100644 --- a/asciidoc/settings/signers.adoc +++ b/asciidoc/settings/signers.adoc @@ -21,7 +21,7 @@ *Tag:* signers -*__since 2.2__* +[*__since 2.2__*] Defines a list of detached signature generators usable in Ivy. Each generator is identified by its name, given as an attribute. The child tags used to configure the signature generator must be equal to the name of a signature generator type (either built-in or added with the typedef tag). http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/statuses.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/statuses.adoc b/asciidoc/settings/statuses.adoc index a65c1f3..92def80 100644 --- a/asciidoc/settings/statuses.adoc +++ b/asciidoc/settings/statuses.adoc @@ -21,7 +21,9 @@ *Tag:* statuses -Defines the list of available statuses. *__since 1.4__* +[*__since 1.4__*] + +Defines the list of available statuses. By default, Ivy has 3 statuses: `release`, `milestone` and `integration`. By adding a statuses section to your Ivy settings file, you define the statuses you want to use. Note that in this case, if you still want to have Ivy default statuses, you will have to declare them. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/timeout-constraints.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/timeout-constraints.adoc b/asciidoc/settings/timeout-constraints.adoc index e331500..cfabd59 100644 --- a/asciidoc/settings/timeout-constraints.adoc +++ b/asciidoc/settings/timeout-constraints.adoc @@ -19,7 +19,7 @@ = timeout-constraints -*__since 2.5__* +[*__since 2.5__*] Ivy, internally, communicates with various remote systems for dealing with module descriptors and artifacts. This is done through various link:../concept.html[dependency resolvers] that are configured in the Ivy settings. This communication typically involves opening a connection to the target system and reading content from those systems. As with all remote communication, certain systems can sometimes be slow or even unavailable on some occasions. `timeout-constraints` in Ivy settings allows you to configure timeouts that can then be used by Ivy while communicating with remote systems. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/triggers.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/triggers.adoc b/asciidoc/settings/triggers.adoc index 5b307ba..cd78757 100644 --- a/asciidoc/settings/triggers.adoc +++ b/asciidoc/settings/triggers.adoc @@ -21,7 +21,7 @@ *Tag:* triggers -*__since 1.4__* +[*__since 1.4__*] Defines a list of triggers to activate on some Ivy events. @@ -47,8 +47,6 @@ The following events are available in Ivy: |======= |Name|Attributes|Description |pre-resolve| - - * organisation + the organisation of the module for which the dependencies will be resolved @@ -61,10 +59,8 @@ the revision of the module for which the dependencies will be resolved * conf + comma separated list of configurations which will be resolved - |Fired at the beginning of the resolve process, before module dependencies and transitive dependencies are resolved. +|Fired at the beginning of the resolve process, before module dependencies and transitive dependencies are resolved. |pre-resolve-dependency| - - * organisation + the organisation of the dependency resolved @@ -72,13 +68,13 @@ the organisation of the dependency resolved the name of the dependency resolved * req-revision + -the requested revision for the dependency *__since 2.0__* (provided for consistency with post-resolve-dependency) +the requested revision for the dependency (*__since 2.0__*) (provided for consistency with post-resolve-dependency) * req-revision-default + -the default requested revision constraint for the dependency *__since 2.0__* +the default requested revision constraint for the dependency (*__since 2.0__*) * req-revision-dynamic + -the requested revision dynamic constraint for the dependency *__since 2.0__* +the requested revision dynamic constraint for the dependency (*__since 2.0__*) * revision + the requested revision for the dependency @@ -86,10 +82,8 @@ the requested revision for the dependency * resolver + the name of the resolver used to resolve the dependency - |Fired before each dependency is resolved. In this case resolved means resolving the actual revision if the requested revision is a version constraint and not a static version, and downloading all necessary metadata information. +|Fired before each dependency is resolved. In this case resolved means resolving the actual revision if the requested revision is a version constraint and not a static version, and downloading all necessary metadata information. |post-resolve-dependency| - - * organisation + the organisation of the dependency resolved @@ -97,13 +91,13 @@ the organisation of the dependency resolved the name of the dependency resolved * req-revision + -the requested revision for the dependency *__since 2.0__* +the requested revision for the dependency (*__since 2.0__*) * req-revision-default + -the default requested revision constraint for the dependency *__since 2.0__* +the default requested revision constraint for the dependency (*__since 2.0__*) * req-revision-dynamic + -the requested revision dynamic constraint for the dependency *__since 2.0__* +the requested revision dynamic constraint for the dependency (*__since 2.0__*) * revision + the revision of the dependency resolved, or the requested revision if the resolution was not successful @@ -112,18 +106,16 @@ the revision of the dependency resolved, or the requested revision if the resolu true if the resolution was successful, false otherwise * duration + -the time elapsed to resolve the dependency (in ms) *__since 2.0__* +the time elapsed to resolve the dependency (in ms) (*__since 2.0__*) * resolver + the name of the resolver used to resolve the dependency * any extra attribute + -all extra attributes found on the info tag of the resolved dependency are available *__since 2.0__* +all extra attributes found on the info tag of the resolved dependency are available (*__since 2.0__*) - |Fired after each dependency is resolved +|Fired after each dependency is resolved |post-resolve| - - * organisation + the organisation of the module for which the dependencies have been resolved @@ -137,27 +129,25 @@ the revision of the module for which the dependencies have been resolved comma separated list of configurations resolved * resolve-id + -the identifier of the resolution process *__since 2.0__* +the identifier of the resolution process (*__since 2.0__*) * nb-dependencies + -total number of dependencies, including transitive and evicted ones *__since 2.0__* +total number of dependencies, including transitive and evicted ones (*__since 2.0__*) * nb-artifacts + -total number of artifacts resolved, excluding metadata artifacts *__since 2.0__* +total number of artifacts resolved, excluding metadata artifacts (*__since 2.0__*) * resolve-duration + -the time (in ms) elapsed to resolve dependencies, before downloading artifacts *__since 2.0__* +the time (in ms) elapsed to resolve dependencies, before downloading artifacts (*__since 2.0__*) * download-duration + -the time (in ms) elapsed to download all artifacts, excluding metadata artifacts downloaded during the first phase of the resolution process *__since 2.0__* +the time (in ms) elapsed to download all artifacts, excluding metadata artifacts downloaded during the first phase of the resolution process (*__since 2.0__*) * download-size + -the total size (in bytes) of all downloaded artifacts, excluding metadata artifacts. Only artifacts actually downloaded (not in cache or used from their original location) are considered *__since 2.0__* +the total size (in bytes) of all downloaded artifacts, excluding metadata artifacts. Only artifacts actually downloaded (not in cache or used from their original location) are considered (*__since 2.0__*) - |Fired at the end of the resolve process, when all module dependencies have been resolved +|Fired at the end of the resolve process, when all module dependencies have been resolved |pre-download-artifact| - - * organisation + the organisation of the artifact which is about to be downloaded @@ -177,7 +167,7 @@ the type of the the artifact which is about to be downloaded the extension of the the artifact which is about to be downloaded * metadata + -true if the artifact to be downloaded is a metadata artifact, false for published artifacts *__since 2.0__* +true if the artifact to be downloaded is a metadata artifact, false for published artifacts (*__since 2.0__*) * resolver + the name of the resolver used to download the artifact @@ -188,10 +178,8 @@ the origin location from which it will be downloaded * local + true if it's a local artifact, false otherwise - |Fired before an artifact is downloaded from a repository to the cache +|Fired before an artifact is downloaded from a repository to the cache |post-download-artifact| - - * organisation + the organisation of the artifact which was just downloaded @@ -211,7 +199,7 @@ the type of the the artifact which was just downloaded the extension of the the artifact which was just downloaded * metadata + -true if the downloaded artifact is a metadata artifact, false for published artifacts *__since 2.0__* +true if the downloaded artifact is a metadata artifact, false for published artifacts (*__since 2.0__*) * resolver + the name of the resolver used to download the artifact @@ -226,16 +214,13 @@ true if it's a local artifact, false otherwise the size in bytes of the downloaded artifact * duration + -the time elapsed to download the artifact (in ms) *__since 2.0__* +the time elapsed to download the artifact (in ms) (*__since 2.0__*) * file + the file to which it has been downloaded - |Fired after an artifact has been downloaded from a repository to the cache -|pre-retrieve -*__since 2.0__*| - - +|Fired after an artifact has been downloaded from a repository to the cache +|pre-retrieve (*__since 2.0__*)| * organisation + the organisation of the module for which the dependencies will be retrieved @@ -254,11 +239,8 @@ true if Ivy will use symbolic links instead of copies on supported platforms, fa * sync + true if the retrieve process will be performed in sync mode, false otherwise - |Fired at the beginning of the retrieve process. -|post-retrieve -*__since 2.0__*| - - +|Fired at the beginning of the retrieve process. +|post-retrieve (*__since 2.0__*)| * organisation + the organisation of the module for which the dependencies have been retrieved @@ -289,11 +271,8 @@ the number of artifacts copied or symlinked * nbUptodate + the number of artifacts which were already present and up to date at the destination location - |Fired at the end of the retrieve process. -|pre-retrieve-artifact -*__since 2.1__*| - - +|Fired at the end of the retrieve process. +|pre-retrieve-artifact (*__since 2.1__*)| * organisation + the organisation of the artifact which is about to be retrieved @@ -324,11 +303,8 @@ the absolute path from which it will be retrieved (usually a location in cache) * to + the absolute path to which it will be retrieved - |Fired before an artifact is retrieved from the cache to a local location -|post-retrieve-artifact -*__since 2.1__*| - - +|Fired before an artifact is retrieved from the cache to a local location +|post-retrieve-artifact (*__since 2.1__*)| * organisation + the organisation of the artifact which has just been retrieved @@ -359,11 +335,8 @@ the absolute path from which it has just been retrieved (usually a location in c * to + the absolute path to which it has just been retrieved - |Fired after an artifact is retrieved from the cache to a local location -|pre-publish-artifact -*__since 2.0__*| - - +|Fired after an artifact is retrieved from the cache to a local location +|pre-publish-artifact (*__since 2.0__*)| * organisation + the organisation of the artifact which is about to be published @@ -391,11 +364,8 @@ the absolute path of the source file for the artifact * overwrite + "true" if the new data will overwrite existing artifacts, "false" otherwise - |Fired before an artifact is published into a repository -|post-publish-artifact -*__since 2.0__*| - - +|Fired before an artifact is published into a repository +|post-publish-artifact (*__since 2.0__*)| * organisation + the organisation of the artifact that was published @@ -426,7 +396,7 @@ the absolute path of the source file for the artifact * status + "successful" if the artifact published successfully; "failed" if the artifact failed to publish, or if the status is unknown - |Fired after an artifact is published into a repository. Note that this event is fired whether or not the publication succeeded. The "status" property can be checked to verify success. +|Fired after an artifact is published into a repository. Note that this event is fired whether or not the publication succeeded. The "status" property can be checked to verify success. |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/settings/version-matchers.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/version-matchers.adoc b/asciidoc/settings/version-matchers.adoc index c50397c..827a826 100644 --- a/asciidoc/settings/version-matchers.adoc +++ b/asciidoc/settings/version-matchers.adoc @@ -21,7 +21,9 @@ *Tag:* version-matchers -Defines a list of version matchers. *__since 1.4__* +[*__since 1.4__*] + +Defines a list of version matchers. The child tag used for the version matcher must be equal to a name of a report outputter type (added with the `typedef` tag). @@ -144,11 +146,13 @@ Matcher types may be one of "regexp", "exact", "glob", or "exactOrRegexp". Glob === Maven timestamped snapshot version matcher +[*__since 2.5__*] + Maven has the notion of timestamped snapshots, which essentially are snapshot versions of a particular Maven artifact, but have a specific timestamp associated with them so that the snapshot revision (which by nature are changing over time), can be traced back to the exact artifacts. Maven allows other artifacts to depend on such timestamped snapshots. -*Starting Ivy 2.5 version*, Ivy too allows such timestamped dependencies to be part of the module's dependencies. For such dependencies to be properly parsed and resolved, a `maven-tsnap-vm` version matcher needs to be configured in the Ivy settings and link:../resolver/ibiblio.html[ibiblio resolver] must be one of the resolvers that used for dependency resolution. +Ivy too allows such timestamped dependencies to be part of the module's dependencies. For such dependencies to be properly parsed and resolved, a `maven-tsnap-vm` version matcher needs to be configured in the Ivy settings and link:../resolver/ibiblio.html[ibiblio resolver] must be one of the resolvers that are used for dependency resolution. -NOTE: Maven has a specific syntax for timestamped snapshot versions and only such versions are understood by Ivy +NOTE: Maven has a specific syntax for timestamped snapshot versions and only such versions are understood by Ivy. Configuring the `maven-tsnap-vm` can be done as follows in the Ivy settings file: http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/standalone.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/standalone.adoc b/asciidoc/standalone.adoc index d03f79c..655f408 100644 --- a/asciidoc/standalone.adoc +++ b/asciidoc/standalone.adoc @@ -95,7 +95,7 @@ usage: ivy -version displays version information ---- -*__since 1.3__* System properties are included as Ivy variables, so you can easily define an Ivy variable like this: +(*__since 1.3__*) System properties are included as Ivy variables, so you can easily define an Ivy variable like this: [source,shell] ---- @@ -122,7 +122,7 @@ calls Ivy with given Ivy settings file using given Ivy file ''' -*__since 1.3__* +(*__since 1.3__*) [source,shell] ---- @@ -154,7 +154,7 @@ with `ivy.xml` like this: ''' -*__since 1.3__* +(*__since 1.3__*) [source,shell] ---- @@ -165,7 +165,7 @@ calls Ivy with given Ivy settings file and resolves the dependencies found in th ''' -*__since 1.4__* +(*__since 1.4__*) [source,shell] ---- http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/terminology.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/terminology.adoc b/asciidoc/terminology.adoc index 3d1a18a..61cf36e 100644 --- a/asciidoc/terminology.adoc +++ b/asciidoc/terminology.adoc @@ -128,7 +128,7 @@ revisions delivered to the public but not actually finished fall in this categor `release`:: a revision fully tested and labelled fall in this category -*__Since 1.4__* This list is link:settings/statuses.html[configurable] in your settings file. +(*__since 1.4__*) This list is link:settings/statuses.html[configurable] in your settings file. == [[configurations]]Configurations of a module http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/tutorial.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/tutorial.adoc b/asciidoc/tutorial.adoc index d63f68e..94f9f29 100644 --- a/asciidoc/tutorial.adoc +++ b/asciidoc/tutorial.adoc @@ -28,7 +28,7 @@ For the first tutorial you won't even have to install Ivy (assuming you have Ant * Make sure you have link:http://ant.apache.org/[Ant] 1.9.9 or greater and a link:https://www.java.com/en/download/[Java JDK] properly installed + - * Copy link:samples/build.xml[this build file] in an empty directory on your local filesystem (and make sure you name it `build.xml`) + + * Copy link:samples/build.xml[this build file] to an empty directory on your local filesystem (and make sure you name it `build.xml`) + * Open a console in that directory and run the command: `ant`. That's it! + http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/artifactproperty.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/artifactproperty.adoc b/asciidoc/use/artifactproperty.adoc index 6089f1f..584851c 100644 --- a/asciidoc/use/artifactproperty.adoc +++ b/asciidoc/use/artifactproperty.adoc @@ -17,18 +17,19 @@ under the License. //// -*__since 1.1__* +[*__since 1.1__*] + Sets an Ant property for each dependency artifact previously resolved. -*__since 2.0__* This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and attributes common to all post resolve tasks. +(*__since 2.0__*) This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and attributes common to all post resolve tasks. Please prefer the use of retrieve + standard Ant path creation, which make your build more independent from Ivy (once artifacts are properly retrieved, Ivy is not required any more). The property name and value are generated using the classical pattern concept, all artifact tokens and Ivy variables being available. -*__since 2.0__* This tag will follow the Ant usual behavior for properties. If a property with the same name already exists, its value will be unchanged. This behavior can be changed using the `overwrite` attribute. +(*__since 2.0__*) This tag will follow the Ant usual behavior for properties. If a property with the same name already exists, its value will be unchanged. This behavior can be changed using the `overwrite` attribute. -_WARNING_: Before 2.0, the behavior was to overwrite the properties. Since 2.0, the default is to not overwrite to properties +_WARNING_: Before 2.0, the behavior was to overwrite the properties. Since 2.0, the default is to not overwrite to properties == Attributes @@ -40,8 +41,8 @@ _WARNING_: Before 2.0, the behavior was to overwrite the properties. Since 2.0, |conf|a comma separated list of the configurations for which properties should be set|No. Defaults to the configurations resolved by the last resolve call, or `$$*$$` if no resolve was explicitly called |haltonfailure|`true` to halt the build on Ivy failure, `false` to continue|No. Defaults to `true` |validate|`true` to force validation of Ivy files against ivy.xsd, `false` to skip validation|No. Defaults to default Ivy value (as configured in settings file) -|settingsRef|A reference to Ivy settings that must be used by this task *(since 2.0)*|No, `ivy.instance` is taken by default. -|overwrite|Overwrite the value of the property if it already exists *(since 2.0)*. Before 2.0, the properties were always overwritten.|No, `false` by default. +|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No, `ivy.instance` is taken by default. +|overwrite|Overwrite the value of the property if it already exists (*__since 2.0__*). Before 2.0, the properties were always overwritten.|No, `false` by default. |======= == Example http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/artifactreport.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/artifactreport.adoc b/asciidoc/use/artifactreport.adoc index 7caf294..f4606b7 100644 --- a/asciidoc/use/artifactreport.adoc +++ b/asciidoc/use/artifactreport.adoc @@ -17,10 +17,11 @@ under the License. //// -*__since 1.4__* +[*__since 1.4__*] + The `artifactreport` task generates an XML report of all artifact dependencies resolved by the last link:../use/resolve.html[resolve] task call during the same build. -*__since 2.0__* This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and attributes common to all post resolve tasks. +(*__since 2.0__*) This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and attributes common to all post resolve tasks. This report is different from the standard link:../use/report.html[report] which reports all modules and artifacts, while this report is much simpler and focuses only on artifacts, and gives more information on artifacts, such as the original location and the retrieve location. @@ -69,7 +70,7 @@ Here is an example of generated file: |pattern|the retrieve pattern to use for adding the retrieve location information about the artifacts|No. Defaults to `${ivy.retrieve.pattern}`. |conf|a comma separated list of the configurations to use to generate the report|No. Defaults to the configurations resolved by the last resolve call |haltonfailure|`true` to halt the build on Ivy failure, `false` to continue|No. Defaults to `true` -|settingsRef|A reference to Ivy settings that must be used by this task *(since 2.0)*|No, `ivy.instance` is taken by default. +|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No, `ivy.instance` is taken by default. |======= == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/buildlist.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/buildlist.adoc b/asciidoc/use/buildlist.adoc index 96d1332..8ceb4aa 100644 --- a/asciidoc/use/buildlist.adoc +++ b/asciidoc/use/buildlist.adoc @@ -17,27 +17,31 @@ under the License. //// -The `buildlist` task enables to obtain a `filelist` of files (usually `build.xml` files) ordered according to Ivy dependency information from the least dependent to the most one, or the inverse. (*__since 1.2__*) +[*__since 1.2__*] + +The `buildlist` task enables to obtain a `filelist` of files (usually `build.xml` files) ordered according to Ivy dependency information from the least dependent to the most one, or the inverse. This is particularly useful combined with `subant`, to build a set of interrelated projects being sure that a dependency will be built before any module depending on it. When the `ivy.xml` of the modules that you want to order doesn't contain link:../ivyfile/info.html[revision] numbers, the `rev` attributes declared in the dependencies are not used. When the `ivy.xml` of the modules that you want to order contains link:../ivyfile/info.html[revision] numbers, the revision numbers are used. If the revision number doesn't match a dependency description, a warning is logged and the modules are considered to be different modules. -*__since 1.3__* A `root` attribute can also be used to include, among all the modules found, only the ones that are dependencies (either direct or transitive) of a root module. This can also be used with the `excluderoot` attribute, which when set to `true` will exclude the root itself from the list. +(*__since 1.3__*) A `root` attribute can also be used to include, among all the modules found, only the ones that are dependencies (either direct or transitive) of a root module. This can also be used with the `excluderoot` attribute, which when set to `true` will exclude the root itself from the list. + +(*__since 1.4.1__*) A `leaf` attribute can also be used to include, among all the modules found, only the ones that have dependencies (either direct or transitive) on a leaf module. This can also be used with the `excludeleaf` attribute, which when set to `true` will exclude the leaf itself from the list. -*__since 1.4.1__* A `leaf` attribute can also be used to include, among all the modules found, only the ones that have dependencies (either direct or transitive) on a leaf module. This can also be used with the `excludeleaf` attribute, which when set to `true` will exclude the leaf itself from the list. +(*__since 1.4__*) The `ivy.sorted.modules` property is set in Ant project at the end of the task with a comma separated list of ordered modules. This can be useful for debug or information purpose. -*__since 1.4__* The `ivy.sorted.modules` property is set in Ant project at the end of the task with a comma separated list of ordered modules. This can be useful for debug or information purpose. +[*__since 2.0__*] -*__since 2.0__* The `root` and `leaf` attributes can be a delimited list of modules to use as roots. These modules, and all their dependencies will be included in the build list. +The `root` and `leaf` attributes can be a delimited list of modules to use as roots. These modules, and all their dependencies will be included in the build list. -*__since 2.0__* By default, all the modules included in a circular dependency are grouped together so that any dependency of any module in the loop will appear before the modules in the loop. This guarantees that if there is a dependency path between a module A and a module B (but no dependency path from B to A), B will always appear before A even if A is included in a loop in the provided set of modules to sort. +By default, all the modules included in a circular dependency are grouped together so that any dependency of any module in the loop will appear before the modules in the loop. This guarantees that if there is a dependency path between a module A and a module B (but no dependency path from B to A), B will always appear before A even if A is included in a loop in the provided set of modules to sort. Note that a circular dependency can also trigger a failure depending on the value configured in the `circularDependencyStrategy` of your link:../settings/conf.html#circularDependencyStrategy[settings] -*__since 2.0__* When you are specifying `root` or `leaf` modules you can limit the resulting list to only direct dependencies of the root modules or to modules that directly depends on your leaf modules. +When you are specifying `root` or `leaf` modules you can limit the resulting list to only direct dependencies of the root modules or to modules that directly depends on your leaf modules. -*__since 2.0__* You can also specify a `restartFrom` modules. The difference with `root` or `leaf` is that you get a list starting at the `restartFrom` module followed by all the modules that would be after if the parameter would not be there (even if there is no dependency between the `restartFrom` and the following module). +You can also specify a `restartFrom` modules. The difference with `root` or `leaf` is that you get a list starting at the `restartFrom` module followed by all the modules that would be after if the parameter would not be there (even if there is no dependency between the `restartFrom` and the following module). == Attributes @@ -46,32 +50,30 @@ Note that a circular dependency can also trigger a failure depending on the valu |Attribute|Description|Required |reference|the reference of the path to set|Yes |ivyfilepath|the relative path from files to order to corresponding Ivy files|No. Defaults to `${ivy.buildlist.ivyfilepath}` -|root|*__since 2.0__* the names of the modules which should be considered as the root of the buildlist. - -*__since 1.3__* Was limited to only one module name before 2.0.|No. Defaults to no root (all modules are used in the build list) -|excluderoot|*__since 1.3__* `true` if the root defined should be excluded from the list|No. Defaults to `false` -|leaf|*__since 2.0__* the names of the modules which should be considered as the leaf of the buildlist. -*__since 1.4.1__* Was limited to only one module name before 2.0.|No. Defaults to no leaf (all modules are used in the build list) -|onlydirectdep|*__since 2.0__* `true` if the -resulting list should be restricted to direct dependencies of root modules or modules that directly depends on the leaf modules. - -This field is ignored when neither root nor leaf is filled. - |No. Defaults to no `false` -|delimiter|*__since 2.0__* delimiter to use when specifying multiple module names in the root and leaf properties.|No. Defaults to the comma (`,`) character. -|excludeleaf|*__since 1.4.1__* `true` if the leaf defined should be excluded from the list|No. Defaults to `false` +|root|(*__since 2.0__*) the names of the modules which should be considered as the root of the buildlist. + +(*__since 1.3__*) Was limited to only one module name before 2.0.|No. Defaults to no root (all modules are used in the build list) +|excluderoot|(*__since 1.3__*) `true` if the root defined should be excluded from the list|No. Defaults to `false` +|leaf|(*__since 2.0__*) the names of the modules which should be considered as the leaf of the buildlist. + +(*__since 1.4.1__*) Was limited to only one module name before 2.0.|No. Defaults to no leaf (all modules are used in the build list) +|onlydirectdep|(*__since 2.0__*) `true` if the resulting list should be restricted to direct dependencies of root modules or modules that directly depends on the leaf modules. + +This field is ignored when neither root nor leaf is filled.|No. Defaults to no `false` +|delimiter|(*__since 2.0__*) delimiter to use when specifying multiple module names in the root and leaf properties.|No. Defaults to the comma (`,`) character. +|excludeleaf|(*__since 1.4.1__*) `true` if the leaf defined should be excluded from the list|No. Defaults to `false` |haltonerror|`true` to halt the build when an invalid Ivy file is encountered, false to continue|No. Defaults to `true` -|skipbuildwithoutivy|__Deprecated, use `onMissingDescriptor` instead.__ `true` to skip files of the fileset with no corresponding Ivy file, `false` otherwise. If `false` the file with no corresponding Ivy file will be considered as independent of the other and put at the beginning of the built filelist.|No. Defaults to `false` -|onMissingDescriptor|*__since 2.0__* Specify the action to take when no module descriptor file is found for a file of the fileset. Possible values are: + +|[line-through]#skipbuildwithoutivy#|__Deprecated, use `onMissingDescriptor` instead.__ `true` to skip files of the fileset with no corresponding Ivy file, `false` otherwise. If `false` the file with no corresponding Ivy file will be considered as independent of the other and put at the beginning of the built filelist.|No. Defaults to `false` +|onMissingDescriptor|(*__since 2.0__*) Specify the action to take when no module descriptor file is found for a file of the fileset. Possible values are: + * `head`: put at the head of the built filelist. + * `tail`: put at the tail of the built filelist. + * `skip`: skip the file, which won't be put in the build filelist at all. + * `warn`: warn and put at the head of the build filelist. + -* `fail`: halt the build with a failure. - |No. Defaults to `head` +* `fail`: halt the build with a failure.|No. Defaults to `head` |reverse|`true` to obtain the list in the reverse order, i.e. from the most dependent to the least one|No. Defaults to default `false` -|restartFrom|*__since 2.0__* The name of the module which should be considered as the starting point in the buildlist. This allows for the build to be started at any point in the dependency chain. +|restartFrom|(*__since 2.0__*) The name of the module which should be considered as the starting point in the buildlist. This allows for the build to be started at any point in the dependency chain. |No. Defaults to `*` meaning no restart point (all modules are used in the build list). -|settingsRef|*__since 2.0__* A reference to Ivy settings that must be used by this task|No, `ivy.instance` is taken by default. +|settingsRef|(*__since 2.0__*) A reference to Ivy settings that must be used by this task|No, `ivy.instance` is taken by default. |======= == Parameters specified as nested elements http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/buildnumber.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/buildnumber.adoc b/asciidoc/use/buildnumber.adoc index 631777c..e5b2ab8 100644 --- a/asciidoc/use/buildnumber.adoc +++ b/asciidoc/use/buildnumber.adoc @@ -17,7 +17,8 @@ under the License. //// -*__since 1.4__* +[*__since 1.4__*] + The `buildnumber` task is similar to the Ant `buildnumber` task, except that it uses Ivy repository to find what is the latest version and calculate a new one for you. When called, it sets four properties according to what has been found. These properties are: @@ -65,8 +66,8 @@ Note that when asking for revision 1, you can get a revision 10.0. To avoid that |defaultBuildNumber|the default build number to use for the first revision|No, defaults to 0 |revSep|the revision separator to use when no matching revision is found, to separate the revision prefix from the build number|No, defaults to `.` |prefix|the prefix to use for the property names set (will be `__prefix__.revision`, `__prefix__.new.revision`, ...)|No, defaults to `ivy` -|settingsRef|A reference to Ivy settings that must be used by this task *__(since 2.0)__*.|No, `ivy.instance` is taken by default. -|resolver|the name of the resolver to use for build number calculation *__(since 2.1)__*|No, all available resolvers will be used by default. +|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*).|No, `ivy.instance` is taken by default. +|resolver|the name of the resolver to use for build number calculation (*__since 2.1__*)|No, all available resolvers will be used by default. |======= == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/buildobr.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/buildobr.adoc b/asciidoc/use/buildobr.adoc index ac39557..71d1b96 100644 --- a/asciidoc/use/buildobr.adoc +++ b/asciidoc/use/buildobr.adoc @@ -17,20 +17,24 @@ under the License. //// -*__since 2.3__* From a set of jar artifacts, this task generates an OBR (OSGi Bundle Repository) descriptor. It could be then used by the link:../resolver/obr.html[obr resolver]. +[*__since 2.3__*] + +From a set of jar artifacts, this task generates an OBR (OSGi Bundle Repository) descriptor. It could be then used by the link:../resolver/obr.html[obr resolver]. The set of jars which will be described by OBR can be defined in 4 mutually exclusive ways: * via an Ivy resolver: every jar listed by the resolver will be taken into account * by defining a root directory: every jar found recursively in that folder will be taken into account * via the name of an Ivy cache: every artifact contained in the cache will be taken into account -* *__since 2.4__* via a resolve: this task is a link:../use/postresolvetask.html[post resolve task] (with all the behaviour and attributes common to all post resolve tasks), thus every artifact which has been resolved will be taken into account; it is especially useful for building a link:../osgi/target-platform.html[target platform] +* (*__since 2.4__*) via a resolve: this task is a link:../use/postresolvetask.html[post resolve task] (with all the behaviour and attributes common to all post resolve tasks), thus every artifact which has been resolved will be taken into account; it is especially useful for building a link:../osgi/target-platform.html[target platform] NB: among every listed file or artifact, only the actually OSGi bundles will be described by the OBR descriptor; the other files are ignored. == Attributes -*__since 2.4__* This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and attributes common to all post resolve tasks. +[*__since 2.4__*] + +This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and attributes common to all post resolve tasks. [options="header",cols="15%,50%,35%"] |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/cachefileset.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/cachefileset.adoc b/asciidoc/use/cachefileset.adoc index 1971810..cd860cc 100644 --- a/asciidoc/use/cachefileset.adoc +++ b/asciidoc/use/cachefileset.adoc @@ -17,7 +17,9 @@ under the License. //// -Constructs an Ant `fileset` consisting of artifacts in Ivy's cache for a configuration (*__since 1.2__*). +[*__since 1.2__*] + +Constructs an Ant `fileset` consisting of artifacts in Ivy's cache for a configuration. This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and attributes common to all post resolve tasks. Note that this task does not rely on retrieve, because the built fileset is made of artifacts directly in Ivy's cache. @@ -43,5 +45,5 @@ If `cachefileset` doesn't fit the need of your use case (maybe due to the limita |setid|the id to reference the built fileset|Yes |conf|a comma separated list of the configurations to put in the created path|No. Defaults to the configurations resolved by the last resolve call, or `*` if no resolve was explicitly called |type|comma separated list of artifact types to accept in the path, `*` for all|No. Defaults to `*` -|settingsRef|*__(since 2.0)__* A reference to Ivy settings that must be used by this task|No, `ivy.instance` is taken by default. +|settingsRef|(*__since 2.0__*) A reference to Ivy settings that must be used by this task|No, `ivy.instance` is taken by default. |======= http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/cachepath.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/cachepath.adoc b/asciidoc/use/cachepath.adoc index 6435195..45141f0 100644 --- a/asciidoc/use/cachepath.adoc +++ b/asciidoc/use/cachepath.adoc @@ -33,7 +33,7 @@ Built path is registered in the Ant project with a given id, and can thus be use |pathid|the id to reference the built path|Yes |conf|a comma separated list of the configurations to put in the created path|No. Defaults to the configurations resolved by the last resolve call, or `*` if no resolve was explicitly called |type|comma separated list of artifact types to accept in the path, `$$*$$` for all (*__since 1.2__*)|No. Defaults to `*` -|settingsRef|*__(since 2.0)__* A reference to Ivy settings that must be used by this task|No, `ivy.instance` is taken by default. +|settingsRef|(*__since 2.0__*) A reference to Ivy settings that must be used by this task|No, `ivy.instance` is taken by default. |======= == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/cleancache.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/cleancache.adoc b/asciidoc/use/cleancache.adoc index 098ed17..6f2a1ed 100644 --- a/asciidoc/use/cleancache.adoc +++ b/asciidoc/use/cleancache.adoc @@ -17,7 +17,8 @@ under the License. //// -*__since 2.0__* +[*__since 2.0__*] + Cleans the Ivy cache. This task is roughly equivalent to: http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/configure.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/configure.adoc b/asciidoc/use/configure.adoc index 8f87ff6..a30f2c1 100644 --- a/asciidoc/use/configure.adoc +++ b/asciidoc/use/configure.adoc @@ -21,9 +21,11 @@ The `configure` task is used to configure Ivy with a settings XML file. See link:../settings.html[Settings Files] for details about the settings file itself. -*__since 2.0__* The file loaded used to be called __configuration__ file in versions prior to 2.0. The name __settings__ and the use of the `ivy.settings.file` is new to 2.0. +[*__since 2.0__*] -*__since 2.0__* It is also possible to configure Ivy with the link:../use/settings.html[settings] declaration. The difference with this task is that when using the settings declaration, the configuration of Ivy will be done when the settings are first needed (for instance, when you do a resolve), while the configure task will perform a configuration of Ivy instantly, which makes it easier to see the problem if something goes wrong. +The file loaded used to be called __configuration__ file in versions prior to 2.0. The name __settings__ and the use of the `ivy.settings.file` is new to 2.0. + +It is also possible to configure Ivy with the link:../use/settings.html[settings] declaration. The difference with this task is that when using the settings declaration, the configuration of Ivy will be done when the settings are first needed (for instance, when you do a resolve), while the configure task will perform a configuration of Ivy instantly, which makes it easier to see the problem if something goes wrong. == Attributes @@ -32,7 +34,7 @@ See link:../settings.html[Settings Files] for details about the settings file it |Attribute|Description|Required |settingsId|The settings id usable in the `settingsRef` attributes of the Ivy task that needs a setting.|No, defaults to `ivy.instance` |file|path to the settings file to use -.2+|No. If a file is provided, URL is ignored. If none are provided, then it attempts to find a file at `${ivy.settings.file}`, and if this file does not exist, it uses `${ivy.settings.url}` *__(since 2.3)__* or a link:../samples/ivysettings-default.xml[default settings file] +.2+|No. If a file is provided, URL is ignored. If none are provided, then it attempts to find a file at `${ivy.settings.file}`, and if this file does not exist, it uses `${ivy.settings.url}` (*__since 2.3__*) or a link:../samples/ivysettings-default.xml[default settings file] |url|URL of the settings file to use |override|Specify what to do when another settings with the same id has already been loaded. + * `true`: the current settings will take precedence over any previously defined setting with this id + @@ -49,8 +51,7 @@ See link:../settings.html[Settings Files] for details about the settings file it If any of the URLs you use in Ivy (especially in dependency resolvers) needs HTTP authentication, then you have to provide the `host`, `realm`, `username` and `passwd` attributes of the configure task. These settings will then be used in any further call to Ivy tasks. -*Since 1.4:* -It's also possible to configure authentication settings for multiple URLs. This can be done with the `<credentials>` subelements. See the examples for more details. +(*__since 1.4__*) It's also possible to configure authentication settings for multiple URLs. This can be done with the `<credentials>` subelements. See the examples for more details. == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/convertmanifest.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/convertmanifest.adoc b/asciidoc/use/convertmanifest.adoc index 00f3219..0e7eebd 100644 --- a/asciidoc/use/convertmanifest.adoc +++ b/asciidoc/use/convertmanifest.adoc @@ -17,7 +17,9 @@ under the License. //// -*__since 2.3__* Convert a `MANIFEST.MF` into an `ivy.ml` file +[*__since 2.3__*] + +Convert a `MANIFEST.MF` into an `ivy.ml` file == Attributes http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/convertpom.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/convertpom.adoc b/asciidoc/use/convertpom.adoc index 4209531..a5b2f8f 100644 --- a/asciidoc/use/convertpom.adoc +++ b/asciidoc/use/convertpom.adoc @@ -17,7 +17,9 @@ under the License. //// -*__since 2.1__* Convert `pom.xml` into an `ivy.xml` +[*__since 2.1__*] + +Convert `pom.xml` into an `ivy.xml` == Attributes http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/deliver.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/deliver.adoc b/asciidoc/use/deliver.adoc index 8e58cff..36f407b 100644 --- a/asciidoc/use/deliver.adoc +++ b/asciidoc/use/deliver.adoc @@ -29,7 +29,7 @@ Moreover, all included configurations' files are included in the Ivy file, and v Finally, in the resolved Ivy file, dynamic revisions are replaced by the static ones that have been found during the resolve step, so the Ivy file can be used later safely to obtain the same dependencies (providing that a revision uniquely identifies a module, which should be the case for proper Ivy use). -*__since 1.3__* The replacement of dynamic revisions by static ones can be turned off, so that dynamic revisions are kept in the Ivy file. This is an exception to the recommended standard that published module descriptors be fully resolved, so use it with caution. +(*__since 1.3__*) The replacement of dynamic revisions by static ones can be turned off, so that dynamic revisions are kept in the Ivy file. This is an exception to the recommended standard that published module descriptors be fully resolved, so use it with caution. == Recursive delivery @@ -82,12 +82,12 @@ It can also be useful if you want to trigger a recursive delivery and then ensur |status|the status to use for the publication|No. Defaults to `${ivy.status}` |delivertarget|the target to call for recursive delivery|No. No recursive delivery is done by default |validate|`true` to force Ivy files validation against ivy.xsd, `false` to force no validation|No. Defaults to default Ivy value (as configured in settings) -|replacedynamicrev|`true` to replace dynamic revisions by static ones in the delivered file, `false` to avoid this replacement *__(since 1.3)__*|No. Defaults to `true` -|replaceForcedRev|`true` to replace revisions (static or dynamic) by the revision of the resolver in link:../settings/resolvers.html#common[forced mode], `false` to avoid this replacement *__(since 2.2)__*|No. Defaults to `false` -|merge|if a descriptor link:../ivyfile/extends.html[extends] a parent, merge the inherited information directly into the delivered descriptor. The `extends` element itself will be commented out in the delivered descriptor. *__(since 2.2)__*|No. Defaults to `true`. -|settingsRef|A reference to Ivy settings that must be used by this task *__(since 2.0)__*|No. Defaults to `ivy.instance`. -|conf|comma-separated list of configurations to include in the delivered file. Accepts wildcards. *__(since 2.0)__*|No. Defaults to all configurations -|generateRevConstraint|`true` to automatically generate a `revConstraint` attribute in the delivered file (see the link:../ivyfile/dependency.html[dependency] page for more info about this attribute), `false` to never generate this attribute *__(since 2.1)__*|No. Defaults to `true` +|replacedynamicrev|`true` to replace dynamic revisions by static ones in the delivered file, `false` to avoid this replacement (*__since 1.3__*)|No. Defaults to `true` +|replaceForcedRev|`true` to replace revisions (static or dynamic) by the revision of the resolver in link:../settings/resolvers.html#common[forced mode], `false` to avoid this replacement (*__since 2.2__*)|No. Defaults to `false` +|merge|if a descriptor link:../ivyfile/extends.html[extends] a parent, merge the inherited information directly into the delivered descriptor. The `extends` element itself will be commented out in the delivered descriptor. (*__since 2.2__*)|No. Defaults to `true`. +|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No. Defaults to `ivy.instance`. +|conf|comma-separated list of configurations to include in the delivered file. Accepts wildcards. (*__since 2.0__*)|No. Defaults to all configurations +|generateRevConstraint|`true` to automatically generate a `revConstraint` attribute in the delivered file (see the link:../ivyfile/dependency.html[dependency] page for more info about this attribute), `false` to never generate this attribute (*__since 2.1__*)|No. Defaults to `true` |======= == Example http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/dependencytree.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/dependencytree.adoc b/asciidoc/use/dependencytree.adoc index d2f3bb5..e861205 100644 --- a/asciidoc/use/dependencytree.adoc +++ b/asciidoc/use/dependencytree.adoc @@ -32,8 +32,8 @@ Please prefer the use of retrieve + standard Ant path creation, which make your |conf|a comma separated list of the configurations to take in consideration in the dependency tree|No. Defaults to the configurations resolved by the last resolve call, or `*` if no resolve was explicitly called |haltonfailure|`true` to halt the build on Ivy failure, `false` to continue|No. Defaults to `true` |validate|true to force Ivy files validation against ivy.xsd, false to force no validation|No. Defaults to default Ivy value (as configured in settings) -|settingsRef|A reference to Ivy settings that must be used by this task *(since 2.0)*|No, defaults to `ivy.instance`. -|overwrite|Overwrite the value of the property if it already exist *(since 2.0)*. Before 2.0, the properties were always overwritten.|No, `false` by default. +|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No, defaults to `ivy.instance`. +|overwrite|Overwrite the value of the property if it already exist (*__since 2.0__*). Before 2.0, the properties were always overwritten.|No, `false` by default. |======= == Example http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/findrevision.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/findrevision.adoc b/asciidoc/use/findrevision.adoc index 6f9e83d..60440bb 100644 --- a/asciidoc/use/findrevision.adoc +++ b/asciidoc/use/findrevision.adoc @@ -17,7 +17,8 @@ under the License. //// -*__since 1.4__* +[*__since 1.4__*] + Finds the latest revision of a module matching a given version constraint. A version constraint is what is used when declaring a link:../ivyfile/dependency.html[dependency] on a module. @@ -33,7 +34,7 @@ If the module is not found, the property is not set. |branch|the branch of the module to find|No, defaults to the default branch for the given module |revision|the revision constraint to apply|Yes |property|the property to set with the found revision|No, defaults to `ivy.revision` -|settingsRef|a reference to Ivy settings that must be used by this task *__(since 2.0)__*|No, defaults to `ivy.instance`. +|settingsRef|a reference to Ivy settings that must be used by this task (*__since 2.0__*)|No, defaults to `ivy.instance`. |======= == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/fixdeps.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/fixdeps.adoc b/asciidoc/use/fixdeps.adoc index 49b8db6..016f7d6 100644 --- a/asciidoc/use/fixdeps.adoc +++ b/asciidoc/use/fixdeps.adoc @@ -17,7 +17,8 @@ under the License. //// -*__since 2.4__* +[*__since 2.4__*] + The `fixdeps` task serializes transitively resolved dependencies into an `ivy.xml` file. The dependencies declared in an `ivy.xml` can be specified as range of revisions. And the transitive dependencies too. As new versions of modules can be added to the repository anytime, resolved versions of ranges can change over time. It is then safer to resolve a range once and stick with the resolved revision. This way a resolve process is highly reproducible. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/info.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/info.adoc b/asciidoc/use/info.adoc index 4070c3f..7cc01ba 100644 --- a/asciidoc/use/info.adoc +++ b/asciidoc/use/info.adoc @@ -17,7 +17,8 @@ under the License. //// -*__since 1.4__* +[*__since 1.4__*] + The `info` task eases the access to some essential data contained in an Ivy file without performing a dependency resolution. The information is retrieved by setting Ant properties: @@ -30,21 +31,21 @@ The information is retrieved by setting Ant properties: |ivy.branch|The branch of the module if any, as found in the link:../ivyfile/info.html[info] tag of the Ivy file parsed. |ivy.revision|The revision of the module, as found in the link:../ivyfile/info.html[info] tag of the Ivy file parsed. |ivy.status|The status of the module, as found in the link:../ivyfile/info.html[info] tag of the Ivy file parsed. -|ivy.publication|The publication time of the module, as found in the link:../ivyfile/info.html[info] tag of the Ivy file parsed. *__(Since 2.2)__* +|ivy.publication|The publication time of the module, as found in the link:../ivyfile/info.html[info] tag of the Ivy file parsed. (*__since 2.2__*) |ivy.extra.__[any extra attribute]__|Corresponding extra attribute value, as found in the link:../ivyfile/info.html[info] tag of the Ivy file parsed |ivy.configurations|A comma separated list of configurations of the module, as declared in the link:../ivyfile/configurations.html[configurations] section |ivy.public.configurations|A comma separated list of public configurations of the module, as declared in the link:../ivyfile/configurations.html[configurations] section -|ivy.configuration.__[config name]__.desc|For each configuration with a description, a property is created containing this description. *__(Since 2.2)__* -|ivy.artifact.__[index]__.name|For each published artifact, a property is created containing its name. *__(Since 2.2)__* -|ivy.artifact.__[index]__.type|For each published artifact, a property is created containing its type. *__(Since 2.2)__* -|ivy.artifact.__[index]__.ext|For each published artifact, a property is created containing its ext. *__(Since 2.2)__* -|ivy.artifact.__[index]__.conf|For each published artifact, a property is created containing its conf. *__(Since 2.2)__* -|ivy.artifact.__[index]__.extra.__[any extra attribute]__|For each extra attribute of the published artifact, a property is created containing its name. *__(Since 2.2)__* +|ivy.configuration.__[config name]__.desc|For each configuration with a description, a property is created containing this description. (*__since 2.2__*) +|ivy.artifact.__[index]__.name|For each published artifact, a property is created containing its name. (*__since 2.2__*) +|ivy.artifact.__[index]__.type|For each published artifact, a property is created containing its type. (*__since 2.2__*) +|ivy.artifact.__[index]__.ext|For each published artifact, a property is created containing its ext. (*__since 2.2__*) +|ivy.artifact.__[index]__.conf|For each published artifact, a property is created containing its conf. (*__since 2.2__*) +|ivy.artifact.__[index]__.extra.__[any extra attribute]__|For each extra attribute of the published artifact, a property is created containing its name. (*__since 2.2__*) |======= -*__since 2.0__* +[*__since 2.0__*] -Since Ivy 2.0 this task has been enhanced to allow you to retrieve information about Ivy modules in a repository. Instead of specifying a local Ivy file you may specify the organisation, module, revision pattern and (optionally) the branch of the Ivy module in the repository you wish to retrieve the information for. +This task has been enhanced to allow you to retrieve information about Ivy modules in a repository. Instead of specifying a local Ivy file you may specify the organisation, module, revision pattern and (optionally) the branch of the Ivy module in the repository you wish to retrieve the information for. The revision pattern is what is used when declaring a link:../ivyfile/dependency.html[dependency] on a module, identical to how the link:findrevision.html[findrevision] task works. In fact, this task can now be used in place of the findrevision task. @@ -52,9 +53,7 @@ If no matching module is found then no property values are set. You may now also set the property attribute to change the first part of the property names that are set by this task e.g. if you set the property attribute to `mymodule` this task will set the Ant properties `mymodule.organisation`, `mymodule.module`, `mymodule.revision` etc. -*__since 2.2__* - -Since Ivy 2.2 this task has been enhanced to also retrieve detailed information about the module's published artifacts, as well as the publication time. +(*__since 2.2__*) This task has been enhanced to also retrieve detailed information about the module's published artifacts, as well as the publication time. == Attributes @@ -63,15 +62,15 @@ Since Ivy 2.2 this task has been enhanced to also retrieve detailed information |Attribute|Description|Required |file|the Ivy file to parse|Yes, if you wish to parse an Ivy file. No, if you are retrieving information about a module from an Ivy repository. -|organisation|the organisation of the module to find *__(since 2.0)__*|No, if you wish to parse an Ivy file. +|organisation|the organisation of the module to find (*__since 2.0__*)|No, if you wish to parse an Ivy file. Yes, if you are retrieving information about a module from an Ivy repository. -|module|the the name of the module to find *__(since 2.0)__*|No, if you wish to parse an Ivy file. +|module|the the name of the module to find (*__since 2.0__*)|No, if you wish to parse an Ivy file. Yes, if you are retrieving information about a module from an Ivy repository. -|branch|the branch of the module to find *__(since 2.0)__*|No, defaults to the default branch for the given module if you are retrieving information about a module from an Ivy repository. -|revision|the revision constraint to apply *__(since 2.0)__*|No, if you wish to parse an Ivy file. +|branch|the branch of the module to find (*__since 2.0__*)|No, defaults to the default branch for the given module if you are retrieving information about a module from an Ivy repository. +|revision|the revision constraint to apply (*__since 2.0__*)|No, if you wish to parse an Ivy file. Yes, if you are retrieving information about a module from an Ivy repository. -|property|the name to use as the base of the property names set by this task *__(since 2.0)__*|No, will default to `ivy` if not set. -|settingsRef|A reference to Ivy settings that must be used by this task *__(since 2.0)__*|No, defaults to `ivy.instance`. +|property|the name to use as the base of the property names set by this task (*__since 2.0__*)|No, will default to `ivy` if not set. +|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No, defaults to `ivy.instance`. |======= == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/install.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/install.adoc b/asciidoc/use/install.adoc index 103ca74..230fd95 100644 --- a/asciidoc/use/install.adoc +++ b/asciidoc/use/install.adoc @@ -17,7 +17,9 @@ under the License. //// -Installs a module and all its dependencies in a resolver. *__since 1.3__* +[*__since 1.3__*] + +Installs a module and all its dependencies in a resolver. The module to install should be available in a resolver, and will be installed in another resolver which should support publish. @@ -34,17 +36,17 @@ For more details about this task and its usage see the link:../tutorial/build-re |to|the name of the resolver in which the module must be installed|Yes |organisation|the name of the organisation of the module to install|Yes |module|the name of the module to install|Yes -|branch|the branch of the module to install *__since 2.0__*|No, defaults to default branch with exact matcher, `*` with any other matcher +|branch|the branch of the module to install (*__since 2.0__*)|No, defaults to default branch with exact matcher, `*` with any other matcher |revision|the revision of the module to install|Yes |type|the type(s) of artifact(s) to install. You can give multiple values separated by commas|No, defaults to `*` meaning all types -|conf|the configurations to install. Only the dependencies of the specified configurations will be installed. *__since 2.3__*|No, defaults to `*` meaning all configurations +|conf|the configurations to install. Only the dependencies of the specified configurations will be installed. (*__since 2.3__*)|No, defaults to `*` meaning all configurations |validate|`true` to force Ivy files validation against ivy.xsd, `false` to force no validation|No. Defaults to default Ivy value (as configured in settings) |overwrite|`true` to override modules already present in the destination resolver, `false` otherwise|No, defaults to `false` |transitive|`true` to install the module and all its transitive dependencies, `false` to install only the module|No, defaults to `false` |matcher|the name of the matcher to use to find the modules to install|No, defaults to `exact` -|settingsRef|A reference to Ivy settings that must be used by this task *__(since 2.0)__*|No, defaults to `ivy.instance`. -|haltonfailure|`true` to fail build on unresolved dependencies *__since 2.0__*|No, defaults to `true` -|installOriginalMetadata|`true` to install original metadata (if available). If the module has been originally resolved from a m2 repository, the original metadata is the original POM file *__since 2.4__*|No, defaults to `false` +|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No, defaults to `ivy.instance`. +|haltonfailure|`true` to fail build on unresolved dependencies (*__since 2.0__*)|No, defaults to `true` +|installOriginalMetadata|`true` to install original metadata (if available). If the module has been originally resolved from a m2 repository, the original metadata is the original POM file (*__since 2.4__*)|No, defaults to `false` |======= == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/listmodules.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/listmodules.adoc b/asciidoc/use/listmodules.adoc index 48fb27e..31c0e21 100644 --- a/asciidoc/use/listmodules.adoc +++ b/asciidoc/use/listmodules.adoc @@ -17,7 +17,8 @@ under the License. //// -*__since 1.4__* +[*__since 1.4__*] + Finds the list of modules in the repository matching some criteria and sets a corresponding list of properties in Ant. The criteria is set by given patterns matching the organisation, name branch and revision of the modules to find. @@ -36,8 +37,8 @@ To know if a module matches the criteria, Ivy will use the configured link:../co |matcher|the name of the pattern matcher to use for matching the modules fields|No. Defaults to `exactOrRegexp`. |property|the pattern of the property to set when a module is found|Yes |value|The pattern of the value to set when a module is found|Yes -|settingsRef|A reference to Ivy settings that must be used by this task *__(since 2.0)__*|No, defaults to `ivy.instance`. -|resolver|The name of the resolver to use for searching the modules *__(since 2.2)__*|No, all available resolvers will be used by default. +|settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No, defaults to `ivy.instance`. +|resolver|The name of the resolver to use for searching the modules (*__since 2.2__*)|No, all available resolvers will be used by default. |======= == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/45046b5f/asciidoc/use/makepom.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/makepom.adoc b/asciidoc/use/makepom.adoc index d3c6d79..65f331c 100644 --- a/asciidoc/use/makepom.adoc +++ b/asciidoc/use/makepom.adoc @@ -17,14 +17,16 @@ under the License. //// -*__since 2.0__* +[*__since 2.0__*] + The `makepom` task allows to convert an Ivy file to a POM file. An example of use is to publish an Ivy managed module to a Maven 2 repository. _Note that all Ivy features are not supported by Maven POMs, so the converted POM may not resolve to the exact same dependencies as the original Ivy file._ -*__since 2.2__* +[*__since 2.2__*] + It is possible to specify a template file defining the structure of the generated POM. The following processing is done on this template: * properties like `${property.name}` are replaced if they are defined in Ant or by the `ivy:makepom` task (see below for the standard properties) @@ -72,14 +74,14 @@ ${ivy.pom.header} |Attribute|Description|Required |ivyfile|the source Ivy file to convert|Yes |pomfile|the destination POM file to write|Yes -|templatefile|the template file to use when generating the POM *__(since 2.2)__*|No, defaults to the internal template file. -|artifactName|The name of the artifact which is represented by the generated POM file. *__(since 2.2)__*|No, defaults to the module name in the source Ivy file. -|artifactPackaging|The packaging of the artifact which is represented by the generated POM file. *__(since 2.2)__*|No, the artifact type is taken by default. Defaults to `pom` if no such artifact is defined. -|conf|a comma separated list of the configurations to include in the generated POM. Wildcards are supported here. *__(since 2.2)__*|No, defaults to all configurations. +|templatefile|the template file to use when generating the POM (*__since 2.2__*)|No, defaults to the internal template file. +|artifactName|The name of the artifact which is represented by the generated POM file. (*__since 2.2__*)|No, defaults to the module name in the source Ivy file. +|artifactPackaging|The packaging of the artifact which is represented by the generated POM file. (*__since 2.2__*)|No, the artifact type is taken by default. Defaults to `pom` if no such artifact is defined. +|conf|a comma separated list of the configurations to include in the generated POM. Wildcards are supported here. (*__since 2.2__*)|No, defaults to all configurations. |settingsRef|A reference to Ivy settings that must be used by this task|No, defaults to `ivy.instance`. -|printIvyInfo|Add some information about Ivy to the generated POM. *__(since 2.2)__*|No, defaults to `true`. +|printIvyInfo|Add some information about Ivy to the generated POM. (*__since 2.2__*)|No, defaults to `true`. |headerFile|the header of the generated POM file|No -|description|The description that will be added to the generated POM. *__(since 2.2)__*|No, defaults to no description or *__(since 2.5)__* to the description in the source Ivy file. +|description|The description that will be added to the generated POM. (*__since 2.2__*)|No, defaults to no description or (*__since 2.5__*) to the description in the source Ivy file. |======= == Child elements @@ -96,8 +98,8 @@ These elements takes the following attributes: + * `group`: the groupId. Default `organisation` as defined in `info` + * `artifact`: the name of the artifact + * `version`: the version. Default `revision` as defined in `info` + -* `type` *__(since 2.3)__*: the type + -* `classifier` *__(since 2.3)__*: the classifier + +* `type` (*__since 2.3__*): the type + +* `classifier` (*__since 2.3__*): the classifier + * `scope`: the scope + * `optional`: is the artifact optional. Default `false`|0..n |=======
