From 2931da346cc42a80f4df539d74df84ab8bbfd0a2 Mon Sep 17 00:00:00 2001 From: Xavier Hanin Date: Fri, 11 Jul 2008 08:03:23 +0000 Subject: [PATCH] DOCUMENTATION: Fixed more than a hundred (100+) obsolete "configuration" references; replaced with "settings" (IVY-863) (thanks to Sakari Maaranen) git-svn-id: https://svn.apache.org/repos/asf/ant/ivy/core/trunk@675856 13f79535-47bb-0310-9956-ffa450edef68 --- doc/concept.html | 6 +- doc/configuration.html | 132 +------- doc/configuration/caches.html | 68 +--- doc/configuration/caches/cache.html | 64 +--- doc/configuration/caches/ttl.html | 44 +-- doc/configuration/classpath.html | 46 +-- doc/configuration/conf.html | 54 +-- doc/configuration/conflict-managers.html | 42 +-- doc/configuration/include.html | 51 +-- doc/configuration/latest-strategies.html | 65 +--- doc/configuration/lock-strategies.html | 38 +-- doc/configuration/macrodef.html | 126 +------ doc/configuration/macrodef/attribute.html | 24 +- doc/configuration/module.html | 85 +---- doc/configuration/modules.html | 26 +- doc/configuration/namespace.html | 102 +----- doc/configuration/namespace/dest.html | 39 +-- doc/configuration/namespace/fromtosystem.html | 23 +- doc/configuration/namespace/rule.html | 25 +- doc/configuration/namespace/src.html | 25 +- doc/configuration/namespaces.html | 33 +- doc/configuration/outputters.html | 40 +-- doc/configuration/parsers.html | 28 +- doc/configuration/properties.html | 26 +- doc/configuration/property.html | 36 +- doc/configuration/resolvers.html | 171 +--------- doc/configuration/status.html | 23 +- doc/configuration/statuses.html | 47 +-- doc/configuration/triggers.html | 287 +--------------- doc/configuration/typedef.html | 22 +- doc/configuration/version-matchers.html | 26 +- doc/index.html | 2 +- doc/ivyfile/conf.html | 4 +- doc/ivyfile/conflict.html | 2 +- doc/ivyfile/conflicts.html | 2 +- doc/ivyfile/dependencies.html | 2 +- doc/ivyfile/dependency.html | 10 +- doc/ivyfile/include.html | 2 +- doc/ivyfile/info.html | 2 +- doc/reference.html | 2 +- doc/resolver/chain.html | 2 +- doc/resolver/dual.html | 2 +- doc/resolver/filesystem.html | 4 +- doc/resolver/ibiblio.html | 2 +- doc/resolver/ivyrep.html | 2 +- doc/resolver/packager.html | 2 +- doc/resolver/sftp.html | 2 +- doc/resolver/ssh.html | 2 +- doc/resolver/url.html | 2 +- doc/resolver/vfs.html | 2 +- doc/settings.html | 156 +++++++++ doc/settings/caches.html | 92 ++++++ doc/settings/caches/cache.html | 88 +++++ doc/settings/caches/ttl.html | 70 ++++ doc/settings/classpath.html | 72 ++++ doc/settings/conflict-managers.html | 68 ++++ doc/settings/include.html | 77 +++++ doc/settings/latest-strategies.html | 91 +++++ doc/settings/lock-strategies.html | 62 ++++ doc/settings/macrodef.html | 152 +++++++++ doc/settings/macrodef/attribute.html | 48 +++ doc/settings/module.html | 111 +++++++ doc/settings/modules.html | 52 +++ doc/settings/namespace.html | 128 +++++++ doc/settings/namespace/dest.html | 63 ++++ doc/settings/namespace/fromtosystem.html | 47 +++ doc/settings/namespace/rule.html | 49 +++ doc/settings/namespace/src.html | 49 +++ doc/settings/namespaces.html | 59 ++++ doc/settings/outputters.html | 66 ++++ doc/settings/parsers.html | 54 +++ doc/settings/properties.html | 52 +++ doc/settings/property.html | 62 ++++ doc/settings/resolvers.html | 197 +++++++++++ doc/settings/settings.html | 80 +++++ doc/settings/status.html | 49 +++ doc/settings/statuses.html | 73 ++++ doc/settings/triggers.html | 311 ++++++++++++++++++ doc/settings/typedef.html | 48 +++ doc/settings/version-matchers.html | 52 +++ doc/terminology.html | 2 +- doc/toc.json | 62 ++-- doc/tutorial.html | 4 +- doc/tutorial/build-repository.html | 2 +- doc/tutorial/build-repository/advanced.html | 2 +- doc/tutorial/build-repository/basic.html | 4 +- doc/tutorial/conf.html | 2 +- doc/tutorial/defaultconf.html | 4 +- doc/tutorial/dependence.html | 2 +- doc/use/buildlist.html | 2 +- doc/use/configure.html | 2 +- doc/use/makepom.html | 2 +- doc/use/publish.html | 4 +- doc/use/resolve.html | 4 +- doc/use/settings.html | 2 +- 95 files changed, 2786 insertions(+), 1766 deletions(-) create mode 100644 doc/settings.html create mode 100644 doc/settings/caches.html create mode 100644 doc/settings/caches/cache.html create mode 100644 doc/settings/caches/ttl.html create mode 100644 doc/settings/classpath.html create mode 100644 doc/settings/conflict-managers.html create mode 100644 doc/settings/include.html create mode 100644 doc/settings/latest-strategies.html create mode 100644 doc/settings/lock-strategies.html create mode 100644 doc/settings/macrodef.html create mode 100644 doc/settings/macrodef/attribute.html create mode 100644 doc/settings/module.html create mode 100644 doc/settings/modules.html create mode 100644 doc/settings/namespace.html create mode 100644 doc/settings/namespace/dest.html create mode 100644 doc/settings/namespace/fromtosystem.html create mode 100644 doc/settings/namespace/rule.html create mode 100644 doc/settings/namespace/src.html create mode 100644 doc/settings/namespaces.html create mode 100644 doc/settings/outputters.html create mode 100644 doc/settings/parsers.html create mode 100644 doc/settings/properties.html create mode 100644 doc/settings/property.html create mode 100644 doc/settings/resolvers.html create mode 100644 doc/settings/settings.html create mode 100644 doc/settings/status.html create mode 100644 doc/settings/statuses.html create mode 100644 doc/settings/triggers.html create mode 100644 doc/settings/typedef.html create mode 100644 doc/settings/version-matchers.html diff --git a/doc/concept.html b/doc/concept.html index 90abf108..88172b4a 100644 --- a/doc/concept.html +++ b/doc/concept.html @@ -245,13 +245,13 @@ Ivy cache is composed of two different parts: -While there is always only one resolution cache, you can [[configuration/caches define multiple repository caches]], each [[configuration/resolvers resolver]] being able to use a separate cache. +While there is always only one resolution cache, you can [[settings/caches define multiple repository caches]], each [[settings/resolvers resolver]] being able to use a separate cache.

