You are viewing a plain text version of this content. The canonical link for it is here.
Posted to easyant-commits@incubator.apache.org by jl...@apache.org on 2012/10/05 20:27:01 UTC
svn commit: r1394786 - in /incubator/easyant/core/trunk/src/documentation:
faq.html ref/EasyAntconfigurationfile.html ref/EasyAntivyinstance.html
ref/Ivyconfiguration.html toc.json
Author: jlboudart
Date: Fri Oct 5 20:27:00 2012
New Revision: 1394786
URL: http://svn.apache.org/viewvc?rev=1394786&view=rev
Log:
Update ivy configuration documentation (for both easyant / project)
Added:
incubator/easyant/core/trunk/src/documentation/ref/EasyAntivyinstance.html
incubator/easyant/core/trunk/src/documentation/ref/Ivyconfiguration.html
Modified:
incubator/easyant/core/trunk/src/documentation/faq.html
incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html
incubator/easyant/core/trunk/src/documentation/toc.json
Modified: incubator/easyant/core/trunk/src/documentation/faq.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/faq.html?rev=1394786&r1=1394785&r2=1394786&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/faq.html (original)
+++ incubator/easyant/core/trunk/src/documentation/faq.html Fri Oct 5 20:27:00 2012
@@ -137,7 +137,7 @@ There is a strong separation of context,
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>
+ <li>EasyAnt ivy instance can be configured through an ivysettings file defined in easyant-config. Click <a href="ref/EasyAntivyinstance.html">here</a> if you want more details.</li>
</ul>
</textarea>
Modified: incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html?rev=1394786&r1=1394785&r2=1394786&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html (original)
+++ incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html Fri Oct 5 20:27:00 2012
@@ -47,7 +47,7 @@ The configuration file named easyant-con
</code>
<h2>Configuring easyant ivy instance</h2>
-By default, easyant ivy instance is configured to use a set of repositories based on your file system that are deployed with the easyant distribution. These repositories are supposed to be available online in a future release of easyant, and contain the build modules available to the user.
+By default, easyant ivy instance is configured to use a set of repositories based on your file system that are deployed with the easyant distribution.
Easyant ivy instance is not used to retrieve project dependencies.
If you want to configure the project ivy instance you should look at <a href="ref/ProjectIvyInstance.html">this page</a>.
@@ -82,50 +82,6 @@ or
</tbody>
</table>
-By default easyant ivy instance is configured to use the default ivysettings provided by easyant-core.jar.
-
-<h3>default ivy settings provided by easyant-core.jar</h3>
-You can reference this default ivysettings file through the property <i>easyant.default.ivysettings.url</i>.
-This file preconfigure :
-<ul>
- <li>easyant cache in $USER_HOME/.easyant/easyant-cache</li>
- <li>default repositories:
- <ul>
- <li><i>easyant-core-modules</i> shipped in easyant-core.jar</li>
- <li><i>easyant-shared-modules</i> pointing to "${user.home}/.easyant/repository/easyant-shared-modules" used to store users plugins/buildtypes</li>
- <li><i>public-maven</i> used to retrieved plugins/buildtypes dependencies</li>
- <li><i>easyant-default-chain</i> the default chain containing the 3 previous repositories</li>
- </ul>
- </li>
-</ul>
-
-<h3>Using easyant-extra-modules</h3>
-If you want to use easyant-extra-modules.jar (containing additional plugins/buildtypes) you can use the property <i>easyant.extra.ivysettings.url</i>.
-
-<h3>Extending the default configuration</h3>
-In an enterprise context it can make sense to configure a enteprise repository to store easyant plugins/ easyant skeletons etc...
-
-This can be done writting your own ivysettings including if necessary the default configuration :
-<code type="xml">
-<ivysettings>
- <!-- import the default ivy settings -->
- <include url="${easyant.default.ivysettings.url}"/>
- <!-- define your own default resolver, here a chain that include a new repo + the default chain provided by easyant -->
- <settings defaultResolver="my-chain"/>
- <resolvers>
- <filesystem name="my-custom-repo">
- <ivy pattern="/path/to/your/repo/[organisation]/[module]/ivy-[revision].xml"/>
- <artifact pattern="/path/to/your/repo/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/>
- </filesystem>
-
- <chain name="my-chain">
- <resolver ref="my-custom-repo" />
- <resolver ref="easyant-default-chain" />
- </chain>
- </resolvers>
-</ivysettings>
-</code>
-
<h2>Configuring system plugins</h2>
A system plugin can provide some additionnal functionnalities that can be used from everywhere.
To reference a set of plugins you can use the following syntax :
Added: incubator/easyant/core/trunk/src/documentation/ref/EasyAntivyinstance.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/EasyAntivyinstance.html?rev=1394786&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/EasyAntivyinstance.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/EasyAntivyinstance.html Fri Oct 5 20:27:00 2012
@@ -0,0 +1,113 @@
+<!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>EasyAnt ivy instance</h1>
+
+EasyAnt ivy instance is in charge to configure ivy for easyant internal use (configure repositories used to retrieve buildtypes/plugins/skeletons for example).
+
+By default easyant ivy instance is configured to use the default ivysettings provided by easyant-core.jar.
+
+<h2>Lookup mechanism</h2>
+
+To configure EasyAnt ivy instance use a lookup mechanism. It will:
+<ul>
+ <li>Check default user location <i>${user.home}/.easyant/easyant-ivysettings.xml</i> (this can be configured through a property see bellow)</li>
+ <li>if not found, check url or file specified in <a href="EasyAntconfigurationfile.html">EasyAnt configuration file</a></li>
+ <li>if not found, check in default global localtion <i>${easyant.home}/ivysettings.xml</i> (this can be configured through a property see bellow)</li>
+ <li>if not found, use the default one provided by easyant-core.jar</li>
+</ul>
+
+<h3>User location</h3>
+User default location can be configured through <i>user.easyant.ivysettings.file</i> property.
+
+Example :
+<code type="shell">
+> easyant -Duser.easyant.ivysettings.file=/path/to/ivysettings.xml
+</code>
+
+You can tell easyant to ignore user location by setting <i>ignore.user.ivysettings</i> property to true.
+
+Example :
+<code type="shell">
+> easyant -Dignore.user.ivysettings=true
+</code>
+
+<h3>Global location</h3>
+User default location can be configured through <i>global.easyant.ivysettings.file</i> property.
+
+<code type="shell">
+> easyant -Dglobal.easyant.ivysettings.file=/path/to/global/ivysettings.xml
+</code>
+
+<h2>default ivy settings provided by easyant-core.jar</h2>
+You can reference this default ivysettings file through the property <i>easyant.default.ivysettings.url</i>.
+This file preconfigure :
+<ul>
+ <li>easyant cache in $USER_HOME/.easyant/easyant-cache</li>
+ <li>default repositories:
+ <ul>
+ <li><i>easyant-core-modules</i> shipped in easyant-core.jar</li>
+ <li><i>easyant-shared-modules</i> pointing to "${user.home}/.easyant/repository/easyant-shared-modules" used to store users plugins/buildtypes</li>
+ <li><i>apache-easyant-plugins</i> our online repository</li>
+ <li><i>public-maven</i> used to retrieved plugins/buildtypes dependencies</li>
+ <li><i>easyant-default-chain</i> the default chain containing the 3 previous repositories</li>
+ </ul>
+ </li>
+</ul>
+
+<div id="note">
+apache-easyant-plugins repository base url is accessible through <i>apache.easyant.public.url</i> property.
+</div>
+
+<h2>Extending the default configuration</h2>
+In enterprise context it can make sense to configure an enteprise repository to store easyant plugins/ easyant skeletons etc...
+
+This can be done writting your own ivysettings including if necessary the default configuration :
+<code type="xml">
+<ivysettings>
+ <!-- import the default ivy settings -->
+ <include url="${easyant.default.ivysettings.url}"/>
+ <!-- define your own default resolver, here a chain that include a new repo + the default chain provided by easyant -->
+ <settings defaultResolver="my-chain"/>
+ <resolvers>
+ <filesystem name="my-custom-repo">
+ <ivy pattern="/path/to/your/repo/[organisation]/[module]/ivy-[revision].xml"/>
+ <artifact pattern="/path/to/your/repo/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/>
+ </filesystem>
+
+ <chain name="my-chain">
+ <resolver ref="my-custom-repo" />
+ <resolver ref="easyant-default-chain" />
+ </chain>
+ </resolvers>
+</ivysettings>
+</code>
+
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Added: incubator/easyant/core/trunk/src/documentation/ref/Ivyconfiguration.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/Ivyconfiguration.html?rev=1394786&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/Ivyconfiguration.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/Ivyconfiguration.html Fri Oct 5 20:27:00 2012
@@ -0,0 +1,77 @@
+<!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>
Modified: incubator/easyant/core/trunk/src/documentation/toc.json
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/toc.json?rev=1394786&r1=1394785&r2=1394786&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/toc.json (original)
+++ incubator/easyant/core/trunk/src/documentation/toc.json Fri Oct 5 20:27:00 2012
@@ -292,10 +292,23 @@
]
},
{
- "id":"ref/ProjectIvyInstance",
- "title":"Project Ivy Instance",
+ "id":"ref/Ivyconfiguration",
+ "title":"Ivy configuration",
"children": [
+ {
+ "id":"ref/EasyAntivyinstance",
+ "title":"EasyAnt ivy instance",
+ "children": [
+ ]
+ },
+ {
+ "id":"ref/ProjectIvyInstance",
+ "title":"Project Ivy Instance",
+ "children": [
+
+ ]
+ }
]
}
]