Repository: ant-ivy Updated Branches: refs/heads/master 44d800e1c -> d7ddccdc6
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/d7ddccdc/asciidoc/settings/resolvers.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/resolvers.adoc b/asciidoc/settings/resolvers.adoc index 1c1680d..2a68f81 100644 --- a/asciidoc/settings/resolvers.adoc +++ b/asciidoc/settings/resolvers.adoc @@ -51,7 +51,7 @@ Note that this works only if the resolver has already been defined and *NOT* if Ivy comes with a set of built-in dependency resolvers that handle most common needs. -If you don't find the one you want here, you can also check if someone has contributed it on the links page, or even link:../extend.html[write your own]. +If you don't find the one you want here, you can also check if someone has contributed it on the links page, or even link:../extend{outfilesuffix}[write your own]. There are basically two types of resolvers in Ivy - composite and standard. A composite resolver is a resolver which delegates the work to other resolvers. The other resolvers are standard resolvers. @@ -61,22 +61,22 @@ Here is the list of built-in resolvers: [options="header",cols="15%,50%,35%"] |======= |Name|Type|Description -|link:../resolver/ivyrep.html[IvyRep]|Standard|Finds Ivy files on ivyrep and artifacts on ibiblio. -|link:../resolver/ibiblio.html[IBiblio]|Standard|Finds artifacts on ibiblio. -|link:../resolver/bintray.html[BinTray]|Standard|Finds artifacts on bintray. -|link:../resolver/packager.html[Packager]|Standard|Finds Ivy files and packaging instructions via URLs, then creates artifacts by following the instructions. -|link:../resolver/filesystem.html[FileSystem]|Standard|This very performant resolver finds Ivy files and artifacts in your file system. -|link:../resolver/url.html[URL]|Standard|Finds Ivy files and artifacts in any repository accessible with URLs. -|link:../resolver/url.html[MirroredURL]|Standard|Finds Ivy files and artifacts in any repository accessible with URLs from a mirror list. -|link:../resolver/vfs.html[VFS]|Standard|Finds Ivy files and artifacts in any repository accessible with link:https://commons.apache.org/proper/commons-vfs/[Apache Commons VFS]. -|link:../resolver/ssh.html[SSH]|Standard|Finds Ivy files and artifacts in any repository accessible with SSH. -|link:../resolver/sftp.html[SFTP]|Standard|Finds Ivy files and artifacts in any repository accessible with SFTP. -|link:../resolver/jar.html[Jar]|Standard|Finds Ivy files and artifacts within a specified jar. -|link:../resolver/chain.html[Chain]|Composite|Delegates the finding to a chain of sub resolvers. -|link:../resolver/dual.html[Dual]|Composite|Delegates the finding of Ivy files to one resolver and of artifacts to another. -|link:../resolver/obr.html[OBR]|Standard|Resolve modules as OSGi bundles listed by an OSGi obr.xml. -|link:../resolver/updatesite.html[Eclipse updatesite]|Standard|Resolve modules as OSGi bundles which are hosted on an Eclipse update site. -|link:../resolver/osgiagg.html[OSGi-agg]|Composite|Delegates the finding to a chain of sub resolvers supporting OSGi bundles. +|link:../resolver/ivyrep{outfilesuffix}[IvyRep]|Standard|Finds Ivy files on ivyrep and artifacts on ibiblio. +|link:../resolver/ibiblio{outfilesuffix}[IBiblio]|Standard|Finds artifacts on ibiblio. +|link:../resolver/bintray{outfilesuffix}[BinTray]|Standard|Finds artifacts on bintray. +|link:../resolver/packager{outfilesuffix}[Packager]|Standard|Finds Ivy files and packaging instructions via URLs, then creates artifacts by following the instructions. +|link:../resolver/filesystem{outfilesuffix}[FileSystem]|Standard|This very performant resolver finds Ivy files and artifacts in your file system. +|link:../resolver/url{outfilesuffix}[URL]|Standard|Finds Ivy files and artifacts in any repository accessible with URLs. +|link:../resolver/url{outfilesuffix}[MirroredURL]|Standard|Finds Ivy files and artifacts in any repository accessible with URLs from a mirror list. +|link:../resolver/vfs{outfilesuffix}[VFS]|Standard|Finds Ivy files and artifacts in any repository accessible with link:https://commons.apache.org/proper/commons-vfs/[Apache Commons VFS]. +|link:../resolver/ssh{outfilesuffix}[SSH]|Standard|Finds Ivy files and artifacts in any repository accessible with SSH. +|link:../resolver/sftp{outfilesuffix}[SFTP]|Standard|Finds Ivy files and artifacts in any repository accessible with SFTP. +|link:../resolver/jar{outfilesuffix}[Jar]|Standard|Finds Ivy files and artifacts within a specified jar. +|link:../resolver/chain{outfilesuffix}[Chain]|Composite|Delegates the finding to a chain of sub resolvers. +|link:../resolver/dual{outfilesuffix}[Dual]|Composite|Delegates the finding of Ivy files to one resolver and of artifacts to another. +|link:../resolver/obr{outfilesuffix}[OBR]|Standard|Resolve modules as OSGi bundles listed by an OSGi obr.xml. +|link:../resolver/updatesite{outfilesuffix}[Eclipse updatesite]|Standard|Resolve modules as OSGi bundles which are hosted on an Eclipse update site. +|link:../resolver/osgiagg{outfilesuffix}[OSGi-agg]|Composite|Delegates the finding to a chain of sub resolvers supporting OSGi bundles. |======= @@ -110,7 +110,7 @@ By using such a resolver at the beginning of a chain, you can be sure that Ivy w [*__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. +All standard resolvers support the `timeoutConstraint` attribute. The value for this attribute is the name of the link:timeout-constraint{outfilesuffix}[timeout-constraint] that's been defined in the Ivy settings. Resolvers can be optionally configured to use a `timeoutConstraint` so that the timeouts defined on that constraint dictate how the resolvers behave when it comes to dealing with timeouts while establishing connections and reading content, during module descriptor and artifact resolutions. @@ -130,18 +130,18 @@ And setting the property `ivy.maven.lookup.javadoc` to `false` disables the look |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 |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 +|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{outfilesuffix}#change[cache and change management] for details.|No, defaults to none|Yes|Yes +|changingMatcher|The name of the link:../concept{outfilesuffix}#matcher[pattern matcher] to use to match a revision against the configured changingPattern (*__since 1.4__*). See link:../concept{outfilesuffix}#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, we recommend using 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 +|checksums|a comma separated list of link:../concept{outfilesuffix}#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{outfilesuffix}[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{outfilesuffix}[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/d7ddccdc/asciidoc/settings/timeout-constraint.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/settings/timeout-constraint.adoc b/asciidoc/settings/timeout-constraint.adoc index 1cd5090..edd6bf4 100644 --- a/asciidoc/settings/timeout-constraint.adoc +++ b/asciidoc/settings/timeout-constraint.adoc @@ -21,7 +21,7 @@ *Tag:* timeout-constraint -[ivysettings.timeout-constraint]#Defines a named timeout constraint that can then be referenced from other places of the Ivy settings file, like the link:resolvers.html[resolvers].# +[ivysettings.timeout-constraint]#Defines a named timeout constraint that can then be referenced from other places of the Ivy settings file, like the link:resolvers{outfilesuffix}[resolvers].# == Attributes http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/d7ddccdc/asciidoc/terminology.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/terminology.adoc b/asciidoc/terminology.adoc index 61cf36e..32e9ab6 100644 --- a/asciidoc/terminology.adoc +++ b/asciidoc/terminology.adoc @@ -60,7 +60,7 @@ __Examples: hibernate-entitymanager, ant__ A _module descriptor_ is a generic way of identifying what describes a module: the identifier (organisation, module name, branch and revision), the published artifacts, possible configurations and their dependencies. -The most common module descriptors in Ivy are link:ivyfile.html[Ivy Files], XML files with an Ivy specific syntax, and usually called ivy.xml. +The most common module descriptors in Ivy are link:ivyfile{outfilesuffix}[Ivy Files], XML files with an Ivy specific syntax, and usually called ivy.xml. But since Ivy is also compatible with Maven 2 metadata format (called POM, for Project Object Model), POM files fall into the category of module descriptors. @@ -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{outfilesuffix}[configurable] in your settings file. == [[configurations]]Configurations of a module @@ -137,7 +137,7 @@ A _module configuration_ is a way to use or construct a module. If the same modu Some modules may be used in different ways (think about hibernate which can be used inside or outside an application server), and this way may alter the artifacts you need (in the case of hibernate, jta.jar is needed only if it is used outside an application server). Moreover, a module may need some other modules and artifacts only at build time, and some others at runtime. All those different ways to use or build a module are called module configurations in Ivy. -For more details on configurations and how they are used in Ivy, please refer to the link:concept.html[main concepts page]. +For more details on configurations and how they are used in Ivy, please refer to the link:concept{outfilesuffix}[main concepts page]. == [[settings]]Ivy Settings @@ -151,4 +151,4 @@ Prior to Ivy 2.0, the settings files were called configuration files and usually What is called a _repository_ in Ivy is a distribution site location where Ivy is able to find your required modules' artifacts and descriptors (i.e. Ivy files in most cases). -Ivy can be used with complex repositories configured very finely. You can use link:concept.html[Dependency Resolvers] to do so. +Ivy can be used with complex repositories configured very finely. You can use link:concept{outfilesuffix}[Dependency Resolvers] to do so. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/d7ddccdc/asciidoc/tutorial.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/tutorial.adoc b/asciidoc/tutorial.adoc index 5205105..f1047e2 100644 --- a/asciidoc/tutorial.adoc +++ b/asciidoc/tutorial.adoc @@ -34,33 +34,33 @@ For the first tutorial you won't even have to install Ivy (assuming you have Ant If you have any trouble, check our link:https://ant.apache.org/ivy/faq.html[FAQ]. -OK, you've just seen how easy it is to take your first step with Ivy. Go ahead with the other tutorials, but before you do, make sure you have properly link:install.html[installed] Ivy and downloaded the tutorials sources (included in all Ivy distributions, in the link:https://git-wip-us.apache.org/repos/asf?p=ant-ivy.git;a=tree;f=src/example[src/example] directory). +OK, you've just seen how easy it is to take your first step with Ivy. Go ahead with the other tutorials, but before you do, make sure you have properly link:install{outfilesuffix}[installed] Ivy and downloaded the tutorials sources (included in all Ivy distributions, in the link:https://git-wip-us.apache.org/repos/asf?p=ant-ivy.git;a=tree;f=src/example[src/example] directory). == List of available tutorials The following tutorials are available: - * link:tutorial/start.html[Quick Start] + + * link:tutorial/start{outfilesuffix}[Quick Start] + Guides you through your very first steps with Ivy. - * link:tutorial/defaultconf.html[Adjusting default settings] + + * link:tutorial/defaultconf{outfilesuffix}[Adjusting default settings] + Gives you a better understanding of the default settings and shows you how to customize them to your needs. - * link:tutorial/multiple.html[Multiple Resolvers] + + * link:tutorial/multiple{outfilesuffix}[Multiple Resolvers] + Teaches you how to configure Ivy to find its dependencies in multiple places. - * link:tutorial/dual.html[Dual Resolver] + + * link:tutorial/dual{outfilesuffix}[Dual Resolver] + Helps you configure Ivy to find Ivy files in one place and artifacts in another. - * link:tutorial/dependence.html[Project dependencies] + + * link:tutorial/dependence{outfilesuffix}[Project dependencies] + A starting point for using Ivy in a multi-project environment. - * link:tutorial/multiproject.html[Using Ivy in multiple projects environment] + + * link:tutorial/multiproject{outfilesuffix}[Using Ivy in multiple projects environment] + A more complex example demonstrating the use of Ant+Ivy in a multi-project environment. - * link:tutorial/conf.html[Using Ivy Module Configurations] + + * link:tutorial/conf{outfilesuffix}[Using Ivy Module Configurations] + Shows you how to use configurations in an Ivy file to define sets of artifacts. - * link:tutorial/build-repository.html[Building a repository] + + * link:tutorial/build-repository{outfilesuffix}[Building a repository] + Shows you how to build your own enterprise repository. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/d7ddccdc/asciidoc/use/info.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/info.adoc b/asciidoc/use/info.adoc index 7cc01ba..4d32b45 100644 --- a/asciidoc/use/info.adoc +++ b/asciidoc/use/info.adoc @@ -26,15 +26,15 @@ The information is retrieved by setting Ant properties: [options="header",cols="30%,50%"] |======= |Property|Description -|ivy.organisation|The organisation of the module, as found in the link:../ivyfile/info.html[info] tag of the Ivy file parsed. -|ivy.module|The name of the module, as found in the link:../ivyfile/info.html[info] tag of the Ivy file parsed. -|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.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.organisation|The organisation of the module, as found in the link:../ivyfile/info{outfilesuffix}[info] tag of the Ivy file parsed. +|ivy.module|The name of the module, as found in the link:../ivyfile/info{outfilesuffix}[info] tag of the Ivy file parsed. +|ivy.branch|The branch of the module if any, as found in the link:../ivyfile/info{outfilesuffix}[info] tag of the Ivy file parsed. +|ivy.revision|The revision of the module, as found in the link:../ivyfile/info{outfilesuffix}[info] tag of the Ivy file parsed. +|ivy.status|The status of the module, as found in the link:../ivyfile/info{outfilesuffix}[info] tag of the Ivy file parsed. +|ivy.publication|The publication time of the module, as found in the link:../ivyfile/info{outfilesuffix}[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{outfilesuffix}[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{outfilesuffix}[configurations] section +|ivy.public.configurations|A comma separated list of public configurations of the module, as declared in the link:../ivyfile/configurations{outfilesuffix}[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__*) @@ -47,7 +47,7 @@ The information is retrieved by setting Ant properties: 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. +The revision pattern is what is used when declaring a link:../ivyfile/dependency{outfilesuffix}[dependency] on a module, identical to how the link:findrevision{outfilesuffix}[findrevision] task works. In fact, this task can now be used in place of the findrevision task. If no matching module is found then no property values are set.
