Return-Path: Delivered-To: apmail-ant-notifications-archive@locus.apache.org Received: (qmail 55695 invoked from network); 11 Jul 2008 08:04:41 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 11 Jul 2008 08:04:41 -0000 Received: (qmail 69396 invoked by uid 500); 11 Jul 2008 08:04:39 -0000 Delivered-To: apmail-ant-notifications-archive@ant.apache.org Received: (qmail 69374 invoked by uid 500); 11 Jul 2008 08:04:39 -0000 Mailing-List: contact notifications-help@ant.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@ant.apache.org Delivered-To: mailing list notifications@ant.apache.org Received: (qmail 69363 invoked by uid 99); 11 Jul 2008 08:04:39 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 Jul 2008 01:04:39 -0700 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 Jul 2008 08:03:46 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 2ABD72388A7A; Fri, 11 Jul 2008 01:03:39 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r675856 [3/4] - in /ant/ivy/core/trunk/doc: ./ configuration/ configuration/caches/ configuration/macrodef/ configuration/namespace/ ivyfile/ resolver/ settings/ settings/caches/ settings/macrodef/ settings/namespace/ tutorial/ tutorial/bui... Date: Fri, 11 Jul 2008 08:03:28 -0000 To: notifications@ant.apache.org From: xavier@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20080711080339.2ABD72388A7A@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: ant/ivy/core/trunk/doc/settings/caches/cache.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/caches/cache.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/caches/cache.html (added) +++ ant/ivy/core/trunk/doc/settings/caches/cache.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,88 @@ + + + + + + + + + +

+<b>Tag:</b> cache
+
+Defines a repository cache instance based on the default repository cache implementation.
+
+The default repository cache implementation caches files on the local filesystem in subdirectories of a configured base directory.
+
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>name</td><td>name of the cache instance</td>
+        <td>Yes</td></tr>
+    <tr><td>basedir</td><td>the path of the base directory to use to put repository cache data. <strong>This should not point to a directory used as a repository!</strong></td>
+        <td>No, defaults to repositoryCacheDir defined in [[settings/caches]]</td></tr>
+    <tr><td>ivyPattern</td><td>the pattern to use to store cached ivy files</td>
+        <td>No, defaults to default cache ivy pattern as configured in [[settings/caches]]</td></tr>
+    <tr><td>artifactPattern</td><td>the pattern to use to store cached artifacts</td>
+        <td>No, defaults to default cache artifact pattern as configured in [[settings/caches]]</td></tr>
+    <tr><td>useOrigin</td><td>true to avoid the copy of local artifacts to the cache and use directly their original location, false otherwise. 
+To know if an artifact is local ivy asks to the resolver. Only filesystem resolver is considered local by default, but this can be disabled if you want to force the copy on one filesystem resolver and use the original location on another. Note that it is safe to use useOrigin even if you use the cache for some non local resolvers. In this case the cache will behave as usual, copying files to the cache. Note also that this only applies to artifacts, not to ivy files, which are still copied in the cache.</td>
+        <td>No. defaults to the default value configured in [[settings/caches]]</td></tr>
+    <tr><td>lockStrategy</td><td>the name of the [[settings/lock-strategies lock strategy]] to use for this cache</td>
+        <td>No, defaults to default lock strategy as configured in [[settings/caches]]</td></tr>
+    <tr><td>defaultTTL</td><td>the default [[settings/caches/ttl TTL]] to use when no specific one is defined</td>
+        <td>No, defaults to ${ivy.cache.ttl.default}</td></tr>
+</tbody>
+</table>
+
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>[[settings/caches/ttl]]</td><td>defines a TTL rule</td>
+        <td>0..n</td></tr>
+</tbody>
+</table>
+
+<h1>Examples</h1>
+<code>
+<cache name="mycache" 
+       basedir="/path/to/mycache"
+       ivyPattern="[module]/ivy-[revision].xml" 
+       artifactPattern="[module]/[artifact]-[revision].[ext]"
+       lockStrategy="no-lock"
+       defaultTTL="1s">
+    <ttl revision="latest.integration" duration="200ms" />
+    <ttl organisation="org1" duration="10m 20s" />
+    <ttl organisation="org2" duration="5h" />
+    <ttl organisation="org3" duration="2d 12h" />
+</cache>
+</code>
+Defines a cache called 'mycache', storing files in the '/path/to/mycache' directory using '[module]/ivy-[revision].xml' as pattern to store Ivy files and '[module]/[artifact]-[revision].[ext]' as pattern to store other artifacts.
+The lock strategy used by this cache is the 'no-lock' strategy, which does not perform any locking. 
+The defaultTTL used is of 1s, meaning that by default dynamic revision result will be stored and used for one second. TTL rules then define that all 'latest.integration' revisions will be stored and used for 200ms, while other dynamic revisions from org1 org2 and org3 modules will be stored respectively for 10 minutes 20 seconds; 5 hours; and 2 days and 12 hours.

+ + + Propchange: ant/ivy/core/trunk/doc/settings/caches/cache.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/caches/cache.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/caches/ttl.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/caches/ttl.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/caches/ttl.html (added) +++ ant/ivy/core/trunk/doc/settings/caches/ttl.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,70 @@ + + + + + + + + + +

