ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From xav...@apache.org
Subject svn commit: r600325 - in /ant/ivy/core/trunk/doc: configuration.html configuration/cache.html configuration/conf.html configuration/lock-strategies.html extend.html toc.json
Date Sun, 02 Dec 2007 16:15:56 GMT
Author: xavier
Date: Sun Dec  2 08:15:56 2007
New Revision: 600325

URL: http://svn.apache.org/viewvc?rev=600325&view=rev
Log:
document new cache settings (IVY-628 and IVY-654) (merged from incubator svn, where changes
where unpurposefully applied first)

Added:
    ant/ivy/core/trunk/doc/configuration/cache.html   (contents, props changed)
      - copied, changed from r600323, incubator/ivy/core/trunk/doc/configuration/cache.html
    ant/ivy/core/trunk/doc/configuration/lock-strategies.html   (contents, props changed)
      - copied, changed from r600323, incubator/ivy/core/trunk/doc/configuration/lock-strategies.html
Modified:
    ant/ivy/core/trunk/doc/configuration.html
    ant/ivy/core/trunk/doc/configuration/conf.html
    ant/ivy/core/trunk/doc/extend.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=600325&r1=600324&r2=600325&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/configuration.html (original)
+++ ant/ivy/core/trunk/doc/configuration.html Sun Dec  2 08:15:56 2007
@@ -25,16 +25,16 @@
 </head>
 <body>
 	<textarea id="xooki-source">
-In order to work as you want, ivy sometimes need some settings. Actually, ivy can work with
no specific settings at all, see the <a href="tutorial/defaultconf.html">default settings
documentation</a> for details about that. But ivy is able 
-to work in very different contexts. You just have to configure it properly.
+In order to work as you want, ivy sometimes need some settings. Actually, ivy can work with
no specific settings at all, see the <a href="tutorial/defaultconf.html">default settings
documentation</a> for details about that. But ivy is able to work in very different
contexts. You just have to configure it properly.
 
-Settings are specified through an xml file, usually called ivysettings.xml. To configure
ivy from ant, you just have to call the configure task and pass it the path to your settings
file (see <a href="use/configure.html">configure</a> task documentation for details).
+Settings are specified through an xml file, usually called ivysettings.xml. To configure
ivy from ant, you just have to use the [[ant:settings]] datatype with the path of your settings
file.
 
 Here is an example of settings file :
 <code type="xml">
 <ivysettings>
         <properties file="${ivy.settings.dir}/ivysettings-file.properties" />
-        <settings defaultCache="${cache.dir}" defaultResolver="ibiblio" checkUpToDate="false"
/>
+        <settings defaultResolver="ibiblio" checkUpToDate="false" />
+        <cache basedir="${cache.dir}" />
         <resolvers>
                 <ibiblio name="ibiblio" />
                 <filesystem name="internal">
@@ -73,6 +73,8 @@
     <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>
@@ -121,6 +123,10 @@
         <td>0..n</td></tr>
     <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>
     <tr><td><a href="configuration/parsers.html">parsers</a></td><td>defines
module descriptor parsers</td>

Copied: ant/ivy/core/trunk/doc/configuration/cache.html (from r600323, incubator/ivy/core/trunk/doc/configuration/cache.html)
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/configuration/cache.html?p2=ant/ivy/core/trunk/doc/configuration/cache.html&p1=incubator/ivy/core/trunk/doc/configuration/cache.html&r1=600323&r2=600325&rev=600325&view=diff
==============================================================================
    (empty)

Propchange: ant/ivy/core/trunk/doc/configuration/cache.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: ant/ivy/core/trunk/doc/configuration/conf.html
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/configuration/conf.html?rev=600325&r1=600324&r2=600325&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/configuration/conf.html (original)
+++ ant/ivy/core/trunk/doc/configuration/conf.html Sun Dec  2 08:15:56 2007
@@ -31,6 +31,8 @@
 
 Default cache is used whenever a cache is not provided. It usually points to a directory
in your filesystem. <strong>This should not point to a directory used as a repository!</strong>
 <span class="since">Since 2.0</span> 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.
+<span class="since">Since 2.0</span> A new [[configuration/cache]] tag is provided
where you can fully configure the cache. As of 2.0 beta 1, we recommend using the cache tag
even though configuring using the attributes available on this tag is still possible.
+
 
 Default resolver is used whenever nothing else is configured in the modules section of the
configuration file. It should give the name of a dependency resolver defined in the resolvers
section of the configuration file.
 
@@ -44,14 +46,13 @@
 checkUpToDate indicates to ivy if it must check date of artifacts before retrieving them
(i.e. copying them from
 cache to another place in your filesystem). Usually it is a good thing to check date to avoid
unnecessary copy, even if it's most of the time a local copy.
 
-cacheIvyPattern and cacheArtifactPattern 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.
 <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>defaultCache</td><td>a path to a directory to use as
default cache</td>
+    <tr><td>defaultCache</td><td>a path to a directory to use as
default cache.  <i>We recommend using the basedir on the [[configuration/cache]] tag
instead</i></td>
         <td>No, defaults to .ivy2/cache in user home</td></tr>
     <tr><td>defaultResolver</td><td>the name of the default resolver
to use</td>
         <td>No, but all modules should be configured in the modules section if not
provided</td></tr>
@@ -67,9 +68,9 @@
         <td>No, defaults to true</td></tr>
     <tr><td>checkUpToDate</td><td>Indicates if date should be checked
before retrieving artifacts from cache</td>
         <td>No, defaults to true</td></tr>