Change management

To optimize the dependency resolution and the way the cache is used, Ivy assumes by default that a revision never changes. So once Ivy has a module in its cache (metadata and artifacts), it trusts the cache and do not even query the repository. This optimization is very useful in most cases, and causes no problem as long as you respect this paradigm: a revision never changes. Besides performance, there are several [[bestpractices good reasons]] to follow this principle. @@ -264,7 +264,7 @@ In this case, setting checkModified="true" on your dependency resolver will be t

Changes in artifacts

Some people, especially those coming from maven 2 land, like to use one special revision to handle often updated modules. In maven 2 this is called a SNAPSHOT version, and some argue that it helps saves disk space to keep only one version for the high number of intermediary builds you can make whilst developing. -Ivy supports this kind of approach with the notion of changing revision. A changing revision is just that: a revision for which Ivy should consider that the artifacts may change over time. To handle this, you can either specify a dependency as changing on the [[ivyfile/dependency]] tag, or use the changingPattern and changingMatcher attributes on your [[configuration/resolvers]] to indicate which revision or group of revisions should be considered as changing. +Ivy supports this kind of approach with the notion of changing revision. A changing revision is just that: a revision for which Ivy should consider that the artifacts may change over time. To handle this, you can either specify a dependency as changing on the [[ivyfile/dependency]] tag, or use the changingPattern and changingMatcher attributes on your [[settings/resolvers]] to indicate which revision or group of revisions should be considered as changing. Once Ivy knows that a revision is changing, it will follow this principle to avoid checking your repository too often: if the module metadata has not changed, it will considered the whole module (including artifacts) as not changed. Even if the module descriptor file has changed, it will check the publication data of the module to see if this is a new publication of the same revision or not. Then if the publication date has changed, it will check the artifacts last modified timestamps, and download them accordingly. diff --git a/doc/configuration.html b/doc/configuration.html index cca8b310..ad4aeea5 100644 --- a/doc/configuration.html +++ b/doc/configuration.html @@ -22,135 +22,13 @@ + - + diff --git a/doc/configuration/caches.html b/doc/configuration/caches.html index a1295cd3..3c4483c5 100644 --- a/doc/configuration/caches.html +++ b/doc/configuration/caches.html @@ -22,71 +22,13 @@ + - + diff --git a/doc/configuration/caches/cache.html b/doc/configuration/caches/cache.html index 56cea831..f87f7833 100644 --- a/doc/configuration/caches/cache.html +++ b/doc/configuration/caches/cache.html @@ -22,67 +22,13 @@ + - + diff --git a/doc/configuration/caches/ttl.html b/doc/configuration/caches/ttl.html index a049fd77..0b53fbc0 100644 --- a/doc/configuration/caches/ttl.html +++ b/doc/configuration/caches/ttl.html @@ -22,48 +22,12 @@ + - diff --git a/doc/configuration/classpath.html b/doc/configuration/classpath.html index 16fc1ced..04934698 100644 --- a/doc/configuration/classpath.html +++ b/doc/configuration/classpath.html @@ -22,50 +22,12 @@ + - diff --git a/doc/configuration/conf.html b/doc/configuration/conf.html index dbdbc349..65566cc5 100644 --- a/doc/configuration/conf.html +++ b/doc/configuration/conf.html @@ -22,58 +22,12 @@ + - diff --git a/doc/configuration/conflict-managers.html b/doc/configuration/conflict-managers.html index 24fe4985..b5d9a65e 100644 --- a/doc/configuration/conflict-managers.html +++ b/doc/configuration/conflict-managers.html @@ -22,46 +22,12 @@ + - diff --git a/doc/configuration/include.html b/doc/configuration/include.html index 6649e2e1..d993c815 100644 --- a/doc/configuration/include.html +++ b/doc/configuration/include.html @@ -22,55 +22,12 @@ + - diff --git a/doc/configuration/latest-strategies.html b/doc/configuration/latest-strategies.html index 1ff1e0e4..66585836 100644 --- a/doc/configuration/latest-strategies.html +++ b/doc/configuration/latest-strategies.html @@ -22,69 +22,12 @@ + - diff --git a/doc/configuration/lock-strategies.html b/doc/configuration/lock-strategies.html index 3e1fc7d5..0f203f18 100644 --- a/doc/configuration/lock-strategies.html +++ b/doc/configuration/lock-strategies.html @@ -22,41 +22,13 @@ + - + diff --git a/doc/configuration/macrodef.html b/doc/configuration/macrodef.html index da619087..7f672b72 100644 --- a/doc/configuration/macrodef.html +++ b/doc/configuration/macrodef.html @@ -22,130 +22,12 @@ + - diff --git a/doc/configuration/macrodef/attribute.html b/doc/configuration/macrodef/attribute.html index 5057b9c8..63031e6e 100644 --- a/doc/configuration/macrodef/attribute.html +++ b/doc/configuration/macrodef/attribute.html @@ -22,27 +22,13 @@ + - + diff --git a/doc/configuration/module.html b/doc/configuration/module.html index df1b6b40..4e7879a5 100644 --- a/doc/configuration/module.html +++ b/doc/configuration/module.html @@ -22,89 +22,12 @@ + - diff --git a/doc/configuration/modules.html b/doc/configuration/modules.html index 80b5fbaa..0c88f091 100644 --- a/doc/configuration/modules.html +++ b/doc/configuration/modules.html @@ -22,30 +22,12 @@ + - diff --git a/doc/configuration/namespace.html b/doc/configuration/namespace.html index 0ea22e12..ec66c715 100644 --- a/doc/configuration/namespace.html +++ b/doc/configuration/namespace.html @@ -22,106 +22,12 @@ + - diff --git a/doc/configuration/namespace/dest.html b/doc/configuration/namespace/dest.html index 297a19df..0fbec184 100644 --- a/doc/configuration/namespace/dest.html +++ b/doc/configuration/namespace/dest.html @@ -22,42 +22,13 @@ + - + diff --git a/doc/configuration/namespace/fromtosystem.html b/doc/configuration/namespace/fromtosystem.html index 291804a5..e47486eb 100644 --- a/doc/configuration/namespace/fromtosystem.html +++ b/doc/configuration/namespace/fromtosystem.html @@ -22,26 +22,13 @@ + - + diff --git a/doc/configuration/namespace/rule.html b/doc/configuration/namespace/rule.html index b8714826..df25aa3b 100644 --- a/doc/configuration/namespace/rule.html +++ b/doc/configuration/namespace/rule.html @@ -22,28 +22,13 @@ + - + diff --git a/doc/configuration/namespace/src.html b/doc/configuration/namespace/src.html index d87f4d5b..d1577873 100644 --- a/doc/configuration/namespace/src.html +++ b/doc/configuration/namespace/src.html @@ -22,28 +22,13 @@ + - + diff --git a/doc/configuration/namespaces.html b/doc/configuration/namespaces.html index 79601e9e..6c8a3fbf 100644 --- a/doc/configuration/namespaces.html +++ b/doc/configuration/namespaces.html @@ -22,37 +22,12 @@ + - diff --git a/doc/configuration/outputters.html b/doc/configuration/outputters.html index c4c87def..2149014f 100644 --- a/doc/configuration/outputters.html +++ b/doc/configuration/outputters.html @@ -22,44 +22,12 @@ + - diff --git a/doc/configuration/parsers.html b/doc/configuration/parsers.html index 70938140..4d21ece3 100644 --- a/doc/configuration/parsers.html +++ b/doc/configuration/parsers.html @@ -22,32 +22,12 @@ + - diff --git a/doc/configuration/properties.html b/doc/configuration/properties.html index f6f5904f..af5c6910 100644 --- a/doc/configuration/properties.html +++ b/doc/configuration/properties.html @@ -22,30 +22,12 @@ + - diff --git a/doc/configuration/property.html b/doc/configuration/property.html index 9455e73b..d8788cb8 100644 --- a/doc/configuration/property.html +++ b/doc/configuration/property.html @@ -22,40 +22,12 @@ + - diff --git a/doc/configuration/resolvers.html b/doc/configuration/resolvers.html index f8f32830..695837bc 100644 --- a/doc/configuration/resolvers.html +++ b/doc/configuration/resolvers.html @@ -22,175 +22,12 @@ + - diff --git a/doc/configuration/status.html b/doc/configuration/status.html index 7061e698..a6e75362 100644 --- a/doc/configuration/status.html +++ b/doc/configuration/status.html @@ -22,27 +22,12 @@ + - diff --git a/doc/configuration/statuses.html b/doc/configuration/statuses.html index 78cb0880..87935f47 100644 --- a/doc/configuration/statuses.html +++ b/doc/configuration/statuses.html @@ -22,51 +22,12 @@ + - diff --git a/doc/configuration/triggers.html b/doc/configuration/triggers.html index ff1693dc..b1b36d4e 100644 --- a/doc/configuration/triggers.html +++ b/doc/configuration/triggers.html @@ -22,290 +22,13 @@ + - + diff --git a/doc/configuration/typedef.html b/doc/configuration/typedef.html index 3e5c94dc..ced05303 100644 --- a/doc/configuration/typedef.html +++ b/doc/configuration/typedef.html @@ -22,26 +22,12 @@ + - diff --git a/doc/configuration/version-matchers.html b/doc/configuration/version-matchers.html index 6d060709..70066928 100644 --- a/doc/configuration/version-matchers.html +++ b/doc/configuration/version-matchers.html @@ -22,30 +22,12 @@ + - diff --git a/doc/index.html b/doc/index.html index d9b3a876..6f61b615 100644 --- a/doc/index.html +++ b/doc/index.html @@ -71,7 +71,7 @@ The tutorials is the best way to begin to play with ivy. You will easily and qui
  • [[reference]]
    • The reference documentation gives you all the details of Ivy. The introduction part is particularly useful: it defines some vocabulary, explains main concepts such as dependency resolvers and patterns, and give an overview on how ivy works internally. -It's also in the reference doc that you will find all you always dreamed to know about ivy configuration, ivy files, and ivy use (especially with ant). +It's also in the reference doc that you will find all you always dreamed to know about ivy settings, ivy files, and ivy use (especially with ant).
  • [[dev]]
    • The developers's doc is useful for users who would like to extend Ivy or build it from source. It's also the documentation used by the Ivy team, so you will also find information about how we make releases. diff --git a/doc/ivyfile/conf.html b/doc/ivyfile/conf.html index 6cda333f..bb9d3154 100644 --- a/doc/ivyfile/conf.html +++ b/doc/ivyfile/conf.html @@ -25,9 +25,9 @@ + + + diff --git a/doc/settings/caches.html b/doc/settings/caches.html new file mode 100644 index 00000000..282b5303 --- /dev/null +++ b/doc/settings/caches.html @@ -0,0 +1,92 @@ + + + + + + + + + + + + + diff --git a/doc/settings/caches/cache.html b/doc/settings/caches/cache.html new file mode 100644 index 00000000..db844b5f --- /dev/null +++ b/doc/settings/caches/cache.html @@ -0,0 +1,88 @@ + + + + + + + + + + + + + diff --git a/doc/settings/caches/ttl.html b/doc/settings/caches/ttl.html new file mode 100644 index 00000000..a049fd77 --- /dev/null +++ b/doc/settings/caches/ttl.html @@ -0,0 +1,70 @@ + + + + + + + + + + + + + diff --git a/doc/settings/classpath.html b/doc/settings/classpath.html new file mode 100644 index 00000000..16fc1ced --- /dev/null +++ b/doc/settings/classpath.html @@ -0,0 +1,72 @@ + + + + + + + + + + + + + diff --git a/doc/settings/conflict-managers.html b/doc/settings/conflict-managers.html new file mode 100644 index 00000000..24fe4985 --- /dev/null +++ b/doc/settings/conflict-managers.html @@ -0,0 +1,68 @@ + + + + + + + + + + + + + diff --git a/doc/settings/include.html b/doc/settings/include.html new file mode 100644 index 00000000..07b24c1a --- /dev/null +++ b/doc/settings/include.html @@ -0,0 +1,77 @@ + + + + + + + + + + + + + diff --git a/doc/settings/latest-strategies.html b/doc/settings/latest-strategies.html new file mode 100644 index 00000000..1ff1e0e4 --- /dev/null +++ b/doc/settings/latest-strategies.html @@ -0,0 +1,91 @@ + + + + + + + + + + + + + diff --git a/doc/settings/lock-strategies.html b/doc/settings/lock-strategies.html new file mode 100644 index 00000000..1e25c3fe --- /dev/null +++ b/doc/settings/lock-strategies.html @@ -0,0 +1,62 @@ + + + + + + + + + + + + + diff --git a/doc/settings/macrodef.html b/doc/settings/macrodef.html new file mode 100644 index 00000000..37f7dd6d --- /dev/null +++ b/doc/settings/macrodef.html @@ -0,0 +1,152 @@ + + + + + + + + + + + + + diff --git a/doc/settings/macrodef/attribute.html b/doc/settings/macrodef/attribute.html new file mode 100644 index 00000000..5057b9c8 --- /dev/null +++ b/doc/settings/macrodef/attribute.html @@ -0,0 +1,48 @@ + + + + + + + + + + + + + diff --git a/doc/settings/module.html b/doc/settings/module.html new file mode 100644 index 00000000..036238d4 --- /dev/null +++ b/doc/settings/module.html @@ -0,0 +1,111 @@ + + + + + + + + + + + + + diff --git a/doc/settings/modules.html b/doc/settings/modules.html new file mode 100644 index 00000000..cc31f25c --- /dev/null +++ b/doc/settings/modules.html @@ -0,0 +1,52 @@ + + + + + + + + + + + + + diff --git a/doc/settings/namespace.html b/doc/settings/namespace.html new file mode 100644 index 00000000..5935f9de --- /dev/null +++ b/doc/settings/namespace.html @@ -0,0 +1,128 @@ + + + + + + + + + + + + + diff --git a/doc/settings/namespace/dest.html b/doc/settings/namespace/dest.html new file mode 100644 index 00000000..297a19df --- /dev/null +++ b/doc/settings/namespace/dest.html @@ -0,0 +1,63 @@ + + + + + + + + + + + + + diff --git a/doc/settings/namespace/fromtosystem.html b/doc/settings/namespace/fromtosystem.html new file mode 100644 index 00000000..01956624 --- /dev/null +++ b/doc/settings/namespace/fromtosystem.html @@ -0,0 +1,47 @@ + + + + + + + + + + + + + diff --git a/doc/settings/namespace/rule.html b/doc/settings/namespace/rule.html new file mode 100644 index 00000000..326e7b58 --- /dev/null +++ b/doc/settings/namespace/rule.html @@ -0,0 +1,49 @@ + + + + + + + + + + + + + diff --git a/doc/settings/namespace/src.html b/doc/settings/namespace/src.html new file mode 100644 index 00000000..d87f4d5b --- /dev/null +++ b/doc/settings/namespace/src.html @@ -0,0 +1,49 @@ + + + + + + + + + + + + + diff --git a/doc/settings/namespaces.html b/doc/settings/namespaces.html new file mode 100644 index 00000000..90fdc710 --- /dev/null +++ b/doc/settings/namespaces.html @@ -0,0 +1,59 @@ + + + + + + + + + + + + + diff --git a/doc/settings/outputters.html b/doc/settings/outputters.html new file mode 100644 index 00000000..c4c87def --- /dev/null +++ b/doc/settings/outputters.html @@ -0,0 +1,66 @@ + + + + + + + + + + + + + diff --git a/doc/settings/parsers.html b/doc/settings/parsers.html new file mode 100644 index 00000000..70938140 --- /dev/null +++ b/doc/settings/parsers.html @@ -0,0 +1,54 @@ + + + + + + + + + + + + + diff --git a/doc/settings/properties.html b/doc/settings/properties.html new file mode 100644 index 00000000..f6f5904f --- /dev/null +++ b/doc/settings/properties.html @@ -0,0 +1,52 @@ + + + + + + + + + + + + + diff --git a/doc/settings/property.html b/doc/settings/property.html new file mode 100644 index 00000000..9455e73b --- /dev/null +++ b/doc/settings/property.html @@ -0,0 +1,62 @@ + + + + + + + + + + + + + diff --git a/doc/settings/resolvers.html b/doc/settings/resolvers.html new file mode 100644 index 00000000..f8f32830 --- /dev/null +++ b/doc/settings/resolvers.html @@ -0,0 +1,197 @@ + + + + + + + + + + + + + diff --git a/doc/settings/settings.html b/doc/settings/settings.html new file mode 100644 index 00000000..5bce57fc --- /dev/null +++ b/doc/settings/settings.html @@ -0,0 +1,80 @@ + + + + + + + + + + + + + diff --git a/doc/settings/status.html b/doc/settings/status.html new file mode 100644 index 00000000..30f2ac22 --- /dev/null +++ b/doc/settings/status.html @@ -0,0 +1,49 @@ + + + + + + + + + + + + + diff --git a/doc/settings/statuses.html b/doc/settings/statuses.html new file mode 100644 index 00000000..6f5683cb --- /dev/null +++ b/doc/settings/statuses.html @@ -0,0 +1,73 @@ + + + + + + + + + + + + + diff --git a/doc/settings/triggers.html b/doc/settings/triggers.html new file mode 100644 index 00000000..ff1693dc --- /dev/null +++ b/doc/settings/triggers.html @@ -0,0 +1,311 @@ + + + + + + + + + + + + + diff --git a/doc/settings/typedef.html b/doc/settings/typedef.html new file mode 100644 index 00000000..3e5c94dc --- /dev/null +++ b/doc/settings/typedef.html @@ -0,0 +1,48 @@ + + + + + + + + + + + + + diff --git a/doc/settings/version-matchers.html b/doc/settings/version-matchers.html new file mode 100644 index 00000000..6d060709 --- /dev/null +++ b/doc/settings/version-matchers.html @@ -0,0 +1,52 @@ + + + + + + + + + + + + + diff --git a/doc/terminology.html b/doc/terminology.html index 61279313..85509605 100644 --- a/doc/terminology.html +++ b/doc/terminology.html @@ -117,7 +117,7 @@ Three statuses are defined by default in Ivy: A module configuration is a way to use or construct a module. If the same module has different dependencies based on how it's used, those distinct dependency-sets are called its configurations in Ivy. 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 differents ways to use or build a module are called in ivy configurations. +Moreover, a module may need some other modules and artifacts only at build time, and some others at runtime. All those differents 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 main concepts page.

    Ivy Settings

    diff --git a/doc/toc.json b/doc/toc.json index e18a5c64..7e4386eb 100644 --- a/doc/toc.json +++ b/doc/toc.json @@ -52,7 +52,7 @@ }, { "id":"tutorial/conf", - "title":"Using Ivy Configurations", + "title":"Using Ivy Module Configurations", "children": [ ] @@ -140,68 +140,68 @@ ] }, { - "id":"configuration", + "id":"settings", "title":"Settings Files", "children": [ { - "id":"configuration/property", + "id":"settings/property", "title":"property", "children": [ ] }, { - "id":"configuration/properties", + "id":"settings/properties", "title":"properties", "children": [ ] }, { - "id":"configuration/conf", + "id":"settings/settings", "title":"settings", "children": [ ] }, { - "id":"configuration/include", + "id":"settings/include", "title":"include", "children": [ ] }, { - "id":"configuration/classpath", + "id":"settings/classpath", "title":"classpath", "children": [ ] }, { - "id":"configuration/typedef", + "id":"settings/typedef", "title":"typedef", "children": [ ] }, { - "id":"configuration/lock-strategies", + "id":"settings/lock-strategies", "title":"lock-strategies", "children": [ ] }, { - "id":"configuration/caches", + "id":"settings/caches", "title":"caches", "children": [ { - "id":"configuration/caches/cache", + "id":"settings/caches/cache", "title":"cache", "children": [ { - "id":"configuration/caches/ttl", + "id":"settings/caches/ttl", "title":"ttl", "children": [ @@ -212,44 +212,44 @@ ] }, { - "id":"configuration/latest-strategies", + "id":"settings/latest-strategies", "title":"latest-strategies", "children": [ ] }, { - "id":"configuration/parsers", + "id":"settings/parsers", "title":"parsers", "children": [ ] }, { - "id":"configuration/namespaces", + "id":"settings/namespaces", "title":"namespaces", "children": [ { - "id":"configuration/namespace", + "id":"settings/namespace", "title":"namespace", "children": [ { - "id":"configuration/namespace/rule", + "id":"settings/namespace/rule", "title":"rule", "children": [ { - "id":"configuration/namespace/fromtosystem", + "id":"settings/namespace/fromtosystem", "title":"fromsystem / tosystem", "children": [ { - "id":"configuration/namespace/src", + "id":"settings/namespace/src", "title":"src", "children": [ ] }, { - "id":"configuration/namespace/dest", + "id":"settings/namespace/dest", "title":"dest", "children": [ @@ -264,11 +264,11 @@ ] }, { - "id":"configuration/macrodef", + "id":"settings/macrodef", "title":"macrodef", "children": [ { - "id":"configuration/macrodef/attribute", + "id":"settings/macrodef/attribute", "title":"attribute", "children": [ @@ -277,7 +277,7 @@ ] }, { - "id":"configuration/resolvers", + "id":"settings/resolvers", "title":"resolvers", "children": [ { @@ -353,18 +353,18 @@ ] }, { - "id":"configuration/conflict-managers", + "id":"settings/conflict-managers", "title":"conflict-managers", "children": [ ] }, { - "id":"configuration/modules", + "id":"settings/modules", "title":"modules", "children": [ { - "id":"configuration/module", + "id":"settings/module", "title":"module", "children": [ @@ -373,18 +373,18 @@ ] }, { - "id":"configuration/outputters", + "id":"settings/outputters", "title":"outputters", "children": [ ] }, { - "id":"configuration/statuses", + "id":"settings/statuses", "title":"statuses", "children": [ { - "id":"configuration/status", + "id":"settings/status", "title":"status", "children": [ @@ -393,14 +393,14 @@ ] }, { - "id":"configuration/triggers", + "id":"settings/triggers", "title":"triggers", "children": [ ] }, { - "id":"configuration/version-matchers", + "id":"settings/version-matchers", "title":"version-matchers", "children": [ diff --git a/doc/tutorial.html b/doc/tutorial.html index 61871ef0..d25a2719 100644 --- a/doc/tutorial.html +++ b/doc/tutorial.html @@ -51,9 +51,9 @@ help you configure ivy to find ivy files in one place and artifacts in another. a very first step toward using Ivy in a multi project environment.
  • [[tutorial/multiproject]]
    • a more complex example demonstrating the use of Ant+Ivy in a multi project environment. -
  • Using Ivy Configurations
    • +
  • [[tutorial/conf]]
    • show how to use configurations in ivy file to define set of artifacts. -
  • Building a repository
    • +
  • [[tutorial/build-repository]]
    • show how to build your own enterprise repository. diff --git a/doc/tutorial/build-repository.html b/doc/tutorial/build-repository.html index e3cfc228..21e859d1 100644 --- a/doc/tutorial/build-repository.html +++ b/doc/tutorial/build-repository.html @@ -29,7 +29,7 @@ The [[ant:install]] task let you copy a module or a set of modules from one repo Fortunately the [[ant:install]] task is here to help: you can use specific settings for your repository maintenance build which will be used to maintain your target enterprise repository. These settings will point to another repository (for instance the maven 2 public repository) so that you will just have to ask Ivy to install the modules you want with a simple command line. -To demonstrate this we will first use some basic ivy settings files to show how it works, and then we will use the advanced [[configuration/namespaces]] feature to demonstrate how to deal with naming mismatch between the source and target repository. +To demonstrate this we will first use some basic ivy settings files to show how it works, and then we will use the advanced [[settings/namespaces]] feature to demonstrate how to deal with naming mismatch between the source and target repository.

    The project used

    The project that we will use is pretty simple. diff --git a/doc/tutorial/build-repository/advanced.html b/doc/tutorial/build-repository/advanced.html index 8913a95d..0643beec 100644 --- a/doc/tutorial/build-repository/advanced.html +++ b/doc/tutorial/build-repository/advanced.html @@ -35,7 +35,7 @@ Nevertheless, the result is not always the expected one, especially concerning t This problem is pretty usual when you have an existing repository, and want to benefit from a large public repositories which do not follow the same naming conventions. Or simply because you find the public repository you use as a basis is not consistent enough - why all apache commons module aren't don't use the org.apache.commons organization? For historical reasons. But if you setup your own repository you may not want to suffer from history. -Fortunately Ivy has a very powerful answer to this kind of problem: [[configuration/namespaces namespaces]]. +Fortunately Ivy has a very powerful answer to this kind of problem: [[settings/namespaces namespaces]].

    Using namespaces

    If you look at the repository built with the [[tutorial/build-repository/basic previous tutorial]], you will see exactly what we were talking about: all apache commons module use their own name as organization. diff --git a/doc/tutorial/build-repository/basic.html b/doc/tutorial/build-repository/basic.html index f9adcea9..b3b76cc2 100644 --- a/doc/tutorial/build-repository/basic.html +++ b/doc/tutorial/build-repository/basic.html @@ -28,7 +28,7 @@ In this first step we use the [[ant:install]] task to install modules from the maven 2 repository to a file system based repository. We first install a module with no dependency, then a module with its dependencies.

    Basic: ivysettings.xml file used

    -The ivy settings file that we will use is very simple here. It defines two resolvers, libraries and my-repository. The first one is used as the source, the second one as the destination. In a typical setup the second one would be configured using [[configuration:include included]] settings, used by the development team. +The ivy settings file that we will use is very simple here. It defines two resolvers, libraries and my-repository. The first one is used as the source, the second one as the destination. In a typical setup the second one would be configured using [[settings/include included]] settings, used by the development team. @@ -95,7 +95,7 @@ If you call this target, you will see that Ivy installs not only the hibernate m As you can see the installation has failed, if you look at the log you will see that there are missing artifacts on the source repository. This means that you will need to download those artifacts manually, and copy them to your destination repository to complete the installation. Fortunately Ivy use a best effort algorithm during install, so that you have everything installed but the missing artifacts. -You may also have notice that Ivy has installed 2 different revisions of commons-logging (1.0.2, 1.0.4). This is due to the fact that we use the "no conflict" [[configuration/conflict-managers conflict manager]] in the ivysettings file. +You may also have notice that Ivy has installed 2 different revisions of commons-logging (1.0.2, 1.0.4). This is due to the fact that we use the "no conflict" [[settings/conflict-managers conflict manager]] in the ivysettings file. We do not want to evict any modules because we are building our own repository. Indeed if we get both commons-logging 1.0.2 and 1.0.4 it's because some modules among the transitive dependencies of hibernate depend on 1.0.2 and other on 1.0.4. If we got only 1.0.4, the module depending on 1.0.2 would be inconsistent in your own repository (depending on a version you don't have installed). Thus developers using this module directly would run into a problem. diff --git a/doc/tutorial/conf.html b/doc/tutorial/conf.html index a51dd86c..12de8f53 100644 --- a/doc/tutorial/conf.html +++ b/doc/tutorial/conf.html @@ -25,7 +25,7 @@ diff --git a/doc/tutorial/dependence.html b/doc/tutorial/dependence.html index 68b460dc..ca0047ce 100644 --- a/doc/tutorial/dependence.html +++ b/doc/tutorial/dependence.html @@ -101,7 +101,7 @@ The file contains four main tags: properties, settings, resolvers and modules. This tag only load some properties for the ivy process in the same manner as ant would do it.

    settings

    This tag is in charge of initializing some parameters for ivy process. The directory that ivy will use to cache artifacts will be in a sub directory called ivy-cache of the directory containing the ivysettings.xml file itself. -The second parameter, tells ivy to use a resolver called "libraries" as its default resolver. More information can be found in the [[configuration settings reference documentation]]. +The second parameter, tells ivy to use a resolver called "libraries" as its default resolver. More information can be found in the [[settings settings reference documentation]].

    resolvers

    This tag defines the resolvers to use. Here we have two resolvers defined: "projects" and "libraries". The filesystem resolver called "projects" is able to resolve the internal dependencies by locating them on the local filesystem. diff --git a/doc/use/buildlist.html b/doc/use/buildlist.html index 978eb8dd..6af7e869 100644 --- a/doc/use/buildlist.html +++ b/doc/use/buildlist.html @@ -41,7 +41,7 @@ When the ivy.xml of the modules that you want to order contains a 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. 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 apear before the modules in the loop. This garantee that if there is a depedendency path between a module A and a module B (but no dependency path from B to A), B will alway apear before A even if A is included in a loop in the provided set of modules to sort. -Note that circular dependency can also trigger a failure depending on the value configured in the circularDependencyStrategy of your settings +Note that circular dependency can also trigger a failure depending on the value configured in the circularDependencyStrategy of your settings since 2.0 When you are specifying root or leaf modules you can limit the resulting list to only direct dependencies of the roots modules or to modules that directly depends on your leaf modules. diff --git a/doc/use/configure.html b/doc/use/configure.html index aca955b7..37d875cb 100644 --- a/doc/use/configure.html +++ b/doc/use/configure.html @@ -28,7 +28,7 @@ (since 2.0) the configure task is deprecated. Use the setting declaration
    The configure task is used to configure ivy with an xml settings file.

    -See settings for details about the settings file itself.

    +See [[settings]] for details about the settings file itself.

    Note for developers:
    After the call to this task, a reference to the configured ivy instance used by all subsequent ant tasks is put in the ant project, under the id "ivy.instance".     diff --git a/doc/use/makepom.html b/doc/use/makepom.html index e04c2ad3..b38bc77d 100644 --- a/doc/use/makepom.html +++ b/doc/use/makepom.html @@ -52,7 +52,7 @@ An example of use is to publish an Ivy managed module to a maven 2 repository. mapping - describes the mapping from an Ivy configuration to a POM scope.
    These elements takes two attributes:
    • conf
      • the configuration to map
    • scope
      • the scope to which it should be mapped
    + describes the mapping from an Ivy module configuration to a Maven POM scope.
    These elements takes two attributes:
    • conf
      • the configuration to map
    • scope
      • the scope to which it should be mapped
    0..n diff --git a/doc/use/publish.html b/doc/use/publish.html index 7ee90226..fc076b69 100644 --- a/doc/use/publish.html +++ b/doc/use/publish.html @@ -31,7 +31,7 @@ This task is meant to publish the current module descriptor together with its de 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 settings for details about resolver supporting artifact publishing. +The target repository is given through the name of a resolver declared in current ivy settings. See [[settings]] for details about resolver supporting artifact publishing. It also publishes the delivered ivy file (except if you don't want), and even deliver 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: @@ -58,7 +58,7 @@ The source artifact pattern can be specified either as an attribute on the task updatetrue 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 validatetrue to force ivy files validation against ivy.xsd, false to force no validation - No. Defaults to default ivy value (as configured in [[configuration settings file]]) + No. Defaults to default ivy value (as configured in [[settings settings file]]) replacedynamicrevtrue to replace dynmic revisions by static ones in the delivered file, false to avoid this replacement since 1.3 No. Defaults to true publishivyTrue to publish delivered ivy file, false otherwise diff --git a/doc/use/resolve.html b/doc/use/resolve.html index a36393a3..5dfed51e 100644 --- a/doc/use/resolve.html +++ b/doc/use/resolve.html @@ -96,7 +96,7 @@ Two modes are available:

    Concurrency

    -During resolve, Ivy creates a file in the [[configuration/caches 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 [[settings/caches 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". @@ -115,7 +115,7 @@ After the call to this task, a reference to the module descriptor resolved is pu refreshtrue to force Ivy to resolve dynamic revision in this resolve process, false to use cached resolved revision since 2.0No. defaults to false - resolveModethe resolve mode to use for this dependency resolution process since 2.0No. defaults to using the resolve mode set in the [[configuration settings]] + resolveModethe resolve mode to use for this dependency resolution process since 2.0No. defaults to using the resolve mode set in the [[settings settings]] inlinetrue to use inline mode, false to resolve an ivy file since 1.4No. defaults to false diff --git a/doc/use/settings.html b/doc/use/settings.html index 02a64b9e..a3099f18 100644 --- a/doc/use/settings.html +++ b/doc/use/settings.html @@ -28,7 +28,7 @@ The settings declaration is used to configure ivy with an xml settings file. -See [[configuration Settings Files]] for details about the settings file itself.

    +See [[settings]] for details about the settings file itself.

    Multiple settings can be defined in a build script. Every task can reference its own settings.