+<b>Tag:</b> ttl
+
+<span class="since">Since 2.0</span> Defines a TTL (Time To Live) rule for resolved revision caching.
+
+When Ivy resolves a dynamic version constraint (like latest.integration or a version range), it can store the result of the resolution (like latest.integration=1.5.1) for a given time, called TTL. It means that Ivy will reuse this dynamic revision resolution result without accessing the repositories for the duration of the TTL, unless running [[ant:resolve]] in refresh mode.
+
+This tag let you define a rule to define a TTL specific to a set of dynamic revision, based on the whole module revision information (organization, module name, revision, ...). The revision considered in the rule is the revision before the resolution (for instance 'latest.integration') and not the resolved revision (for instance '1.5.1').
+
+The rules are evaluated in order, the first matching rule being used to define the TTL. If no rule matches, the cache defaultTTL will be used.
+
+The format used to specify the TTL is of the form:
+<code>
+XXd XXh XXm XXs XXXms
+</code>
+Where 'd' stands for days, 'h' for hours, 'm' for minutes, 's' for seconds and 'ms' for milliseconds. Any part of the specification can be omitted, so '12d', '2h 5m' and '1d 5ms' are all valid.
+
+Using a 0ms TTL disable resolved revision caching for the given rule.
+
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>organisation</td><td>the organisation to match to apply the rule.</td>
+        <td>No, defaults to *</td></tr>
+    <tr><td>module</td><td>the module's name to match to apply the rule.</td>
+        <td>No, defaults to *</td></tr>
+    <tr><td>revision</td><td>the module's revision to match to apply the rule. Note that the version is not resolved when evaluating the rule ('latest.integration' for instance).</td>
+        <td>No, defaults to *</td></tr>
+    <tr><td><em>any extra attribute</em></td><td>an extra attribute to match to apply the rule.</td>
+        <td>No, defaults to *</td></tr>
+    <tr><td>matcher</td><td>the <a href="../../concept.html#matcher">matcher</a> to use to match the modules to which the resolver should be applied</td>
+        <td>No, defaults to exact</td></tr>
+    <tr><td>duration</td><td>the TTL to apply</td>
+        <td>Yes</td></tr>
+</tbody>
+</table>
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/caches/ttl.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/caches/ttl.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/classpath.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/classpath.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/classpath.html (added) +++ ant/ivy/core/trunk/doc/settings/classpath.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,72 @@ + + + + + + + + + +

+<b>Tag:</b> classpath
+
+Includes a jar in the classpath used to load plugins. <span class="since">since 1.4</span>
+
+This let you add ivy plugins without relying on ant classpath for instance, easing therefore the use of ivy in multiple execution environment (ant, standalone, IDE plugins, ...).
+
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>url</td><td>the url of a jar to add to the classpath</td>
+        <td>Yes, unless file is specified</td></tr>
+    <tr><td>file</td><td>a jar to add to the classpath</td>
+        <td>Yes, unless url is specified</td></tr>
+</tbody>
+</table>
+<h1>Examples</h1>
+<code type="xml">
+<ivysettings>
+  <classpath file="${ivy.settings.dir}/custom-resolver.jar"/>
+  <typedef name="custom" classname="org.apache.ivy.resolver.CustomResolver"/>
+  <resolvers>
+    <custom name="custom"/>
+  </resolvers>
+</ivysettings>
+</code>
+Adds custom-resolver.jar found in the same directory as the ivysettings.xml file itself to the classpath, then define a custom resolver and use it.
+
+<hr/>
+<code type="xml">
+<ivysettings>
+  <classpath url="http://www.myserver.com/ivy/custom-resolver.jar"/>
+  <typedef name="custom" classname="org.apache.ivy.resolver.CustomResolver"/>
+  <resolvers>
+    <custom name="custom"/>
+  </resolvers>
+</ivysettings>
+</code>
+Same as above, but find the jar on a web server.
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/classpath.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/classpath.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/conflict-managers.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/conflict-managers.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/conflict-managers.html (added) +++ ant/ivy/core/trunk/doc/settings/conflict-managers.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,68 @@ + + + + + + + + + +