-    <tr><td>cacheIvyPattern</td><td>a pattern to indicate where ivy
files should be put in cache</td>
+    <tr><td>cacheIvyPattern</td><td>a pattern to indicate where ivy
files should be put in cache. <i>We recommend using the repositoryIvyPattern on the
[[configuration/cache]] tag instead</i></td>
         <td>No, defaults to [organisation]/[module]/ivy-[revision].xml</td></tr>
-    <tr><td>cacheArtifactPattern</td><td>a pattern to indicate where
artifact files should be put in cache</td>
+    <tr><td>cacheArtifactPattern</td><td>a pattern to indicate where
artifact files should be put in cache. <i>We recommend using the repositoryArtifactPattern
on the [[configuration/cache]] tag instead</i></td>
         <td>No, defaults to [organisation]/[module]/[type]s/[artifact]-[revision].[ext]</td></tr>
     <tr><td>useRemoteConfig</td><td>true to configure ivyrep and
ibiblio resolver from a remote configuration file (updated with changes in those repository
structure if any) (<span class="since">since 1.2</span>)</td>
         <td>No, defaults to false</td></tr>

Copied: ant/ivy/core/trunk/doc/configuration/lock-strategies.html (from r600323, incubator/ivy/core/trunk/doc/configuration/lock-strategies.html)
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/configuration/lock-strategies.html?p2=ant/ivy/core/trunk/doc/configuration/lock-strategies.html&p1=incubator/ivy/core/trunk/doc/configuration/lock-strategies.html&r1=600323&r2=600325&rev=600325&view=diff
==============================================================================
    (empty)

Propchange: ant/ivy/core/trunk/doc/configuration/lock-strategies.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: ant/ivy/core/trunk/doc/extend.html
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/extend.html?rev=600325&r1=600324&r2=600325&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/extend.html (original)
+++ ant/ivy/core/trunk/doc/extend.html Sun Dec  2 08:15:56 2007
@@ -25,41 +25,30 @@
 </head>
 <body>
 	<textarea id="xooki-source">
-Many things are configurable in ivy, and many things are available with ivy core. But when
you want to do 
-something not built in ivy core, you can still plug your own code.<br/><br/>
+Many things are configurable in Ivy, and many things are available with Ivy core. But when
you want to do something not built in ivy core, you can still plug your own code.
 
-Several things are pluggable in ivy:
+Many things are pluggable in Ivy:
 <ul>
 <li>module descriptor parsers</li>
 <li>dependency resolvers</li>
+<li>lock strategies</li>
 <li>latest strategies</li>
+<li>circular dependency strategies</li>
 <li>conflict managers</li>
 <li>report outputters</li>
 <li>version matchers</li>
 <li>triggers</li>
 </ul>
 
-Before trying to implement your own, we encourage you to check if the solution to your problem
cannot be 
-addressed by existing features, or by [[links contributed ones]]. Do not hesitate to ask
for help on the [[mailing-lists]].<br/><br/>
+Before trying to implement your own, we encourage you to check if the solution to your problem
cannot be addressed by existing features, or by [[links contributed ones]]. Do not hesitate
to ask for help on the [[mailing-lists]].
 
-If you still don't find what you need, then you'll have to develop your own plugin or find
someone who could do that for you.<br/><br/>
+If you still don't find what you need, then you'll have to develop your own plugin or find
someone who could do that for you.
 
-Here are the main things to know if you want to develop your own plugins...<br/><br/>
+All ivy plug-ins use the same code patterns as ant specific tasks for parameters. This means
that if you want to have a "myattribute" of type String, you just have to declare a method
called setMyattribute(String val) on your plug-in. The same applies to child tags, you just
have to follow Ant specifications.
 
-All ivy plug-ins use the same code patterns as ant specific tasks for parameters. This means
that
-if you want to have a "myattribute" of type String, you just have to declare a method called
-setMyattribute(String val) on your plug-in. The same applies to child tags, you just have
to follow ant specifications.<br/><br/>
-
-Knowing that, you then have to implement the appropriate interface:
-<ul>
-<li>org.apache.ivy.DependencyResolver for dependency resolvers</li>
-<li>org.apache.ivy.LatestStrategy for latest strategies</li>
-<li>org.apache.ivy.ConflictManager for conflict managers</li>
-<li>org.apache.ivy.parser.ModuleDescriptorParser for module descriptor parsers</li>
-</ul>
-
-To help you understand what is required in each implementation, and what you can use to do
it, have a look to existing implementations, it's the best advice we can give you!
+All pluggable code in Ivy is located in the [[svn:src/java/org/apache/ivy/plugins org.apache.ivy.plugins]]
package. In each package you will find an interface that you must implement to provide a new
plugin. We usually also provide an abstract class easing the implementation and making your
code more independent of interface changes. We heavily recommend using these abstract classes
as a base class.
 
+To understand how your implementation can be done, we suggest looking at existing implementations
we provide, it's the best way to get started.
 	</textarea>
 <script type="text/javascript">xooki.postProcess();</script>
 </body>

Modified: ant/ivy/core/trunk/doc/toc.json
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/toc.json?rev=600325&r1=600324&r2=600325&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/toc.json (original)
+++ ant/ivy/core/trunk/doc/toc.json Sun Dec  2 08:15:56 2007
@@ -193,6 +193,20 @@
                             ]
                         },
                         {
+                          "id":"configuration/lock-strategies",
+                          "title":"lock-strategies",
+                          "children": [
+
+                            ]
+                        },
+                        {
+                          "id":"configuration/cache",
+                          "title":"cache",
+                          "children": [
+
+                            ]
+                        },
+                        {
                           "id":"configuration/latest-strategies",
                           "title":"latest-strategies",
                           "children": [



Mime
View raw message