Repository: ant-ivy Updated Branches: refs/heads/master d7ddccdc6 -> 8736a161f
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/8736a161/asciidoc/use/publish.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/publish.adoc b/asciidoc/use/publish.adoc index dc95575..b2046c8 100644 --- a/asciidoc/use/publish.adoc +++ b/asciidoc/use/publish.adoc @@ -17,13 +17,13 @@ under the License. //// -Publishes the current module's link:../ivyfile/publications.html[artifacts] and the link:../ivyfile.html#resolved[resolved descriptor] (delivered Ivy file). +Publishes the current module's link:../ivyfile/publications{outfilesuffix}[artifacts] and the link:../ivyfile{outfilesuffix}#resolved[resolved descriptor] (delivered Ivy file). This task is meant to publish the current module descriptor together with its declared publication artifacts to a repository. All the artifacts must have been created _before_ calling this task. It does not create the artifacts themselves, but expects to find them at the location indicated by the artifacts pattern. -The target repository is given through the name of a resolver declared in current Ivy settings. See link:../settings.html[Settings Files] for details about resolver supporting artifact publishing. +The target repository is given through the name of a resolver declared in current Ivy settings. See link:../settings{outfilesuffix}[Settings Files] for details about resolver supporting artifact publishing. It also publishes the delivered Ivy file (except if you don't want), and even delivers it, if it has not been done with a previous deliver call or if forcedeliver is set to true. That's why this task takes some parameters useful only for delivery. See the illustration below: @@ -45,8 +45,8 @@ image::../images/ivy-publish-fc.png[] |pubbranch|the branch to use for the publication|No. Defaults to the `${ivy.deliver.branch}` |forcedeliver|`true` to force the implicit call to deliver, `false` to do it only if the Ivy file to publish doesn't exist yet (*__since 1.4__*)|No. Defaults to `false` |update|`true` to update Ivy file metadata (revision, branch, publication date and status) before publishing, `false` otherwise. This is usually not necessary when using deliver before publish.|No. Defaults to `false` -|merge|if this descriptor link:../ivyfile/extends.html[extends] a parent, merge the inherited information directly into this descriptor on publish. The __extends__ element itself will be commented out in the published descriptor. (*__since 2.2__*)|No. Defaults to false -|validate|`true` to force Ivy files validation against ivy.xsd, `false` to force no validation|No. Defaults to default Ivy value (as configured in link:../settings.html[settings file]) +|merge|if this descriptor link:../ivyfile/extends{outfilesuffix}[extends] a parent, merge the inherited information directly into this descriptor on publish. The __extends__ element itself will be commented out in the published descriptor. (*__since 2.2__*)|No. Defaults to false +|validate|`true` to force Ivy files validation against ivy.xsd, `false` to force no validation|No. Defaults to default Ivy value (as configured in link:../settings{outfilesuffix}[settings file]) |replacedynamicrev|`true` to replace dynamic revisions by static ones in the delivered file, `false` to avoid this replacement (*__since 1.3__*)|No. Defaults to `true` |publishivy|`true` to publish delivered Ivy file, `false` otherwise|No. Defaults to `true` |conf|A comma separated list of configurations to publish (*__since 1.4.1__*). Accepts wildcards (*__since 2.2__*).|No. Defaults to all configurations http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/8736a161/asciidoc/use/report.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/report.adoc b/asciidoc/use/report.adoc index 541fcf8..1aa2eec 100644 --- a/asciidoc/use/report.adoc +++ b/asciidoc/use/report.adoc @@ -24,7 +24,7 @@ In fact, this task uses XML report generated by resolve in cache. So if you call If you want to have an idea of what reports look like, check this very simple link:../samples/jayasoft-ivyrep-example-default.html[example]. The task also generates a GraphML file which can be loaded with the free link:https://www.yworks.com/products/yed[yEd] graph editor. -Then following a few link:../yed.html[simple steps] you can obtain a graph like this link:../samples/jayasoft-ivyrep-example-default.jpg[one]. +Then following a few link:../yed{outfilesuffix}[simple steps] you can obtain a graph like this link:../samples/jayasoft-ivyrep-example-default.jpg[one]. (*__since 1.4__*) If a custom XSLT is specified, it's possible to specify additional parameters to the stylesheet. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/8736a161/asciidoc/use/repreport.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/repreport.adoc b/asciidoc/use/repreport.adoc index f9291c8..869b36d 100644 --- a/asciidoc/use/repreport.adoc +++ b/asciidoc/use/repreport.adoc @@ -21,11 +21,11 @@ Generates reports about dependencies among several modules in the repository (repreport stands for repository report). -This task is similar to the link:../use/report.html[report] task, except that instead of working on a single module you just resolved, it works with a set of modules in your repository. +This task is similar to the link:../use/report{outfilesuffix}[report] task, except that instead of working on a single module you just resolved, it works with a set of modules in your repository. Note that the set of modules for which you generate the report is determined by setting organisation module and revision and using a matcher, but also by the dependencies of these modules. No dependency is excluded. -Usually the most useful report is a graph, you can generate either a GraphML file that you can then easily link:../yed.html[layout using yEd], or a DOT file which is the format recognized by Graphviz, which is a free tool that does automatic graph layout, and can thus be used to generate automatically a GIF, PNG or SVG of the dependencies between all your modules. +Usually the most useful report is a graph, you can generate either a GraphML file that you can then easily link:../yed{outfilesuffix}[layout using yEd], or a DOT file which is the format recognized by Graphviz, which is a free tool that does automatic graph layout, and can thus be used to generate automatically a GIF, PNG or SVG of the dependencies between all your modules. *Limitation*: this task requires to be able to browse the repository, and is thus limited to resolvers supporting repository listing. In particular, it means it doesn't work to report all organizations in a repository using m2compatible mode. Moreover, to be able to list organizations, this task requires an [organisation] token in the resolver(s) used. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/8736a161/asciidoc/use/resolve.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/resolve.adoc b/asciidoc/use/resolve.adoc index d563902..8906ebb 100644 --- a/asciidoc/use/resolve.adoc +++ b/asciidoc/use/resolve.adoc @@ -17,7 +17,7 @@ under the License. //// -The resolve task actually resolves dependencies described in an link:../ivyfile.html[Ivy file], and puts the resolved dependencies in the Ivy cache. +The resolve task actually resolves dependencies described in an link:../ivyfile{outfilesuffix}[Ivy file], and puts the resolved dependencies in the Ivy cache. If configure has not been called before resolve is called, a default configuration will be used (equivalent to calling configure without attributes). After the call to this task, four properties are set in Ant: @@ -90,12 +90,12 @@ The resolve mode allows to define how Ivy should use dependency revision constra Two modes are available: -* `default`: in this mode the default revision constraint (expressed with the `rev` attribute in the link:../ivyfile/dependency.html[dependency] element) is used. -* `dynamic`: in this mode the dynamic revision constraint (expressed with the `revConstraint` attribute in the link:../ivyfile/dependency.html[dependency] element) is used. +* `default`: in this mode the default revision constraint (expressed with the `rev` attribute in the link:../ivyfile/dependency{outfilesuffix}[dependency] element) is used. +* `dynamic`: in this mode the dynamic revision constraint (expressed with the `revConstraint` attribute in the link:../ivyfile/dependency{outfilesuffix}[dependency] element) is used. == Concurrency -During resolve, Ivy creates a file in the link:../settings/caches.html[resolution cache]. The creation of this file is not aimed to support concurrency, meaning that you can't have two concurrent resolve of the same module, in the same resolution cache, with the same `resolveId`. +During resolve, Ivy creates a file in the link:../settings/caches{outfilesuffix}[resolution cache]. The creation of this file is not aimed to support concurrency, meaning that you can't have two concurrent resolve of the same module, in the same resolution cache, with the same `resolveId`. __Note for developers__: after the call to this task, a reference to the module descriptor resolved is put in the Ant project under the id `ivy.resolved.descriptor`. @@ -108,14 +108,14 @@ __Note for developers__: after the call to this task, a reference to the module |conf|a comma separated list of the configurations to resolve, or `$$*$$`. (*__since 2.0__*) You can also use `$$*(private)$$`, `$$*(public)$$`. Note that when `inline` is `true`, the configuration `$$*$$` is equivalent as `$$*(public)$$`.|No. Defaults to `${ivy.configurations}` |refresh|`true` to force Ivy to resolve dynamic revision in this resolve process, `false` to use cached resolved revision (*__since 2.0__*)|No. defaults to `false` -|resolveMode|the resolve mode to use for this dependency resolution process (*__since 2.0__*)|No. defaults to using the resolve mode set in the link:../settings.html[settings] +|resolveMode|the resolve mode to use for this dependency resolution process (*__since 2.0__*)|No. defaults to using the resolve mode set in the link:../settings{outfilesuffix}[settings] |inline|`true` to use inline mode, false to resolve an Ivy file (*__since 1.4__*)|No. defaults to `false` |keep|`true` to keep the results of the resolve in memory, false to discard them. When this is `false`, the standard Ivy properties won't be set and other post-resolve tasks (like `retrieve` and `cachepath`) won't be able to reuse the results of this resolve!|No. defaults to `false` for an inline resolve and to `true` in any other case |organisation|the organisation of the module to resolve in inline mode (*__since 1.4__*)|Yes in inline mode, no otherwise. |module|the name of the module to resolve in inline mode (*__since 1.4__*)|Yes in inline mode, no otherwise. |revision|the revision constraint to apply to the module to resolve in inline mode (*__since 1.4__*)|No. Defaults to `latest.integration` in inline mode, nothing in standard mode. |branch|the name of the branch to resolve in inline mode (*__since 2.1__*)|Defaults to no branch in inline mode, nothing in standard mode. -|changing|indicates that the module may change when resolving in inline mode. See link:../concept.html#change[cache and change management] for details. Ignored when resolving in standard mode. (*__since 1.4__*)|No. Defaults to `false`. +|changing|indicates that the module may change when resolving in inline mode. See link:../concept{outfilesuffix}#change[cache and change management] for details. Ignored when resolving in standard mode. (*__since 1.4__*)|No. Defaults to `false`. |type|comma separated list of accepted artifact types (*__since 1.2__*)|No. defaults to `${ivy.resolve.default.type.filter}` |haltonfailure|`true` to halt the build on Ivy failure, false to continue|No. Defaults to `true` |failureproperty|the name of the property to set if the resolve failed (*__since 1.4__*)|No. No property is set by default. @@ -139,16 +139,16 @@ Available options are: + [*__since 2.3__*] -These child elements are defining an inlined ivy.xml's link:../ivyfile/dependencies.html[dependencies] elements. Thus these child elements cannot be used together with the `inline` or `file` attributes. +These child elements are defining an inlined ivy.xml's link:../ivyfile/dependencies{outfilesuffix}[dependencies] elements. Thus these child elements cannot be used together with the `inline` or `file` attributes. -There is one important difference with the ivy.xml's link:../ivyfile/dependencies.html[dependencies]: there is no master configuration to handle here. There is actually only one, the one on which the resolve will run. So every attribute in link:../ivyfile/dependency.html[dependency], link:../ivyfile/exclude.html[exclude], link:../ivyfile/override.html[override] or link:../ivyfile/conflict.html[conflict] which is about a master configuration is not supported. And every attribute about a mapping of a master configuration on a dependency configuration is now expecting only the dependency configuration. +There is one important difference with the ivy.xml's link:../ivyfile/dependencies{outfilesuffix}[dependencies]: there is no master configuration to handle here. There is actually only one, the one on which the resolve will run. So every attribute in link:../ivyfile/dependency{outfilesuffix}[dependency], link:../ivyfile/exclude{outfilesuffix}[exclude], link:../ivyfile/override{outfilesuffix}[override] or link:../ivyfile/conflict{outfilesuffix}[conflict] which is about a master configuration is not supported. And every attribute about a mapping of a master configuration on a dependency configuration is now expecting only the dependency configuration. [options="header",cols="15%,50%,35%"] |======= |Element|Description|Cardinality -|link:../ivyfile/dependency.html[dependency]|declares a dependency to resolve|0..n -|link:../ivyfile/exclude.html[exclude]|excludes artifacts, modules or whole organizations from the set of dependencies to resolve|0..n -|link:../ivyfile/override.html[override]|specify an override mediation rule, overriding the revision and/or branch requested for a transitive dependency (*__since 2.0__*)|0..n +|link:../ivyfile/dependency{outfilesuffix}[dependency]|declares a dependency to resolve|0..n +|link:../ivyfile/exclude{outfilesuffix}[exclude]|excludes artifacts, modules or whole organizations from the set of dependencies to resolve|0..n +|link:../ivyfile/override{outfilesuffix}[override]|specify an override mediation rule, overriding the revision and/or branch requested for a transitive dependency (*__since 2.0__*)|0..n |======= == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/8736a161/asciidoc/use/resources.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/resources.adoc b/asciidoc/use/resources.adoc index 28b088b..c11d8b7 100644 --- a/asciidoc/use/resources.adoc +++ b/asciidoc/use/resources.adoc @@ -21,7 +21,7 @@ `ivy:resources` is an Ant link:https://ant.apache.org/manual/Types/resources.html#collection[resource collection], containing files found by an Ivy resolve, which then can be used with any task working with resources like `copy` or `import`. -This datatype shares the same attributes, child elements and behaviour of a link:../use/postresolvetask.html[post resolve task]. It is not expected to be used as an Ant task though, only as a resource collection. +This datatype shares the same attributes, child elements and behaviour of a link:../use/postresolvetask{outfilesuffix}[post resolve task]. It is not expected to be used as an Ant task though, only as a resource collection. == Examples http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/8736a161/asciidoc/use/retrieve.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/retrieve.adoc b/asciidoc/use/retrieve.adoc index 0b752e0..14c2850 100644 --- a/asciidoc/use/retrieve.adoc +++ b/asciidoc/use/retrieve.adoc @@ -19,7 +19,7 @@ The `retrieve` task copies resolved dependencies anywhere you want in your file system. -This is a link:../use/postresolvetask.html[post resolve task], with all the behaviour and attributes common to all post resolve tasks. +This is a link:../use/postresolvetask{outfilesuffix}[post resolve task], with all the behaviour and attributes common to all post resolve tasks. (*__since 1.4__*) This task can even be used to synchronize the destination directory with what should actually be in according to the dependency resolution. This means that by setting `sync="true"`, Ivy will not only copy the necessary files, but it will also remove the files which do not need to be there. @@ -55,7 +55,7 @@ If this option is set to `true` and symbolic link creation fails, then the retri |settingsRef|A reference to Ivy settings that must be used by this task (*__since 2.0__*)|No, defaults ot `ivy.instance`. |log|the log setting to use during the resolve and retrieve process. (*__since 2.0__*) -Available options are the same as for link:../use/resolve.html[resolve] when used to trigger resolve automatically (see link:../use/postresolvetask.html[postresolvetask]), or the following for the retrieve process only: + +Available options are the same as for link:../use/resolve{outfilesuffix}[resolve] when used to trigger resolve automatically (see link:../use/postresolvetask{outfilesuffix}[postresolvetask]), or the following for the retrieve process only: + * `default`: the default log settings, where all usual messages are output to the console + * `quiet`: disable all usual messages, making the whole retrieve process quiet unless errors occur |No, defaults to `default`. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/8736a161/asciidoc/use/settings.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/settings.adoc b/asciidoc/use/settings.adoc index e2e2d0b..8e91a1a 100644 --- a/asciidoc/use/settings.adoc +++ b/asciidoc/use/settings.adoc @@ -19,9 +19,9 @@ [*__since 2.0__*] -The settings declaration is used to configure Ivy with a settings XML file. The difference with the link:../use/configure.html[configure] task is that when using the settings declaration, the configuration of Ivy will be done when the settings are first needed (for instance, when you do a resolve), while the configure task will perform a configuration of Ivy instantly, which makes it easier to see the problem if something goes wrong. +The settings declaration is used to configure Ivy with a settings XML file. The difference with the link:../use/configure{outfilesuffix}[configure] task is that when using the settings declaration, the configuration of Ivy will be done when the settings are first needed (for instance, when you do a resolve), while the configure task will perform a configuration of Ivy instantly, which makes it easier to see the problem if something goes wrong. -See link:../settings.html[Settings Files] for details about the settings file itself. +See link:../settings{outfilesuffix}[Settings Files] for details about the settings file itself. Multiple settings can be defined in a build script. Every task can reference its own settings. @@ -44,7 +44,7 @@ my.variable.yourid=your.value |Attribute|Description|Required |id|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 a link:../tutorial/defaultconf.html[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 a link:../tutorial/defaultconf{outfilesuffix}[default settings file] |url|URL of the settings file to use |host|HTTP authentication host .4+.^|No, unless authentication is required http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/8736a161/asciidoc/use/var.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/var.adoc b/asciidoc/use/var.adoc index a729d88..e5d5952 100644 --- a/asciidoc/use/var.adoc +++ b/asciidoc/use/var.adoc @@ -25,7 +25,7 @@ Contrary to Ant properties, Ivy variables are mutable. But a problem with this i variables are substituted, and usually it is done as soon as possible. So changing the value of a variable will have no effect if it has already been substituted. Consequently, *using this task is NOT recommended*. -See link:../reference.html[reference] page for details about Ivy variables. +See link:../reference{outfilesuffix}[reference] page for details about Ivy variables. == Attributes