+<b>Tag:</b> conflict-managers
+
+Defines a list of <a href="../concept.html#conflict">conflicts managers</a> usable in ivy. Each conflict manager is identified by its name, given as an attribute.
+The child tag used for the conflict manager must be equal to a name of a conflict manager type (either built-in
+or added with the typedef tag).
+
+Here is a list of predefined conflicts managers (which do not require anything in the configuration file):
+<ul>
+<li>all</li> this conflicts manager resolve conflicts by selecting all revisions. Also called NoConflictManager, it does evict any module.
+<li>latest-time</li> this conflict manager selects only the 'latest' revision, latest being defined as the latest in time. Note that latest in time is costly to compute, so prefer latest-revision if you can.
+<li>latest-revision</li> this conflict manager selects only the 'latest' revision, latest being defined by a string comparison of revisions.
+<li>latest-compatible</li> this conflict manager selects the latest version in the conflicts which can result in a compatible set of dependencies. This means that in the end this conflict manager does not allow any conflict (like the strict conflict manager), except that it follows a best effort strategy to try to find a set of compatible modules (according to the version constraints)
+<li>strict</li> this conflict manager throws an exception (i.e. causes a build failure) whenever a conflict is found.
+</ul>
+The two "latest" conflict managers also take into account the force attribute of the dependencies.
+Indeed direct dependencies can declare a force attribute (see <a href="../ivyfile/dependency.html">dependency</a>), which indicates the the revision given in the direct dependency should be prefered over indirect dependencies.
+
+Here is a list of conflict manager types available, which can be used to define your own custom conflict managers:
+<ul>
+<li>latest-cm</li>The latest conflict manager uses a latest strategy to select the latest revision among several ones. Both latest-time and latest-revision conflict managers are based on this conflict manager type. It takes 'latest' as attribute to define which latest strategy should be used. Example:
+<code><latest-cm name="mylatest-conflict-manager" latest="my-latest-strategy"/></code>
+<li>compatible-cm</li>The latest compatible conflict manager uses a latest strategy to select the latest revision among several ones. It takes 'latest' as attribute to define which latest strategy should be used. Example:
+<code><compatible-cm name="my-latest-compatible-conflict-manager" latest="my-latest-strategy"/></code>
+<li>regexp-cm</li>This conflict manager is based on a regular expression and throw an exception (i.e. causes a build failure) when a conflict is found with versions with different matching group. For instance if a conflict is found between 1.2.x and 1.3.y it will throw an exception if the regular exception is (.*)\.\d, because the matching group will match different string (1.2 and 1.3). 1.2.1 and 1.2.2 won't throw an exception with the same regular expression. The regular expression is set using the 'regexp' attribute. A 'ignoreNonMatching' attribute can also be set to simply warrn when a version is found which does not match the regular expression, instead of throwing an exception.
+</ul>
+
+<h3>Child elements</h3>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>any conflict manager</td><td>adds a conflict manager to the list of available conflict managers</td>
+        <td>0..n</td></tr>
+</tbody>
+</table>
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/conflict-managers.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/conflict-managers.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/include.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/include.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/include.html (added) +++ ant/ivy/core/trunk/doc/settings/include.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,77 @@ + + + + + + + + + +

+<b>Tag:</b> include
+
+Includes another ivysettings file as if it were part of this one. <span class="since">since 1.3</span>
+
+The included ivysettings file has to be a complete well formed ivysettings file, i.e. it does have to include the <code><ivysettings></code> tag.
+
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>file</td><td>a path to the ivysettings file to include</td>
+        <td>Yes</td></tr>
+</tbody>
+</table>
+<h1>Examples</h1>
+<code type="xml">
+<ivysettings>
+  <property name="myrepository" value="path/to/my/real/rep"/>
+  <settings defaultResolver="default"/>
+  <include file="path/to/ivysettings-default.xml"/>
+</ivysettings>
+</code>
+with ivysettings-default.xml:
+<code type="xml">
+<ivysettings>
+  <property name="myrepository" value="path/to/rep" overwrite="false"/>
+  <resolvers>
+    <ivyrep name="default" ivyroot="${myrepository}"/>
+  </resolvers>
+</ivysettings>
+</code>
+
+The included ivysettings defines a resolver named default, which is an ivyrep resolver, with its root configured as being the value of myrepository variable. This variable is given the value path/to/rep in the included file, but because the attribute overwrite is set to false, it will not override the value given in the main ivysettings including this one, so the value used for myrepository will be path/to/my/real/rep.
+<hr/>
+<code type="xml">
+<ivysettings>
+  <include file="ivysettings-macro.xml"/>
+  <resolvers>
+    <mymacro name="includeworks" mymainrep="included/myrep" mysecondrep="included/secondrep"/>
+  </resolvers>
+</ivysettings> 
+</code>
+with ivysettings-macro.xml being the ivysettings example given on the [[settings/macrodef macrodef documentation page]].
+This let reusing macro resolver easy.
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/include.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/include.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/latest-strategies.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/latest-strategies.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/latest-strategies.html (added) +++ ant/ivy/core/trunk/doc/settings/latest-strategies.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,91 @@ + + + + + + + + + +

