src/documentation/ref/Ivyconfiguration.html - ant-easyant-core - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <!--
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 -->
 <html>
 <head>
 	<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
 	<script type="text/javascript">var xookiConfig = {level: 1};</script>
 	<script type="text/javascript" src="../xooki/xooki.js"></script>
 </head>
 <body>
 	<textarea id="xooki-source">
 <h1>Ivy configuration</h1>
 In order to work as you want, EasyAnt sometimes need some settings. Actually, EasyAnt can work with no specific settings at all, see the default settings documentation for details about that. 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.
 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" />
         <resolvers>
                 <ibiblio name="ibiblio" />
                 <filesystem name="internal">
                         <ivy pattern="${repository.dir}/[module]/ivy-[revision].xml" />
                         <artifact pattern="${repository.dir}/[module]/[artifact]-[revision].[ext]" />
                 </filesystem>
         </resolvers>
         <modules>
                 <module organisation="jayasoft" name=".*" resolver="internal" />
         </modules>
 </ivysettings>
 </code>

 Mainly, the settings enable to configure the default cache directory used by ivy and the dependency resolvers that it will use to resolve dependencies.
 <div id="note">Note: To work, this settings file needs a property file named ivysettings-file.properties in the same directory as the settings file, with ivy variables you want in it.</div>
 If you want to have more details on this settings file we strongly recommend you to read the <a href="http://ant.apache.org/ivy/history/2.1.0-rc1/settings.html">reference documentation of settings file</a>

 EasyAnt uses two ivy instance :
 <ol>
   <li>used to resolve/retrieve EasyAnt modules (which can be buildtypes/ plugins or skeletons) dependencies</li>
   <li>used to resolve/retrieve project dependencies</li>
 </ol>
 There is a strong separation of context, this means that plugins dependencies will not be polluting your project.
 Both instance are configurable.
 <ul>
   <li>Project ivy instance can be configured through an ivysettings file defined through properties. Click <a href="ref/ProjectIvyInstance.html">here</a> if you want more details.</li>
   <li>EasyAnt ivy instance can be configured through an ivysettings file defined in easyant-config. Click <a href="ref/EasyAntconfigurationfile.html">here</a> if you want more details.</li>
 </ul>


 <h2>Project ivy instance</h2>
 The <a href="ProjectIvyInstance.html">project ivy instance</a> is in charge to configure ivy for your project (configure repositories used to retrieve your projects dependencies for example).

 <h2>EasyAnt ivy instance</h2>
 <a href="EasyAntivyinstance.html">EasyAnt ivy instance</a> is in charge to configure ivy for easyant internal use (configure repositories used to retrieve buildtypes/plugins/skeletons for example).

 </textarea>
 <script type="text/javascript">xooki.postProcess();</script>
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->
	<html>
	<head>
	<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
	<script type="text/javascript">var xookiConfig = {level: 1};</script>
	<script type="text/javascript" src="../xooki/xooki.js"></script>
	</head>
	<body>
	<textarea id="xooki-source">
	<h1>Ivy configuration</h1>
	In order to work as you want, EasyAnt sometimes need some settings. Actually, EasyAnt can work with no specific settings at all, see the default settings documentation for details about that. 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.
	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" />
	<resolvers>
	<ibiblio name="ibiblio" />
	<filesystem name="internal">
	<ivy pattern="${repository.dir}/[module]/ivy-[revision].xml" />
	<artifact pattern="${repository.dir}/[module]/[artifact]-[revision].[ext]" />
	</filesystem>
	</resolvers>
	<modules>
	<module organisation="jayasoft" name=".*" resolver="internal" />
	</modules>
	</ivysettings>
	</code>

	Mainly, the settings enable to configure the default cache directory used by ivy and the dependency resolvers that it will use to resolve dependencies.
	<div id="note">Note: To work, this settings file needs a property file named ivysettings-file.properties in the same directory as the settings file, with ivy variables you want in it.</div>
	If you want to have more details on this settings file we strongly recommend you to read the <a href="http://ant.apache.org/ivy/history/2.1.0-rc1/settings.html">reference documentation of settings file</a>

	EasyAnt uses two ivy instance :
	<ol>
	<li>used to resolve/retrieve EasyAnt modules (which can be buildtypes/ plugins or skeletons) dependencies</li>
	<li>used to resolve/retrieve project dependencies</li>
	</ol>
	There is a strong separation of context, this means that plugins dependencies will not be polluting your project.
	Both instance are configurable.
	<ul>
	<li>Project ivy instance can be configured through an ivysettings file defined through properties. Click <a href="ref/ProjectIvyInstance.html">here</a> if you want more details.</li>
	<li>EasyAnt ivy instance can be configured through an ivysettings file defined in easyant-config. Click <a href="ref/EasyAntconfigurationfile.html">here</a> if you want more details.</li>
	</ul>



	<h2>Project ivy instance</h2>
	The <a href="ProjectIvyInstance.html">project ivy instance</a> is in charge to configure ivy for your project (configure repositories used to retrieve your projects dependencies for example).

	<h2>EasyAnt ivy instance</h2>
	<a href="EasyAntivyinstance.html">EasyAnt ivy instance</a> is in charge to configure ivy for easyant internal use (configure repositories used to retrieve buildtypes/plugins/skeletons for example).

	</textarea>
	<script type="text/javascript">xooki.postProcess();</script>
	</body>
	</html>