Modified: incubator/ivy/core/trunk/doc/doc/tutorial/multiple.html URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/doc/tutorial/multiple.html?view=diff&rev=519939&r1=519938&r2=519939 ============================================================================== --- incubator/ivy/core/trunk/doc/doc/tutorial/multiple.html (original) +++ incubator/ivy/core/trunk/doc/doc/tutorial/multiple.html Mon Mar 19 06:14:32 2007 @@ -5,110 +5,110 @@ <script type="text/javascript" src="../../xooki/xooki.js"></script> </head> <body> - <textarea id="xooki-source"> -This example is an illustration of how artefacts can be retreived by multiple resolvers. Using multiple resolvers is very important when using continous integration. Indeed, in such environements, you can use multiple repositories and so multiple resolvers to retreive both released versions of projects than continous integrated versions produced for example with cruise-control. In our example, we will just show how to use two resolvers, one on a local repository and one using ibiblio repository. - -<h1>project description</h1> -<h2>the project : chained-resolvers</h2> -The project is very simple and contains only one test class : example.Hello -It depends on two libraries apache commons-lang and a little test library (sources are included in jar file). The test library is used by the project to uppercase a string, and commons-lang is used to capitalize the same string. - -Here is the content of the project: -<ul> - <li>build.xml : the ant build file for the project</li> - <li>ivy.xml : the ivy project file</li> - <li>src\example\Hello.java : the only class of the project</li> -</ul> -Take a look at it's <b>ivy.xml</b> file : -<code> -<ivy-module version="1.0"> - <info organisation="jayasoft" module="chained-resolvers" /> - <dependencies> - <dependency org="apache" name="commons-lang" rev="2.0" /> - <dependency name="test" rev="1.0" /> - </dependencies> -</ivy-module> -</code> -As we expect, the ivy file declares to be dependent on the two libraries that the project use : apache commons-lang.jar and test.jar. - -<h2>the <b>ivy</b> configuration</h2> -The ivy configuration is made in the config directory it contains only one file: ivysettings.xml. - -Let's analyse it. -<code> -<ivysettings> - <conf defaultResolver="chain-example" /> - <resolvers> - <chain name="chain-example"> - <filesystem name="libraries"> - <artifact pattern="${ivy.settings.dir}/repository/[artifact]-[revision].[type]" /> - </filesystem> - <ibiblio name="ibiblio" /> - </chain> - </resolvers> -</ivysettings> -</code> -<h2>the <b>conf</b> tag</h2> -This tag initializes ivy with some parameters. Here only one is used, the name of the resolver to use by default. - -<h2>the <b>resolvers</b> tag</h2> -Under this tag, we can find the description of the resolvers that ivy will use. In our example, we have only one resolver, called "chain-example", which is quite special as it defines a list (a chain) of resolvers. -The resolvers put in the chain are : -<ul> - <li>libraries : it is a file resolver. This one is configured to look for artefacts in the "repository" sub directory of the directory that contains the ivysettings.xml file.</li> - <li>ibiblio : this resolver is a special one. It looks in the ibiblio maven repository to retreive the libraries.</li> -</ul> - -<h1>walkthrough</h1> -<div class="step"> -<h2>step 1 : preparation</h2> -Open a DOS or shell window, and go to the "chained-resolvers" directory. -</div> -<div class="step"> -<h2>step 2 : clean directory tree</h2> -On the prompt type : ant<br> -This will clean up the entire project directory tree and ivy cache. You can do it each time you want to clean up this example. -</div> -<div class="step"> -<h2>step 3 : run the project</h2> -Goto chainedresolvers-project directory. And simply run <b>ant</b>. -<div class="shell"><pre>I:\chained-resolvers\chainedresolvers-project>ant -Buildfile: build.xml - -configure: -:: Ivy 1.0-rc3 - 20050421161206 :: http://ivy.jayasoft.org/ :: - -resolve: -:: resolving dependencies :: jayasoft/[EMAIL PROTECTED] - confs: [default] -downloading http://www.ibiblio.org/maven/commons-lang/jars/commons-lang-2.0.jar(2.0) ... -.................................... (165kB) - [SUCCESSFUL ] apache/commons-lang-2.0/commons-lang.jar[jar] (5390ms) -downloading file:/I:/chained-resolvers/config/repository/test-1.0.jar(1.0) ... -. (1kB) - [SUCCESSFUL ] jayasoft/test-1.0/test.jar[jar] (16ms) -:: resolution report :: - --------------------------------------------------------------------- - | | modules || artifacts | - | conf | number| search|dwnlded|evicted|| number|dwnlded| - --------------------------------------------------------------------- - | default | 2 | 2 | 0 | 0 || 2 | 2 | - --------------------------------------------------------------------- -:: retrieving :: jayasoft/chained-resolvers - confs: [default] - 2 artifacts copied, 0 already retrieved - -run: - [mkdir] Created dir: I:\chained-resolvers\chainedresolvers-project\build - [javac] Compiling 1 source file to I:\chained-resolvers\chainedresolvers-project\build - [java] standard message :example world ! - [java] capitalized by org.apache.commons.lang.WordUtils : Example World ! - [java] upperCased by test.StringUtils : EXAMPLE WORLD ! - -BUILD SUCCESSFUL -Total time: 9 seconds</pre></div></div> -We can see in the log of the resolve task, that the two dependencies have been retrieved (2 artifacts) and copied to the ivy cache directory (2 downloaded). The run target succeed in using both commons-lang.jar comming from ibiblio repository and test.jar comming from the local repository. - + <textarea id="xooki-source"> +This example is an illustration of how artifacts can be retrieved by multiple resolvers. Using multiple resolvers is very important when using continous integration. Indeed, in such environments, you can use multiple repositories and so multiple resolvers to retrieve both released versions of projects than continous integrated versions produced for example with cruise-control. In our example, we will just show how to use two resolvers, one on a local repository and one using ibiblio repository. + +<h1>project description</h1> +<h2>the project : chained-resolvers</h2> +The project is very simple and contains only one test class : example.Hello +It depends on two libraries apache commons-lang and a little test library (sources are included in jar file). The test library is used by the project to uppercase a string, and commons-lang is used to capitalize the same string. + +Here is the content of the project: +<ul> + <li>build.xml : the ant build file for the project</li> + <li>ivy.xml : the ivy project file</li> + <li>src\example\Hello.java : the only class of the project</li> +</ul> +Take a look at it's <b>ivy.xml</b> file : +<code> +<ivy-module version="1.0"> + <info organisation="jayasoft" module="chained-resolvers" /> + <dependencies> + <dependency org="apache" name="commons-lang" rev="2.0" /> + <dependency name="test" rev="1.0" /> + </dependencies> +</ivy-module> +</code> +As we expect, the ivy file declares to be dependent on the two libraries that the project use : apache commons-lang.jar and test.jar. + +<h2>the <b>ivy</b> settings</h2> +The ivy settings is made in the config directory it contains only one file: ivysettings.xml. + +Let's analyse it. +<code> +<ivysettings> + <settings defaultResolver="chain-example" /> + <resolvers> + <chain name="chain-example"> + <filesystem name="libraries"> + <artifact pattern="${ivy.settings.dir}/repository/[artifact]-[revision].[type]" /> + </filesystem> + <ibiblio name="ibiblio" /> + </chain> + </resolvers> +</ivysettings> +</code> +<h2>the <b>settings</b> tag</h2> +This tag initializes ivy with some parameters. Here only one is used, the name of the resolver to use by default. + +<h2>the <b>resolvers</b> tag</h2> +Under this tag, we can find the description of the resolvers that ivy will use. In our example, we have only one resolver, called "chain-example", which is quite special as it defines a list (a chain) of resolvers. +The resolvers put in the chain are : +<ul> + <li>libraries : it is a file resolver. This one is configured to look for artifacts in the "repository" sub directory of the directory that contains the ivysettings.xml file.</li> + <li>ibiblio : this resolver is a special one. It looks in the ibiblio maven repository to retrieve the libraries.</li> +</ul> + +<h1>walkthrough</h1> +<div class="step"> +<h2>step 1 : preparation</h2> +Open a DOS or shell window, and go to the "chained-resolvers" directory. +</div> +<div class="step"> +<h2>step 2 : clean directory tree</h2> +On the prompt type : ant<br> +This will clean up the entire project directory tree and ivy cache. You can do it each time you want to clean up this example. +</div> +<div class="step"> +<h2>step 3 : run the project</h2> +Goto chainedresolvers-project directory. And simply run <b>ant</b>. +<div class="shell"><pre>I:\chained-resolvers\chainedresolvers-project>ant +Buildfile: build.xml + +configure: +:: Ivy 1.0-rc3 - 20050421161206 :: http://ivy.jayasoft.org/ :: + +resolve: +:: resolving dependencies :: jayasoft/[EMAIL PROTECTED] + confs: [default] +downloading http://www.ibiblio.org/maven/commons-lang/jars/commons-lang-2.0.jar(2.0) ... +.................................... (165kB) + [SUCCESSFUL ] apache/commons-lang-2.0/commons-lang.jar[jar] (5390ms) +downloading file:/I:/chained-resolvers/config/repository/test-1.0.jar(1.0) ... +. (1kB) + [SUCCESSFUL ] jayasoft/test-1.0/test.jar[jar] (16ms) +:: resolution report :: + --------------------------------------------------------------------- + | | modules || artifacts | + | conf | number| search|dwnlded|evicted|| number|dwnlded| + --------------------------------------------------------------------- + | default | 2 | 2 | 0 | 0 || 2 | 2 | + --------------------------------------------------------------------- +:: retrieving :: jayasoft/chained-resolvers + confs: [default] + 2 artifacts copied, 0 already retrieved + +run: + [mkdir] Created dir: I:\chained-resolvers\chainedresolvers-project\build + [javac] Compiling 1 source file to I:\chained-resolvers\chainedresolvers-project\build + [java] standard message :example world ! + [java] capitalized by org.apache.commons.lang.WordUtils : Example World ! + [java] upperCased by test.StringUtils : EXAMPLE WORLD ! + +BUILD SUCCESSFUL +Total time: 9 seconds</pre></div></div> +We can see in the log of the resolve task, that the two dependencies have been retrieved (2 artifacts) and copied to the ivy cache directory (2 downloaded). The run target succeed in using both commons-lang.jar comming from ibiblio repository and test.jar coming from the local repository. + </textarea> <script type="text/javascript">xooki.postProcess();</script> </body>
Modified: incubator/ivy/core/trunk/doc/doc/tutorial/multiproject.html URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/doc/tutorial/multiproject.html?view=diff&rev=519939&r1=519938&r2=519939 ============================================================================== --- incubator/ivy/core/trunk/doc/doc/tutorial/multiproject.html (original) +++ incubator/ivy/core/trunk/doc/doc/tutorial/multiproject.html Mon Mar 19 06:14:32 2007 @@ -24,7 +24,7 @@ </ul> For sure this is not aimed to demonstrate how to develop a complex app or give indication of advanced algorithm :-) -But this gives a simple understanding of how ivy can be used to develop an application divided in multitple modules. +But this gives a simple understanding of how ivy can be used to develop an application divided in multiple modules. Now, here is how these modules relate to each other: <a href="../../samples/projects-dependencies-graph.jpg"><img src="../../samples/projects-dependencies-graph-small.jpg" alt="dependencies graph"/><br/><center><i>click to enlarge</i></center></a> @@ -36,7 +36,7 @@ <h1>The example files</h1> The sources for this tutorial can be found in src/example/multi-project in the ivy distribution. In this directory, you will find the following files: <ul> -<li><a href="./misc/ivy/samples/multi-project/build.xml">build.xml</a></li>This a root build file which can be used to call targets on all modules, in the order of their dependencies (ensuring that a module is always built before any module depending on it, for instance) +<li><a href="./misc/ivy/samples/multi-project/build.xml">build.xml</a></li>This is a root build file which can be used to call targets on all modules, in the order of their dependencies (ensuring that a module is always built before any module depending on it, for instance) <li>common <ul> <li><a href="./misc/ivy/samples/multi-project/common.xml">common.xml</a></li> the common build file imported by all build.xml files for each project. This build defines the targets which can be used in all projects. @@ -92,7 +92,7 @@ Now that you are a bit more familiar with the structure, let's have a look at the most important part of this example: the common build file. Indeed, as you have seen all modules build files only import the common build file, and defines their dependencies in their ivy files (with which you should begin to be familiar). So, here are some aspects of this common build file: -<h2>ivy configuration</h2> +<h2>ivy settings</h2> <code type="xml"> <target name="configure"> <!-- setup ivy default configuration with some custom info --> @@ -105,8 +105,8 @@ </target> </code> -This target configures ivy only by setting two properties: the location for the local repository and the location for the shared repository. It's the only configuration done here, since ivy 1.3 is configured by default to work in a team environment (see <a href="../../tutorial/defaultconf.html">default configuration tutorial</a> for details about this). For sure in a real environment the shared repository location would rather be in a team shared directory (or in a more complex repository, again see the default configuration tutorial to see how to use something really different). -This target only indicates in comments how the configuration would have been done if the default configuration wasn't ok for our purpose. +This target configures ivy only by setting two properties: the location for the local repository and the location for the shared repository. It's the only settings done here, since ivy 1.3 is configured by default to work in a team environment (see <a href="../../tutorial/defaultconf.html">default settings tutorial</a> for details about this). For sure in a real environment the shared repository location would rather be in a team shared directory (or in a more complex repository, again see the default settings tutorial to see how to use something really different). +This target only indicates in comments how the settings would have been done if the default settings wasn't ok for our purpose. <h2>resolve dependencies</h2> <code type="xml"> @@ -161,7 +161,7 @@ </code> Generates both an html report and a graphml report. -For example, to generate a graph like the one shown at the beginning of this tutorial, you just have to follow the instructions given <a href="http://www.jayasoft.org/ivy/doc/yed";>here</a> with the graphml file you will find in <code>projects/console/build/</code> after having called report in the console project, and that's it, you have a clear overview of all your app dependencies ! +For example, to generate a graph like the one shown at the beginning of this tutorial, you just have to follow the instructions given <a href="../yed.html">here</a> with the graphml file you will find in <code>projects/console/build/</code> after having called report in the console project, and that's it, you have a clear overview of all your app dependencies ! </textarea> <script type="text/javascript">xooki.postProcess();</script> </body> Modified: incubator/ivy/core/trunk/doc/doc/tutorial/start.html URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/doc/tutorial/start.html?view=diff&rev=519939&r1=519938&r2=519939 ============================================================================== --- incubator/ivy/core/trunk/doc/doc/tutorial/start.html (original) +++ incubator/ivy/core/trunk/doc/doc/tutorial/start.html Mon Mar 19 06:14:32 2007 @@ -5,102 +5,102 @@ <script type="text/javascript" src="../../xooki/xooki.js"></script> </head> <body> - <textarea id="xooki-source"> -In this example, we will see one of the easiest way to use ivy. No configuration or other complicated files to write, only the list of libraries the project will use. - -If you have already followed the go-ivy tutorial on the <a href="../../doc/tutorial.html">tutorials home page</a>, this tutorial will be already familiar. It is actually pretty much the same, except that it requires ivy to be installed in your ant lib, and the java source and the ivy dependencies are available in separate files. For the java source, it's definitely recommended to put it in a separate file. For ivy dependencies, it depends on your usage and is discussed on the <a href="../../doc/bestpractices.html">best practices page</a>. - -But enough introduction material, let's go with this simple tutorial! - -<em>You'll find this tutorial sources in the ivy distribution in the src/example/hello-ivy directory.</em> - -<h1>The ivy.xml file</h1> -This file is used to describe the dependencies of the project on other libraries. -Here is the sample: -<code type="xml"> -<ivy-module version="1.0"> - <info organisation="jayasoft" module="hello-ivy" /> - <dependencies> - <dependency org="apache" name="commons-lang" rev="2.0" /> - </dependencies> -</ivy-module> -</code> - -<h1>The build.xml file</h1> -The build file corresponding to use it, contains only: -<code type="xml"> -<project xmlns:ivy="antlib:fr.jayasoft.ivy.ant" name="hello-ivy" default="run"> - - ... - - <!-- ================================= - target: resolve - ================================= --> - <target name="resolve" description="--> retrieve dependencies with ivy"> - <ivy:retrieve /> - </target> -</project> -</code> -<h1>Running the project</h1> -To run the sample, open a dos (or shell) window, and go under the hello-ivy example directory. -Then, on the command prompt, just run ant : -<div class="shell"><pre> -I:\hello-ivy>ant -Buildfile: build.xml - -resolve: -:: Ivy 1.0-rc3 - 20050421161206 :: http://ivy.jayasoft.org/ :: -no configuration file found, using default... -:: resolving dependencies :: jayasoft/[EMAIL PROTECTED] - confs: [default] -downloading http://www.ibiblio.org/maven/commons-lang/jars/commons-lang-2.0.jar(2.0) ... -..................................... (165kB) - [SUCCESSFUL ] apache/commons-lang-2.0/commons-lang.jar[jar] (4688ms) -:: resolution report :: - --------------------------------------------------------------------- - | | modules || artifacts | - | conf | number| search|dwnlded|evicted|| number|dwnlded| - --------------------------------------------------------------------- - | default | 1 | 1 | 0 | 0 || 1 | 1 | - --------------------------------------------------------------------- -:: retrieving :: jayasoft/hello-ivy - confs: [default] - 1 artifacts copied, 0 already retrieved - -run: - [mkdir] Created dir: I:\hello-ivy\build - [javac] Compiling 1 source file to I:\hello-ivy\build - [java] standard message : hello ivy ! - [java] capitalized by org.apache.commons.lang.WordUtils : Hello Ivy ! - -BUILD SUCCESSFUL -Total time: 8 seconds</pre></div> -<h1>What happened ?</h1> -Without any configuration, other than it's default configuration, ivy retrieve files from the maven ibiblio libraries repository. That's what happened here. -The resolve task has downloaded the commons-lang.jar file from ibiblio, then copied it to the ivy cache and then dispatch it in the default library directory of the project : the lib dir. -Some will say that the task was long to achieve. Yeah, it's true it was, but it has downloaded from the web the needed file. Let's try to run it again: -<div class="shell"><pre>I:\hello-ivy>ant -Buildfile: build.xml - -resolve: -:: resolving dependencies :: jayasoft/hello-ivy-null :: [default] -:: resolution report :: - [default] jayasoft/[EMAIL PROTECTED]: 1 artifacts (0 downloaded) -:: retrieving :: jayasoft/hello-ivy :: [default] - -run: - [java] standard message : hello ivy ! - [java] capitalized by org.apache.commons.lang.WordUtils : Hello Ivy ! - -BUILD SUCCESSFUL -Total time: 1 second</pre></div> -Great ! the cache was used, no download was needed and the build was instantaneous. - -If you want to check the content of the cache, by default it is put in your user home in a .ivy/cache directory. - -And now, if you want to generate a report detailing all the dependencies of your module, you can call the report target, and check the generated file in the build directory. You should obtain something looking like <a href="./misc/ivy/samples/jayasoft-ivyrep-example-default.html">this</a>. - -You are now ready to go to the next tutorials to go one step beyond using ivy transitive dependencies management. + <textarea id="xooki-source"> +In this example, we will see one of the easiest way to use ivy. No settings or other complicated files to write, only the list of libraries the project will use. + +If you have already followed the go-ivy tutorial on the <a href="../../doc/tutorial.html">tutorials home page</a>, this tutorial will be already familiar. It is actually pretty much the same, except that it requires ivy to be installed in your ant lib, and the java source and the ivy dependencies are available in separate files. For the java source, it's definitely recommended to put it in a separate file. For ivy dependencies, it depends on your usage and is discussed on the <a href="../../doc/bestpractices.html">best practices page</a>. + +But enough introduction material, let's go with this simple tutorial! + +<em>You'll find this tutorial sources in the ivy distribution in the src/example/hello-ivy directory.</em> + +<h1>The ivy.xml file</h1> +This file is used to describe the dependencies of the project on other libraries. +Here is the sample: +<code type="xml"> +<ivy-module version="1.0"> + <info organisation="jayasoft" module="hello-ivy" /> + <dependencies> + <dependency org="apache" name="commons-lang" rev="2.0" /> + </dependencies> +</ivy-module> +</code> + +<h1>The build.xml file</h1> +The build file corresponding to use it, contains only: +<code type="xml"> +<project xmlns:ivy="antlib:fr.jayasoft.ivy.ant" name="hello-ivy" default="run"> + + ... + + <!-- ================================= + target: resolve + ================================= --> + <target name="resolve" description="--> retrieve dependencies with ivy"> + <ivy:retrieve /> + </target> +</project> +</code> +<h1>Running the project</h1> +To run the sample, open a dos (or shell) window, and go under the hello-ivy example directory. +Then, on the command prompt, just run ant : +<div class="shell"><pre> +I:\hello-ivy>ant +Buildfile: build.xml + +resolve: +:: Ivy 1.0-rc3 - 20050421161206 :: http://ivy.jayasoft.org/ :: +no configuration file found, using default... +:: resolving dependencies :: jayasoft/[EMAIL PROTECTED] + confs: [default] +downloading http://www.ibiblio.org/maven/commons-lang/jars/commons-lang-2.0.jar(2.0) ... +..................................... (165kB) + [SUCCESSFUL ] apache/commons-lang-2.0/commons-lang.jar[jar] (4688ms) +:: resolution report :: + --------------------------------------------------------------------- + | | modules || artifacts | + | conf | number| search|dwnlded|evicted|| number|dwnlded| + --------------------------------------------------------------------- + | default | 1 | 1 | 0 | 0 || 1 | 1 | + --------------------------------------------------------------------- +:: retrieving :: jayasoft/hello-ivy + confs: [default] + 1 artifacts copied, 0 already retrieved + +run: + [mkdir] Created dir: I:\hello-ivy\build + [javac] Compiling 1 source file to I:\hello-ivy\build + [java] standard message : hello ivy ! + [java] capitalized by org.apache.commons.lang.WordUtils : Hello Ivy ! + +BUILD SUCCESSFUL +Total time: 8 seconds</pre></div> +<h1>What happened ?</h1> +Without any settings, other than it's default settings, ivy retrieve files from the maven ibiblio libraries repository. That's what happened here. +The resolve task has downloaded the commons-lang.jar file from ibiblio, then copied it to the ivy cache and then dispatch it in the default library directory of the project : the lib dir. +Some will say that the task was long to achieve. Yeah, it's true it was, but it has downloaded from the web the needed file. Let's try to run it again: +<div class="shell"><pre>I:\hello-ivy>ant +Buildfile: build.xml + +resolve: +:: resolving dependencies :: jayasoft/hello-ivy-null :: [default] +:: resolution report :: + [default] jayasoft/[EMAIL PROTECTED]: 1 artifacts (0 downloaded) +:: retrieving :: jayasoft/hello-ivy :: [default] + +run: + [java] standard message : hello ivy ! + [java] capitalized by org.apache.commons.lang.WordUtils : Hello Ivy ! + +BUILD SUCCESSFUL +Total time: 1 second</pre></div> +Great ! the cache was used, no download was needed and the build was instantaneous. + +If you want to check the content of the cache, by default it is put in your user home in a .ivy/cache directory. + +And now, if you want to generate a report detailing all the dependencies of your module, you can call the report target, and check the generated file in the build directory. You should obtain something looking like <a href="./misc/ivy/samples/jayasoft-ivyrep-example-default.html">this</a>. + +You are now ready to go to the next tutorials to go one step beyond using ivy transitive dependencies management. </textarea> <script type="text/javascript">xooki.postProcess();</script> </body> Modified: incubator/ivy/core/trunk/doc/doc/use/configure.html URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/doc/use/configure.html?view=diff&rev=519939&r1=519938&r2=519939 ============================================================================== --- incubator/ivy/core/trunk/doc/doc/use/configure.html (original) +++ incubator/ivy/core/trunk/doc/doc/use/configure.html Mon Mar 19 06:14:32 2007 @@ -6,9 +6,8 @@ </head> <body> <textarea id="xooki-source"> -The configure task is used to configure ivy with an xml configuration file.<br/><br/> -See <a href="../../doc/configuration.html">configuration</a> for details about the configuration -file itself.<br/><br/> +The configure task is used to configure ivy with an xml settings file.<br/><br/> +See <a href="../../doc/configuration.html">settings</a> for details about the settings file itself.<br/><br/> <i>Note for developers:<br/> 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".</i> @@ -17,11 +16,9 @@ <tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr> </thead> <tbody> - <tr><td>file</td><td>path to the configuration file to use</td> - <td rowspan="2">No. If a file is provided, url is ignored. If none are - provided, then it attempts to find a file at ${ivy.settings.file}, and if - this file does not exist, it uses a <a href="./misc/ivy/samples/ivysettings-default.xml">default configuration file</a></td></tr> - <tr><td>url</td><td>url of the configuration file to use</td></tr> + <tr><td>file</td><td>path to the settings file to use</td> + <td rowspan="2">No. If a file is provided, url is ignored. If none are provided, then it attempts to find a file at ${ivy.settings.file}, and if this file does not exist, it uses a <a href="./misc/ivy/samples/ivysettings-default.xml">default settings file</a></td></tr> + <tr><td>url</td><td>url of the settings file to use</td></tr> <tr><td>host</td><td>http authentication host</td><td rowspan="4">No, unless authentication is required</td></tr> <tr><td>realm</td><td>http authentication realm</td></tr> <tr><td>username</td><td>http authentication user name</td></tr> @@ -39,9 +36,9 @@ It's also possible to configure authentication settings for multiple urls. This can be done with the <credentials> subelements. See the examples for more details. <h2>Examples</h2> -<h3>Simplest configuration</h3> +<h3>Simplest settings</h3> <code><ivy:configure /></code> -Use either ${ivy.settings.file} if it exists, or the <a href="./misc/ivy/samples/ivysettings-default.xml">default configuration file</a> +Use either ${ivy.settings.file} if it exists, or the <a href="./misc/ivy/samples/ivysettings-default.xml">default settings file</a> <h3>Configure with a file</h3> <code><ivy:configure file="myconffile.xml" /></code> <h3>Configure with an url</h3> Modified: incubator/ivy/core/trunk/doc/toc.json URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/toc.json?view=diff&rev=519939&r1=519938&r2=519939 ============================================================================== --- incubator/ivy/core/trunk/doc/toc.json (original) +++ incubator/ivy/core/trunk/doc/toc.json Mon Mar 19 06:14:32 2007 @@ -239,7 +239,7 @@ }, { "id":"doc/tutorial/defaultconf", - "title":"Configuring default resolver", + "title":"Adjusting default settings", "children": [ ] @@ -362,7 +362,7 @@ }, { "id":"doc/configuration", - "title":"Configuration", + "title":"Settings", "children": [ { "id":"doc/configuration/property", @@ -380,7 +380,7 @@ }, { "id":"doc/configuration/conf", - "title":"conf", + "title":"settings", "children": [ ]