+<b>Tag:</b> latest-strategies
+
+Defines a list of <a href="../concept.html#latest">latest strategies</a> usable in ivy. Each latest strategy is identified by its name, given as an attribute.
+The child tag used for the latest strategy must be equal to a name of a latest strategy type (usually added with the typedef tag).
+
+The latest strategies which are always included in ivy (and do not require anything in the configuration file) are:
+<ul>
+<li>latest-time</li> compares the revisions date to know which is the latest. While this is often a good 
+strategy in terms of pertinence, it has the drawback to be costful to compute with distant repositories. If you use ivyrep, 
+for example, ivy has to ask the http server what is the date of each ivy file before knowing which is the latest.
+<li>latest-revision</li> compares the revisions as string, using an algorithm close to the one used in the php version_compare function.
+This algorithm takes into account special meaning of some text. For instance, with this strategy, 1.0-dev1 is considered
+before 1.0-alpha1, which in turn is before 1.0-rc1, which is before 1.0, which is before 1.0.1.
+<li>latest-lexico</li> compares the revisions as string, using lexicographic order (the one used by java string comparison).
+</ul>
+
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>any latest strategy</td><td>adds a latest strategy to the list of available strategies</td>
+        <td>0..n</td></tr>
+</tbody>
+</table>
+
+<h1>latest-revision</h1>
+<span class="since">since 1.4</span> The latest-revision can now be configured to handle more words with special meanings than the one defined in php version_compare function.
+
+Here is an example of how you can do so:
+<code type="xml">
+<latest-strategies>
+  <latest-revision name="mylatest-revision">
+    <specialMeaning name="PRE" value="-2"/>
+    <specialMeaning name="QA" value="4"/>
+    <specialMeaning name="PROD" value="5"/>
+  </latest-revision>
+</latest-strategies> 
+</code>
+Knowing that the default special meaning words are the following:
+<code type="xml">
+    <specialMeaning name="dev" value="-1"/>
+    <specialMeaning name="rc" value="1"/>
+    <specialMeaning name="final" value="2"/>
+</code>
+You can even get rid or redefine the default special meanings by setting usedefaultspecialmeanings="false" on the latest-revision tag.
+Example:
+<code type="xml">
+<latest-strategies>
+  <latest-revision name="mylatest-revision" usedefaultspecialmeanings="false">
+    <specialMeaning name="pre" value="-2"/>
+    <specialMeaning name="m" value="1"/>
+    <specialMeaning name="rc" value="2"/>
+    <specialMeaning name="prod" value="3"/>
+  </latest-revision>
+</latest-strategies> 
+</code>
+
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/latest-strategies.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/latest-strategies.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/lock-strategies.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/lock-strategies.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/lock-strategies.html (added) +++ ant/ivy/core/trunk/doc/settings/lock-strategies.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,62 @@ + + + + + + + + + +

+<b>Tag:</b> lock-strategies <span class="since">since 2.0</span>
+
+Defines a list of lock strategies usable in Ivy. 
+
+A lock strategy is used by a cache manager to decide when and how locking should be performed (see [[settings/cache]] to see how to configure the lock strategy to use).
+
+Two lock strategies are registered by default:
+<ul>
+<li><b>no-lock</b></li> This lock strategy actually performs no locking at all, and thus should not be used in environment where the cache is shared by multiple processes. 
+
+This strategy is implemented by ([[svn:src/java/org/apache/ivy/plugins/lock/NoLockStrategy.java NoLockStrategy]])
+
+
+<li><b>artifact-lock</b></li> This strategy acquire a lock whenever a module descriptor or an artifact is downloaded to the cache, which makes a good solution when you want to share your repository cache.
+
+Note that this strategy is based on file locking, performed by default using the java.io.File.createNewFile() atomicity (which is documented as atomic in the javadoc, but not recommended to perform locks). A java.nio.FileLock based implementation is also provided, but according to our tests the createNewFile based one performs better and more reliably. We heavily recommend making your own testing in your target environment before relying on this lock strategy for heavily concurrent operations.
+
+This strategy is implemented by ([[svn:src/java/org/apache/ivy/plugins/lock/ArtifactLockStrategy.java ArtifactLockStrategy]])
+</ul>
+
+The child tag used for the lock strategy must be equal to a name of a lock strategy type (added with the typedef tag).
+
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>any lock strategy</td><td>adds a lock strategy to the list of available ones</td>
+        <td>0..n</td></tr>
+</tbody>
+</table>

+ + + Propchange: ant/ivy/core/trunk/doc/settings/lock-strategies.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/lock-strategies.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/macrodef.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/macrodef.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/macrodef.html (added) +++ ant/ivy/core/trunk/doc/settings/macrodef.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,152 @@ + + + + + + + + + +

