ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From xav...@apache.org
Subject svn commit: r608798 - in /ant/ivy/core/trunk/doc: configuration.html configuration/cache.html configuration/cacheDefaults.html toc.json
Date Fri, 04 Jan 2008 10:57:51 GMT
Author: xavier
Date: Fri Jan  4 02:57:50 2008
New Revision: 608798

URL: http://svn.apache.org/viewvc?rev=608798&view=rev
Log:
start documentation update with latest cache management changes

Added:
    ant/ivy/core/trunk/doc/configuration/cacheDefaults.html
      - copied, changed from r608462, ant/ivy/core/trunk/doc/configuration/cache.html
Removed:
    ant/ivy/core/trunk/doc/configuration/cache.html
Modified:
    ant/ivy/core/trunk/doc/configuration.html
    ant/ivy/core/trunk/doc/toc.json

Modified: ant/ivy/core/trunk/doc/configuration.html
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/configuration.html?rev=608798&r1=608797&r2=608798&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/configuration.html (original)
+++ ant/ivy/core/trunk/doc/configuration.html Fri Jan  4 02:57:50 2008
@@ -34,7 +34,7 @@
 <ivysettings>
         <properties file="${ivy.settings.dir}/ivysettings-file.properties" />
         <settings defaultResolver="ibiblio" checkUpToDate="false" />
-        <cache basedir="${cache.dir}" />
+        <cacheDefaults defaultBasedir="${cache.dir}" />
         <resolvers>
                 <ibiblio name="ibiblio" />
                 <filesystem name="internal">
@@ -70,11 +70,11 @@
     <a href="configuration/property.html">property</a>
     <a href="configuration/properties.html">properties</a>
     <a href="configuration/conf.html">settings</a>
+    <a href="configuration/cacheDefaults.html">cacheDefaults</a>
     <a href="configuration/include.html">include</a>
     <a href="configuration/classpath.html">classpath</a>
     <a href="configuration/typedef.html">typedef</a>
     <a href="configuration/lock-strategies.html">lock-strategies</a>
-    <a href="configuration/cache.html">cache</a>
     <a href="configuration/latest-strategies.html">latest-strategies</a>
     <a href="configuration/version-matchers.html">version-matchers</a>
     <a href="configuration/triggers.html">triggers</a>
@@ -117,6 +117,8 @@
         <td>0..n</td></tr>
     <tr><td><a href="configuration/conf.html">settings</a></td><td>configures
ivy with some defaults</td>
         <td>0..1</td></tr>
+    <tr><td><a href="configuration/cacheDefaults.html">cacheDefaults</a></td><td>set
up default values for cache(s)</td>
+        <td>0..1</td></tr>
     <tr><td><a href="configuration/include.html">include</a></td><td>includes
another settings file</td>
         <td>0..n</td></tr>
     <tr><td><a href="configuration/classpath.html">classpath</a></td><td>add
a location in the classpath used to load plugins</td>
@@ -124,8 +126,6 @@
     <tr><td><a href="configuration/typedef.html">typedef</a></td><td>defines
new types in ivy</td>
         <td>0..n</td></tr>
     <tr><td><a href="configuration/lock-strategies.html">lock-strategies</a></td><td>defines
lock strategies</td>
-        <td>0..1</td></tr>
-    <tr><td><a href="configuration/cache.html">cache</a></td><td>set
up the cache</td>
         <td>0..1</td></tr>
     <tr><td><a href="configuration/latest-strategies.html">latest-strategies</a></td><td>defines
latest strategies</td>
         <td>0..1</td></tr>

Copied: ant/ivy/core/trunk/doc/configuration/cacheDefaults.html (from r608462, ant/ivy/core/trunk/doc/configuration/cache.html)
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/configuration/cacheDefaults.html?p2=ant/ivy/core/trunk/doc/configuration/cacheDefaults.html&p1=ant/ivy/core/trunk/doc/configuration/cache.html&r1=608462&r2=608798&rev=608798&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/configuration/cache.html (original)
+++ ant/ivy/core/trunk/doc/configuration/cacheDefaults.html Fri Jan  4 02:57:50 2008
@@ -25,9 +25,9 @@
 </head>
 <body>
 	<textarea id="xooki-source">
-<b>Tag:</b> cache
+<b>Tag:</b> cacheDefaults
 
-<span class="since">since 2.0</span> Configures the Ivy cache.
+<span class="since">since 2.0</span> Configures defaults values for Ivy cache(s).
 
 Ivy cache is composed of two different parts:
 <ul>
@@ -39,19 +39,23 @@
 This part of the cache is overwritten each time a new resolve is performed, and should never
be used by multiple processes at the same time.
 </ul>
 
-Here are some details on the available settings attributes:
+While there is always only one resolution cache, you can define multiple repository cache,
each [[configuration/resolvers resolver]] being able to use a separate cache.
 
-<em>basedir</em> is the base directory where the cache will be stored. All other
cache related paths are relative to this basedir.
-It usually points to a directory in the local filesystem. 
-<strong>This should not point to a directory used as a repository!</strong>
+This element only define default values for repository caches, used by all repository caches
when not overridden. To define repository cache instances, use the cache element.
 