+<b>Tag:</b> macrodef
+
+Defines a new dependency resolver type based upon an other one. This definition is very similar to the macrodef feature of ant for defining macro tasks. <span class="since">since 1.3</span>
+
+This task eases the lot the process of creating new dependency resolver, because it avoid writing java code.
+
+It is generally used in combination with the [[settings/include]] feature to help reusing macro at several places.
+
+A macro is defined by writing the resolver it is equivalent to as if it were written in the resolver place, except that you can use attributes to pass parameters to the newly defined resolver type. Attributes are defined with a name and sometimes a default value, and are used using the following syntax: 
+<code>@{attributename}</code>
+<h2>Resolvers names</h2>
+Since you can use the same macro several times, and that your macro may define several resolvers (in a chain for instance), resolvers names need to be chosen carefully to avoid name conflicts (a resolver must have a unique name).
+
+Therefore here is how Ivy deals with the names of the resolvers defined in a macro:
+<ul>
+<li>if there is no name attribute on a resolver in the macrodef, then Ivy will use the name given when using the macro. This is what usually should be done for the main resolver defined in the macro</li>
+<li>if there is a name attribute on a resolver in the macrodef, but this name doesn't contain a @{name} inside, then Ivy will use the provided name prefixed with the name of the macro separated by a dash</li>
+<li>if there is a name attribute on a resolver in the macrodef, and this name contains @{name} somewhere, then Ivy will use this name, and replace @{name} with the name provided when using the macro.
+</ul>
+
+Example:
+<code type="xml">
+<ivysettings>
+  <macrodef name="mymacro">
+    <chain>
+      <ibiblio name="ex1" />
+      <ibiblio name="ex2.@{name}" m2compatible="true" />
+    </chain>
+  </macrodef>
+	
+  <resolvers>
+    <mymacro name="default" />
+    <mymacro name="other" />
+   </resolvers>
+</ivysettings>
+</code>
+This is equivalent to:
+<code type="xml">
+<ivysettings>
+  <resolvers>
+    <chain name="default">
+      <ibiblio name="default-ex1" />
+      <ibiblio name="ex2.default" m2compatible="true" />
+    </chain>
+    <chain name="other">
+      <ibiblio name="other-ex1" />
+      <ibiblio name="ex2.other" m2compatible="true" />
+    </chain>
+   </resolvers>
+</ivysettings>
+</code>
+
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>name</td><td>name of the resover type created</td>
+        <td>Yes</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>[[settings/macrodef/attribute]]</td><td>defines an attribute for the macro resolver</td>
+        <td>0..n</td></tr>
+    <tr><td>any resolver</td><td>defines the base resolver upon which this macro is defined</td>
+        <td>1</td></tr>
+</tbody>
+</table>
+<h1>Examples</h1>
+Defining a simple macro:
+<code type="xml">
+  <macrodef name="mymacro">
+    <attribute name="mymainrep"/>
+      <filesystem name="fs1">
+        <ivy pattern="@{mymainrep}/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/>
+        <artifact pattern="@{mymainrep}/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/>
+      </filesystem>
+  </macrodef>
+</code>
+Using it:
+<code type="xml">
+  <resolvers>
+    <mymacro name="default" mymainrep="path/to/myrep"/>
+  </resolvers>
+</code>
+<hr/>
+A complete example:
+<code type="xml">
+<ivysettings>
+  <macrodef name="mymacro">
+    <attribute name="mymainrep"/>
+    <attribute name="mysecondrep"/>
+    <attribute name="myseconddirlayout" default="[organisation]/[module]/[type]s"/>
+    <chain>
+      <filesystem name="fs1">
+        <ivy pattern="@{mymainrep}/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/>
+        <artifact pattern="@{mymainrep}/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/>
+      </filesystem>
+      <filesystem name="fs2" latest="latest-time">
+        <ivy pattern="@{mysecondrep}/@{myseconddirlayout}/ivy-[revision].xml"/>
+        <artifact pattern="@{mysecondrep}/@{myseconddirlayout}/[artifact]-[revision].[ext]"/>
+      </filesystem>
+    </chain>
+  </macrodef>
+	
+  <resolvers>
+    <mymacro name="default" mymainrep="path/to/myrep" mysecondrep="path/to/secondrep"/>
+    <mymacro name="other" 
+       mymainrep="path/to/myrep" 
+       mysecondrep="path/to/secondrep" 
+       myseconddirlayout="[module]/[type]s"/>
+   </resolvers>
+</ivysettings>
+</code>
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/macrodef.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/macrodef.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/macrodef/attribute.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/macrodef/attribute.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/macrodef/attribute.html (added) +++ ant/ivy/core/trunk/doc/settings/macrodef/attribute.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,48 @@ + + + + + + + + + + + + + Propchange: ant/ivy/core/trunk/doc/settings/macrodef/attribute.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/macrodef/attribute.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/module.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/module.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/module.html (added) +++ ant/ivy/core/trunk/doc/settings/module.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,111 @@ + + + + + + + + + +

+<b>Tag:</b> module
+
+Define a module set rule. The tag defines a module set, by giving an expression and the matcher to use for organisation, name, revision and any extra attribute identifying your modules. The rule matching is performed in order, and is using a pattern matcher. Hence you can use * to specify all, or simply avoid specifying the attribute. 
+
+The revision and extra attributes are only used for rules defining the resolver to use. For other settings, use only organisation and module name.
+
+It also gives the specific setting to use for this module set.
+
+For each module set, you can configure:
+<ul>
+<li>the [[settings/resolvers resolver]] to use</li>
+<li>the [[settings/conflict-managers conflict manager]] to use</li>
+<li>the default <a href="../terminology.html#branch">branch</a> to use</li>
+<li>the [[ant:resolve resolve mode]] to use</li>
+</ul>
+
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>organisation</td><td>the organisation to match to apply the rule.</td>
+        <td>No, defaults to *</td></tr>
+    <tr><td>name</td><td>the module's name to match to apply the rule.</td>
+        <td>No, defaults to *</td></tr>
+    <tr><td>revision</td><td>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. <span class="since">since 2.0</span></td>
+        <td>No, defaults to *</td></tr>
+    <tr><td><em>any extra attribute</em></td><td>an extra attribute to match to apply the rule. <span class="since">since 2.0</span></td>
+        <td>No, defaults to *</td></tr>
+    <tr><td>matcher</td><td>the <a href="../concept.html#matcher">matcher</a> to use to match the modules to which the resolver should be applied <span class="since">since 1.3</span></td>
+        <td>No, defaults to exactOrRegexp</td></tr>
+    <tr><td>resolver</td><td>the name of the resolver to apply. The resolver must have been defined in the resolvers section of the configuration file.</td>
+        <td>No</td></tr>
+    <tr><td>conflict-manager</td><td>the name of the conflict manager to apply. <span class="since">since 1.4</span></td>
+        <td>No</td></tr>
+    <tr><td>branch</td><td>the default branch to apply. <span class="since">since 1.4</span></td>
+        <td>No</td></tr>
+    <tr><td>resolveMode</td><td>the resolve mode to use. <span class="since">since 2.0</span></td>
+        <td>No</td></tr>
+</tbody>
+</table>
+<h1>Examples</h1>
+<code type="xml">
+<modules>
+  <module organisation="apache" name="*" resolver="myprojectsresolver"/>
+</modules>
+</code>
+Uses myprojectresolver for all modules from Apache.
+<hr/>
+<code type="xml">
+<modules>
+  <module organisation="apache" name="commons-*" matcher="glob" resolver="myapachecommonsresolver"/>
+</modules>
+</code>
+Uses myapachecommonsresolver for all modules beginning by commons- from apache.
+<hr/>
+<code type="xml">
+<modules>
+  <module organisation="apache" name="commons-[a-z]+" myextra="val.*" matcher="regexp" resolver="myapachecommonsresolver"/>
+</modules>
+</code>
+Uses myapachecommonsresolver for all modules from 'apache' beginning by 'commons-' followed by any number of alphabetic lowercase characters, and with the extra attribute 'myextra' having a value starting with 'val'.
+<hr/>
+<code type="xml">
+<modules>
+  <module organisation="apache" name="ivy*" matcher="glob" conflict-manager="latest-time"/> 
+</modules>
+</code>
+Uses latest-time conflict manager for all modules from apache which name begins with ivy.
+<hr/>
+<code type="xml">
+<modules>
+  <module organisation="apache" name="ivy*" matcher="glob" branch="fix-103"/> 
+</modules>
+</code>
+Uses 'fix-103' as default branch for all modules from apache which name begins with ivy.
+
+
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/module.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/module.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/modules.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/modules.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/modules.html (added) +++ ant/ivy/core/trunk/doc/settings/modules.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,52 @@ + + + + + + + + + +

+<b>Tag:</b> modules
+
+Defines per module or module set settings.
+
+The rules are given by defining a module set, using pattern for module organisation and name, and giving some settings for the set, like the name of the corresponding resolver to use.
+
+If no rule match a given module, the default setting will be used.
+
+Even if not required, because the use of a default big resolver (chain, for instance) able to resolve all dependencies can answer all the needs, the configuration of smaller resolvers used for different cases can improve performances a lot. For instance, if you have a local repository for your modules and a distant repository for third party libraries, it is a good idea to have two separate resolvers, and configure ivy to use one for all your modules and another for the rest (the default one).
+
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>[[settings/module]]</td><td>defines a module set rule</td>
+        <td>1..n</td></tr>
+</tbody>
+</table>
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/modules.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/modules.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/namespace.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/namespace.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/namespace.html (added) +++ ant/ivy/core/trunk/doc/settings/namespace.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,128 @@ + + + + + + + + + +

+<b>Tag:</b> namespace
+
+Defines a new namespace. A namespace is identified by a name, which is used to reference the namespace in the resolvers using the namespace.
+
+Namespaces overview is given in the [[settings/namespaces]] documentation.
+
+A namespace mainly consists of a list of rules, each rule defining a translation between system namespace and the defined namespace, and vice versa.
+
+There are two main possibilities for using these rules. By default, a namespace iterate through the rules, and when it finds one that translate the given name, it returns the translated name. But the namespace can be configured to do use the list as a translator chain: in this case, all rules are applied in order, the result of the first rule translation being passed to the second, and so on.
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>name</td><td>the namespace name</td>
+        <td>Yes</td></tr>
+    <tr><td>chainrules</td><td>true to indicate that namespaces rules should be chained, false otherwise</td>
+        <td>No, defaults to false</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>[[settings/namespace/rule]]</td><td>defines a new namespace rule</td>
+        <td>0..n</td></tr>
+</tbody>
+</table>
+<h1>Example</h1>
+<code type="xml">
+<namespace name="test">
+  <rule>
+    <fromsystem>
+      <src org="systemorg"/>
+      <dest org="A"/>
+    </fromsystem>
+    <tosystem>
+      <src org="A"/>
+      <dest org="systemorg"/>
+    </tosystem>
+  </rule>
+</namespace>
+</code>
+
+<code type="xml">
+<namespace name="test">
+  <rule>
+    <fromsystem>
+      <src org="systemorg2" module="system\-(.+)"/>
+      <dest org="B" module="$m1"/>
+    </fromsystem>
+    <tosystem>
+      <src org="B" module=".+"/>
+      <dest org="systemorg2" module="system-$m0"/>
+    </tosystem>
+  </rule>
+</namespace>
+</code>
+
+<code type="xml">
+<namespace name="test" chainrules="true">
+  <rule>
+    <fromsystem>
+      <src org="systemorg"/>
+      <dest org="A"/>
+    </fromsystem>
+    <tosystem>
+      <src org="A"/>
+      <dest org="systemorg"/>
+    </tosystem>
+  </rule>
+  <rule>
+    <fromsystem>
+      <src module="systemmod"/>
+      <dest module="A"/>
+    </fromsystem>
+    <tosystem>
+      <src module="A"/>
+      <dest module="systemmod"/>
+    </tosystem>
+  </rule>
+  <rule>
+    <fromsystem>
+      <src module="systemmod2"/>
+      <dest module="B"/>
+    </fromsystem>
+    <tosystem>
+      <src module="B"/>
+      <dest module="systemmod2"/>
+    </tosystem>
+  </rule>
+</namespace>
+</code>
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/namespace.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/namespace.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/namespace/dest.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/namespace/dest.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/namespace/dest.html (added) +++ ant/ivy/core/trunk/doc/settings/namespace/dest.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,63 @@ + + + + + + + + + +