-Once the settings are loaded, the value of the defaultCache (either configured or the default
value) is stored in an Ivy variable: ivy.cache.dir.
+Caches usually relies on a base directory, where all files stored in the cache go.
+<strong>This base directory should not point to a directory used as a repository!</strong>
+
+Here are some details on the available settings attributes:
+<em>defaultBasedir</em> is the default base directory where the resolution and
repository caches will be stored. 
+It usually points to a directory in the local filesystem. 
+This is useful only if you want to use the same default basedir for both the resolution and
the repository caches. Otherwise we recommend using <em>repositoryDir</em> and
<em>resolutionDir</em> instead.
 
 <em>repositoryDir</em> and <em>resolutionDir</em> are used to configure
the base location of the repository and resolution parts of the cache.
 
-<em>repositoryIvyPattern</em> and <em>repositoryArtifactPattern</em>
are used to configure the way Ivy stores ivy files and artifacts in the cache. Usually you
do not have to change this, unless you want to use the cache directly from another tool, which
is not recommended. These patterns are relative to the repository cache root.
+<em>repositoryIvyPattern</em> and <em>repositoryArtifactPattern</em>
are used to configure the default way Ivy stores ivy files and artifacts in repository cache(s).
Usually you do not have to change this, unless you want to use the cache directly from another
tool, which is not recommended. These patterns are relative to the repository cache base directory.
 
-<em>lockStrategy</em> is used to define the lock strategy to use when accessing
the repository cache.
+<em>lockStrategy</em> is used to define the default lock strategy to use by repository
cache.
 
 <h1>Attributes</h1>
 <table class="ivy-attributes">
@@ -59,23 +63,28 @@
     <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>basedir</td><td>a path to a directory to use as base
directory for the cache.</td>
+    <tr><td>defaultBasedir</td><td>a path to a directory to use as
as default base directory for both resolution and repository caches.</td>
         <td>No, defaults to .ivy2/cache in user home</td></tr>
     <tr><td>resolutionDir</td><td>the path of the directory to use
to put all resolution cache data</td>
-        <td>No, defaults to empty string (ie cache basedir)</td></tr>
+        <td>No, defaults to defaultBasedir</td></tr>
     <tr><td>repositoryDir</td><td>the path of the directory to use
to put all repository cache data</td>
-        <td>No, defaults to empty string (ie cache basedir)</td></tr>
+        <td>No, defaults to defaultBasedir</td></tr>
     <tr><td>repositoryIvyPattern</td><td>a pattern to indicate where
ivy files should be put in the repository cache</td>
         <td>No, defaults to [organisation]/[module]/ivy-[revision].xml</td></tr>
     <tr><td>repositoryArtifactPattern</td><td>a pattern to indicate
where artifact files should be put in repository cache</td>
         <td>No, defaults to [organisation]/[module]/[type]s/[artifact]-[revision].[ext]</td></tr>
-    <tr><td>lockStragegy</td><td>the name of the [[configuration/lock-strategies]]
lock strategy to use when accessing the cache</td>
+    <tr><td>lockStragegy</td><td>the name of the default [[configuration/lock-strategies
lock strategy]] to use when accessing the cache</td>
         <td>No, defaults to <em>no-lock</em></td></tr>
 </tbody>
 </table>
 <h1>Example</h1>
 <code type="xml">
-<cache basedir="mycache"
+<cacheDefaults defaultBasedir="mycache" />
+</code>
+Tells Ivy to use "mycache" as default location where all caches should go.
+<hr/>
+<code type="xml">
+<cacheDefaults 
         resolutionDir="resolution"
         repositoryDir="repository"
         repositoryIvyPattern="[module]/ivys/ivy-[revision].xml" 
@@ -83,7 +92,7 @@
         lockStrategy="artifact-lock"
 />
 </code>
-</textarea>
+Tells Ivy to put the resolution cache in a directory called 'resolution', and to use the
directory named 'repository' as default location for all repository cache(s). It also configures
the default ivy and artifact patterns for repository caches, as well as the default lock strategy
to use.</textarea>
 <script type="text/javascript">xooki.postProcess();</script>
 </body>
 </html>

Modified: ant/ivy/core/trunk/doc/toc.json
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/toc.json?rev=608798&r1=608797&r2=608798&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/toc.json (original)
+++ ant/ivy/core/trunk/doc/toc.json Fri Jan  4 02:57:50 2008
@@ -165,6 +165,13 @@
                             ]
                         },
                         {
+                          "id":"configuration/cacheDefaults",
+                          "title":"cacheDefaults",
+                          "children": [
+
+                            ]
+                        },
+                        {
                           "id":"configuration/include",
                           "title":"include",
                           "children": [
@@ -188,13 +195,6 @@
                         {
                           "id":"configuration/lock-strategies",
                           "title":"lock-strategies",
-                          "children": [
-
-                            ]
-                        },
-                        {
-                          "id":"configuration/cache",
-                          "title":"cache",
                           "children": [
 
                             ]



Mime
View raw message