+<b>Tag:</b> dest
+
+Defines the translation part of a translation rule. If a name has matched a corresponding src, it will be translated using this dest part.
+
+The new names can contain references to groups of the matched name, using a slightly modified regexp syntax. Indeed, referenced groups can be part of either the organisation, module or revision part of the original name. So, to reference the groups, you just have to add a letter identifying the part in which the group should be selected: o for organisation, m for module, and r for revision.
+
+For instance, $o0 matches the whole matched organisation, and $m0 the whole matched module name. $o1 matches the first group of the matched organisation.
+
+For details about regexp and groups, see the <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html">Pattern class documentation</a> in the jdk.
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>org</td><td>the new organisation name</td>
+        <td>No, defaults to $o0</td></tr>
+    <tr><td>module</td><td>the new module name</td>
+        <td>No, defaults to $m0</td></tr>
+    <tr><td>rev</td><td>the new revision</td>
+        <td>No, defaults to $r0</td></tr>
+</tbody>
+</table>
+<h1>Examples</h1>
+<code type="xml">
+    <fromsystem>
+      <src org="systemorg2" module="system\-(.+)"/>
+      <dest org="B" module="$m1"/>
+    </fromsystem>
+</code>
+Matches modules from systemorg2 which have a name beginning with system followed by a minus and anything else, and translate it to organisation B and module the part following <code>system-</code> of the original name.
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/namespace/dest.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/namespace/dest.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/namespace/fromtosystem.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/namespace/fromtosystem.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/namespace/fromtosystem.html (added) +++ ant/ivy/core/trunk/doc/settings/namespace/fromtosystem.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,47 @@ + + + + + + + + + + + + + Propchange: ant/ivy/core/trunk/doc/settings/namespace/fromtosystem.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/namespace/fromtosystem.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/namespace/rule.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/namespace/rule.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/namespace/rule.html (added) +++ ant/ivy/core/trunk/doc/settings/namespace/rule.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,49 @@ + + + + + + + + + + + + + Propchange: ant/ivy/core/trunk/doc/settings/namespace/rule.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/namespace/rule.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/namespace/src.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/namespace/src.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/namespace/src.html (added) +++ ant/ivy/core/trunk/doc/settings/namespace/src.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,49 @@ + + + + + + + + + + + + + Propchange: ant/ivy/core/trunk/doc/settings/namespace/src.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/namespace/src.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/namespaces.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/namespaces.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/namespaces.html (added) +++ ant/ivy/core/trunk/doc/settings/namespaces.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,59 @@ + + + + + + + + + +

+<b>Tag:</b> namespaces
+
+Namespaces are an advanced feature of Ivy which let you use resolvers in which module names and organisations are not consistent between each other.
+
+For instance, if you want to use maven2 repository and ivyrep collectively, you will face some naming issues. For example all apache commons projects are declared to be part of the organisation apache in ivyrep whereas in maven2 ibiblio repository, they are declared to be part of the organisation of the same name of the module.
+
+So if you try to use both maven2 and ivyrep repositories, you will face some issues like:
+<quote>
+How do I declare a dependency on commons-lang ?
+I have an error while trying to resolve module xxx. It says that it depends on [commons-httpclient commons-httpclient] ant that it isn't available.
+...
+</quote>
+
+Ivy has an answer to give to this kind of troubles, and this answer is called namespaces. In short, you can affect a namespace to each dependency resolver in Ivy, and each namespace defines rules to convert names from the system namespace to the defined namespace itself, and vice versa.
+
+This very powerful feature is thoroughly used in the <a href="../tutorial/build-repository/advanced1.html">build your own repository tutorial</a>, and this is a good place to have examples of what can be done with namespaces.
+
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>[[settings/namespace]]</td><td>defines a new namespace</td>
+        <td>0..n</td></tr>
+</tbody>
+</table>
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/namespaces.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/namespaces.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/outputters.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/outputters.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/outputters.html (added) +++ ant/ivy/core/trunk/doc/settings/outputters.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,66 @@ + + + + + + + + + +

+<b>Tag:</b> outputters
+
+Defines a list of report outputters usable in ivy. 
+
+A report outputter is used at the end of the resolve process to generate a report of how the resolve has been performed.
+
+Two report outputters are registered by default:
+<ul>
+<li>a log report outputter ([[svn:src/java/org/apache/ivy/plugins/report/LogReportOutputter.java LogReportOutputter]])</li>which produces the output on the console at the end of the resolve, which looks like this:
+<code>
+        ---------------------------------------------------------------------
+        |                  |            modules            ||   artifacts   |
+        |       conf       | number| search|dwnlded|evicted|| number|dwnlded|
+        ---------------------------------------------------------------------
+        |      default     |   1   |   1   |   0   |   0   ||   1   |   1   |
+        ---------------------------------------------------------------------
+</code>
+<li>an xml report outputter ([[svn:src/java/org/apache/ivy/plugins/report/XmlReportOutputter.java XmlReportOutputter]])</li>which produces an xml report in the cache, which is mandatory for correct Ivy behaviour, since it's that report which is used when you do a post resolve step in a separate buid from the resolve itself. It's also this xml report which is processed to generate all the different reports available in the [[ant:report]] task.
+</ul>
+
+The child tag used for the parser must be equal to a name of a report outputter type (added with the typedef tag).
+
+To see how to define your own report outputter see <a href="../extend.html">Extending Ivy documentation</a>
+
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>any report outputter</td><td>adds a report outputter to the list of available ones</td>
+        <td>0..n</td></tr>
+</tbody>
+</table>
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/outputters.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/outputters.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/parsers.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/parsers.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/parsers.html (added) +++ ant/ivy/core/trunk/doc/settings/parsers.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,54 @@ + + + + + + + + + +

+<b>Tag:</b> parsers
+
+Defines a list of module descriptor parsers usable in ivy. Each parser defines which resources (which descriptor file) it accepts.
+The child tag used for the parser must be equal to a name of a parser type (added with the typedef tag).
+
+Note that when looking for a parser, ivy queries the parsers list in the reverse order. So the last parser in the list will be queried first. Consequently, if the last parser accepts all resources, the other parsers will never have a chance to parse the resource.
+
+Two parsers are available by default and thus do not need to be declared in this section:
+<ul>
+<li>ivy file parser</li> this is the parser used for ivy xml files. This parser is used for resources that aren't accepted by any other parser.
+<li>pom parser</li>this parser is able to parse maven2 pom files
+</ul>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+    <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+    <tr><td>any module descriptor parser</td><td>adds a module descriptor parser to the list of available parsers</td>
+        <td>0..n</td></tr>
+</tbody>
+</table>
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/parsers.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/parsers.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/properties.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/properties.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/properties.html (added) +++ ant/ivy/core/trunk/doc/settings/properties.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,52 @@ + + + + + + + + + +

+<b>Tag:</b> properties<br/>
+<br/>
+Loads a properties file into ivy variables. See variables chapter above for details about ivy variables.
+
+<span class="since">Since 2.0</span>: 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.
+
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>file</td><td>a path to a properties file to load</td>
+        <td rowspan="2">One of these</td></tr>
+    <tr><td>environment</td><td>the prefix to use when retrieving environment variables <span class="since">(since 2.0)</span></td>
+    <tr><td>override</td><td>indicates if the variable found in the properties file should override their previous value, if any <span class="since">(since 1.3)</span></td>
+        <td>No, defaults to true</td></tr>
+</tbody>
+</table>
+
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/properties.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/properties.html ------------------------------------------------------------------------------ svn:mime-type = text/plain Added: ant/ivy/core/trunk/doc/settings/property.html URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/settings/property.html?rev=675856&view=auto ============================================================================== --- ant/ivy/core/trunk/doc/settings/property.html (added) +++ ant/ivy/core/trunk/doc/settings/property.html Fri Jul 11 01:03:23 2008 @@ -0,0 +1,62 @@ + + + + + + + + + +

+<b>Tag:</b> property
+
+Defines an ivy variable. <span class="since">since 1.3</span>
+
+The optional override attribute enables to avoid overriding the previous value of the varable, which makes the definition behave like ant properties, which is particularly useful to define default values (values which are used only if they haven't been defined yet).
+<h1>Attributes</h1>
+<table class="ivy-attributes">
+<thead>
+    <tr><th class="ivy-att">Attribute</th><th class="ivy-att-desc">Description</th><th class="ivy-att-req">Required</th></tr>
+</thead>
+<tbody>
+    <tr><td>name</td><td>the name of the variable to define</td>
+        <td>Yes</td></tr>
+    <tr><td>value</td><td>the new value the variable must take</td>
+        <td>Yes</td></tr>
+    <tr><td>override</td><td>true if the previous value (if any) of the variable should overriden, false otherwise</td>
+        <td>No, defaults to true</td></tr>
+</tbody>
+</table>
+<h1>Examples</h1>
+<code type="xml">
+<property name="myvar" value="myvalue"/>
+</code>
+Sets the variable myvar to the value myvalue.
+<hr/>
+<code type="xml">
+<property name="myvar" value="myvalue" override="false"/>
+</code>
+Sets the variable myvar to the value myvalue only if myvar has not been set yet.
+
+
+

+ + + Propchange: ant/ivy/core/trunk/doc/settings/property.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: ant/ivy/core/trunk/doc/settings/property.html ------------------------------------------------------------------------------ svn:mime-type = text/plain