You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ivy-commits@incubator.apache.org by xa...@apache.org on 2007/07/04 15:41:57 UTC
svn commit: r553243 [3/8] - in /incubator/ivy/core/trunk/doc: ./
configuration/ configuration/macrodef/ configuration/namespace/ doc/
history/ ivyfile/ presentations/ resolver/ schemas/ test/ tutorial/
tutorial/build-repository/ use/
Modified: incubator/ivy/core/trunk/doc/index.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/index.html?view=diff&rev=553243&r1=553242&r2=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/index.html (original)
+++ incubator/ivy/core/trunk/doc/index.html Wed Jul 4 08:41:45 2007
@@ -20,26 +20,57 @@
<html>
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
- <script type="text/javascript">var xookiConfig = {level: 0, path: {template: "homeTemplate.html"}};</script>
+ <script type="text/javascript">var xookiConfig = {level: 0};</script>
<script type="text/javascript" src="xooki/xooki.js"></script>
</head>
<body>
<textarea id="xooki-source">
-<table border="0" class="home">
-<tr><td colspan="4"><img src="images/ivy-lierre.png"/></td></tr>
-<tr style="font-size:xx-large;"><td colspan="4"><span style="font-size:xx-large;">The agile dependency manager</span></td></tr>
-<tr><td colspan="4" style="font-size:large; padding: 1cm 0 0.7cm 0;">Ivy is a popular dependency manager focusing on flexibility and simplicity.<br/>
-Find out more about its unique <a href="features.html">enterprise features</a>, what <a href="testimonials.html">people say about it</a>,<br/>
-and <a href="doc.html">how it can improve your build system!</a></td></tr>
-<tr class="homeitems"><td><a href="download.html"><img src="images/ivy-dl-2.0.0-alpha-1.png"/></a></td><td><a href="doc.html"><img src="images/ivy-book.png"/></a></td><td><a href="demo.html"><img src="images/ivy-demo.png"/></a></td><td><a href="mailing-lists.html"><img src="images/ivy-forum.png"/></a></td></tr>
-<tr class="homeitems"><td><a href="download.html">download</a></td><td><a href="doc.html">documentation<br/>& tutorials</a></td><td><a href="demo.html">demo</a></td><td><a href="mailing-lists.html">share your experience</a></td></tr>
-</table>
-<hr/><a href="">Latest News</a><table border="0" cellpadding="5">
-<tr><td>05/03/2007</td><td><a href="presentations/apache-con-2007/">slides</a> from ApacheCon EU 2007 are available!</td></tr>
-<tr><td>04/26/2007</td><td>[[history/2.0.0-alpha-1]] version available</td></tr>
-<tr><td>03/28/2007</td><td> <a href="http://www.jetbrains.com/teamcity/features/newfeatures.html#TeamCity_Administration_Interface_Enhancements">TeamCity</a> integrates Ivy for dependent build management</td></tr>
-<tr><td>03/01/2007</td><td> New site menu and new look for the home page.<br/> [[mailing-lists Tell us]] what you think about it!</td></tr>
-</table></textarea>
+Welcome to the official Ivy documentation.
+
+<h1>What is Ivy?</h1>
+Ivy is a tool for managing (recording, tracking, resolving and reporting) project dependencies. It is characterized by the following:
+<ol>
+<li>flexibility and configurability - Ivy is essentially process agnostic and is not tied to any methodology or structure. Instead it provides the necessary flexibility and configurability to be adapted to a broad range of dependency management and build processes.</li>
+
+<li>tight integration with Apache Ant - while available as a standalone tool, Ivy works particularly well with Apache Ant providing a number of powerful Ant tasks ranging from dependency resolution to dependency reporting and publication.</li>
+</ol>
+Ivy is open source and released under a very permissive <a href="license.html">license</a>.
+Ivy has a lot of powerful [[features]], the most popular and useful being its flexibily, integration with ant, and its strong transitive dependencies management engine.
+The transitive dependencies management is a feature which let you get dependencies of your dependencies, transitively. In order to address this problematic ivy needs to find metadata about your modules, usually in an <a href="doc/ivyfile.html">ivy file</a>. To find these metadata and your dependencies artifacts (usually jars), Ivy can be configured to use a lot of different <a href="doc/configuration/resolvers.html">repositories</a>.
+
+<h1>About this doc</h1>
+This documentation has been migrated from the old Ivy web site hosted by Jayasoft, feel free to report any problem on the [[mailing-lists]].
+
+If you browse this documentation from your installation of ivy, you can also check the <a href="http://incubator.apache.org/ivy/doc.html">online version</a> for latest updates.
+
+You can also browse this documentation offline either by downloading the documentation distribution, or by checking out the doc directory from svn. This documentation uses <a href="http://xooki.sourceforge.net/">xooki</a> as documentation engine, so you can very easily [[get-involved edit it and submit patches]] when you browse it from source.
+
+The online version of this documentation is updated periodically, especially when new features are added during development. So if you find something documented here not available in your version of ivy, it may be because it is available only with the latest <a href="download.html">download</a>.
+
+If you want to view the whole documentation in a single printer-friendly page, please use the <a href="doc.html?action=print">printer-friendly link</a> at the bottom of any documentation page in the online documentation, and you will get a printer friendly version of the current page and all its sub pages.
+
+<h1>Other places to go</h1>
+Check Ivy <a href="features.html">features</a>.
+Read our <a href="faq.html">FAQ</a>.
+Ask for help on our <a href="mailing-lists.html">mailing lists</a>.
+Report bug or feature request in our <a href="issues.html">issue tracking system</a>.
+Check <a href="links.html">external tools and resources</a>.
+
+<h1>Overview</h1>
+This documentation is decomposed in 3 main parts:
+<ul>
+ <li><a href="doc/tutorial.html">Tutorials</a></li>
+The tutorials is the best way to begin to play with ivy. You will easily and quickly learn the basics of Ivy.
+ <li><a href="doc/reference.html">Reference</a></li>
+The reference documentation gives you all the details of Ivy.
+The introduction part is particularly useful: it defines some vocabulary, explains main concepts such as dependency resolvers and patterns, and give an overview on how ivy works internally.
+It's also in the reference doc that you will find all you always dreamed to know about ivy configuration, ivy files, and ivy use (especially with ant).
+ <li><a href="doc/appendix.html">Appendix</a></li>
+The appendix section contains a bunch of Ivy related information which is not part of Ivy reference doc.
+</ul>
+
+You will also find here interesting pages like [[doc/bestpractices]], the [[faq]] or the [[links]] pages.
+ </textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
</html>
Added: incubator/ivy/core/trunk/doc/install.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/install.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/install.html (added)
+++ incubator/ivy/core/trunk/doc/install.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,95 @@
+<!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: 0};</script>
+ <script type="text/javascript" src="xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+There are basically two way to install Ivy. Either manually or automatically.
+<h1>Manually</h1>
+Download the version you want <a href="../download.html">here</a>, unpack the downloaded zip file wherever you want, and copy the ivy jar file in your ant lib directory (ANT_HOME/lib).
+
+If you use ant 1.6.0 or superior, you can then simply go to the src/example/hello-ivy dir and run ant: if the build is successful, you have successfully installed Ivy !
+
+If you use ant 1.5.1 or superior, you have to modify the build files in the examples:
+- remove the namespace section at their head: xmlns:ivy="antlib:org.apache.ivy.ant"
+- add taskdefs for ivy tasks:
+<code>
+ <taskdef name="ivy-configure" classname="org.apache.ivy.ant.IvyConfigure"/>
+ <taskdef name="ivy-resolve" classname="org.apache.ivy.ant.IvyResolve"/>
+ <taskdef name="ivy-retrieve" classname="org.apache.ivy.ant.IvyRetrieve"/>
+ <taskdef name="ivy-publish" classname="org.apache.ivy.ant.IvyPublish"/>
+</code>
+- replace ivy:xxx tasks by ivy-xxx
+You can now run the build, if it is successful, you have successfully installed Ivy !
+
+If the build is not successful, check the <a href="../faq.html">FAQ</a> to see what can be the problem with the ivyrep resolver.
+
+<h2>Ivy dependendencies</h2>
+
+The latest binary version of Ivy, 2.0.0-alpha-1, doesn't include the optional dependencies. To download them using Ivy, all you need is to have Ant installed and follow these instructions:
+1. open a shell or command line in the directory where you unzipped your binary distribution, where you can find the ivy-2.0.0-alpha-1-incubating.jar
+2. copy <a href="../samples/build-install.xml">this build</a> script to the directory
+3. run the following command:
+<code>
+ant -f build-install.xml
+</code>
+4. That's all, you should now see the Ivy optional dependencies in the lib directory, organized per configuration (see the ivy.xml for details about the configurations and their use)
+
+<h1>Automatically</h1>
+If you want to use Ivy only in your ant build scripts, and have an internet connection when you build, you can download Ivy from this site and use the downloaded version automatically, using this simple build snippet:
+<code type="xml">
+ <property name="ivy.install.version" value="1.4-RC1" />
+
+ <condition property="ivy.home" value="${env.IVY_HOME}">
+ <isset property="env.IVY_HOME" />
+ </condition>
+ <property name="ivy.home" value="${user.home}/.ivy" />
+ <property name="ivy.jar.dir" value="${ivy.home}/jars" />
+ <property name="ivy.jar.file" value="${ivy.jar.dir}/ivy.jar" />
+
+ <target name="download-ivy" unless="offline">
+ <mkdir dir="${ivy.jar.dir}"/>
+ <!-- download Ivy from web site so that it can be used even without any special installation -->
+ <get src="http://www.jayasoft.org/downloads/ivy/${ivy.install.version}/ivy-${ivy.install.version}.jar"
+ dest="${ivy.jar.file}" usetimestamp="true"/>
+ </target>
+
+ <target name="init-ivy" depends="download-ivy">
+ <!-- try to load ivy here from ivy home, in case the user has not already dropped
+ it into ant's lib dir (note that the latter copy will always take precedence).
+ We will not fail as long as local lib dir exists (it may be empty) and
+ ivy is in at least one of ant's lib dir or the local lib dir. -->
+ <path id="ivy.lib.path">
+ <fileset dir="${ivy.jar.dir}" includes="*.jar"/>
+ </path>
+ <taskdef resource="org/apache/ivy/ant/antlib.xml"
+ uri="antlib:org.apache.ivy.ant" classpathref="ivy.lib.path"/>
+ </target>
+</code>
+
+Then the only thing to do is to add the init-ivy target in the depends attribute of your targets using Ivy, and add ivy namespace to your build script. See the self contained [[svn:src/example/go-ivy/build.xml go-ivy]] example for details about this.
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/install.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/intro.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/intro.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/intro.html (added)
+++ incubator/ivy/core/trunk/doc/intro.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,61 @@
+<!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: 0};</script>
+ <script type="text/javascript" src="xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+Welcome to Ivy reference documentation!
+
+If you don't know Ivy at all, give a glance at its <a href="../features.html">features</a>, the <a href="../faq.html">FAQ</a> and the <a href="../doc/tutorial.html">tutorials</a> before digging into this reference documentation.
+
+<h1>Reference Overview</h1>
+This documentation is decomposed in several parts:
+<ul>
+<li>Introduction</li>
+<ul>
+<li><a href="../doc/terminology.html">Terminology</a></li>
+This part gives you the meaning of some words used all over ivy doc, such as organisation, module, configurations, settings, ...
+<li><a href="../doc/concept.html">Main Concepts</a></li>
+This part introduces the main concepts used in Ivy: dependency resolvers, variables, patterns, and also a good introduction to a central ivy concept: module configurations.
+<li><a href="../doc/principle.html">How does it work ?</a></li>
+As the title suggest, here you will have some explanations on how does ivy work internally, which can help to better understand and customize its use.
+<li><a href="../doc/install.html">Installation</a></li>
+This part describe how to install Ivy
+</ul>
+<li><a href="../doc/configuration.html">Settings</a></li>
+This part is dedicated to the specification of the settings file of Ivy (usually called ivysettings.xml). It also gives the list of built-in dependency resolvers available in ivy.
+<li><a href="../doc/ivyfile.html">Ivy files</a></li>
+This part is the reference of the specification of the ivy files, the files in which you describe your dependencies. If you have any question of what can be done or not in an ivy file, you will have the answer here.
+<li><a href="../doc/ant.html">Use from ant</a></li>
+This part describes how to use ivy from ant. It's in this section that all ant tasks brought by ivy are specified.
+<li><a href="../doc/ant.html">Use standalone</a></li>
+Even if Ivy is most often used from ant, it can also be used from the command line. This page describes how you can do it.
+<li><a href="../doc/extend.html">Extend</a></li>
+This part describes how to extend ivy, by writing your own dependency resolver, latest strategy, etc.
+</ul>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/intro.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,126 @@
+<!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: 0};</script>
+ <script type="text/javascript" src="xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+Ivy use is entirely based on what is called ivy files. Ivy files are xml files, usually called ivy.xml, containing the description of the dependencies of a module, its published artifacts and its configurations.
+
+Here is the simplest ivy file you can write:
+<code type="xml">
+<ivy-module version="1.3">
+ <info organisation="myorg"
+ module="mymodule"
+ />
+</ivy-module>
+</code>
+
+Since version 0.8, ivy publishes an xslt which help make ivy files more readable. You just have to add
+a line like this one in your ivy file:
+<code>
+<?xml-stylesheet type="text/xsl" href="http://www.ivyrep.org/ivy-doc.xsl"?>
+</code>
+However, all information is not presented with the xslt (dependency configurations, in particular).
+And due to security issues, it only works if the ivy file is in the same domain as the xsl... But they are particularly useful to browse the <a href="http://www.ivyrep.org/">ivy repository</a>.
+
+If you want to see a sample file using almost all possibilities of ivy files, check this one, <a href="../samples/ivy-sample-xslt.xml">with</a> or <a href="../samples/ivy-sample.xml">without</a> xslt.
+
+Before beginning the reference itself, it is required to have in mind the terminology defined in the <a href="../doc/reference.html">main page</a> of this reference documentation.
+
+For those familiar with xml schema, the schema used to validate ivy files can be found <a href="../schemas/ivy.xsd">here</a>. For those using xsd aware IDE, you can declare the xsd in your ivy files to benefit from code completion / validation:
+<code type="xml">
+<?xml version="1.0" encoding="UTF-8"?>
+<ivy-module version="1.3"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:noNamespaceSchemaLocation=
+ "http://incubator.apache.org/ivy/schemas/ivy.xsd">
+ <info organisation="myorg"
+ module="mymodule"
+ />
+</ivy-module>
+</code>
+
+<h1>Hierarchical Index</h1>
+<pre>
+ivy-module
+ <a href="../doc/ivyfile/info.html">info</a>
+ <a href="../doc/ivyfile/license.html">license</a>
+ <a href="../doc/ivyfile/ivyauthor.html">ivyauthor</a>
+ <a href="../doc/ivyfile/repository.html">repository</a>
+ <a href="../doc/ivyfile/description.html">description</a>
+ <a href="../doc/ivyfile/configurations.html">configurations</a>
+ <a href="../doc/ivyfile/conf.html">conf</a>
+ <a href="../doc/ivyfile/publications.html">publications</a>
+ <a href="../doc/ivyfile/artifact.html">artifact</a>
+ <a href="../doc/ivyfile/artifact-conf.html">conf</a>
+ <a href="../doc/ivyfile/dependencies.html">dependencies</a>
+ <a href="../doc/ivyfile/dependency.html">dependency</a>
+ <a href="../doc/ivyfile/dependency-conf.html">conf</a>
+ <a href="../doc/ivyfile/mapped.html">mapped</a>
+ <a href="../doc/ivyfile/dependency-artifact.html">artifact</a>
+ <a href="../doc/ivyfile/dependency-artifact-conf.html">conf</a>
+ <a href="../doc/ivyfile/dependency-artifact.html">include</a>
+ <a href="../doc/ivyfile/dependency-artifact-conf.html">conf</a>
+ <a href="../doc/ivyfile/artifact-exclude.html">exclude</a>
+ <a href="../doc/ivyfile/artifact-exclude-conf.html">conf</a>
+ <a href="../doc/ivyfile/conflicts.html">conflicts</a>
+ <a href="../doc/ivyfile/manager.html">manager</a>
+</pre>
+
+<h1>ivy-module</h1>
+<b>Tag:</b> ivy-module
+
+Root tag of any ivy-file.
+<h2>Attributes</h2>
+<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>version</td><td>the version of the ivy file specification - should be '1.3' with current version of ivy</td>
+ <td>Yes</td></tr>
+</tbody>
+</table>
+<h2>Child elements</h2>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td>info</td><td>contains information about the described module</td>
+ <td>1</td></tr>
+ <tr><td>configurations</td><td>container for configuration elements</td>
+ <td>0..1</td></tr>
+ <tr><td>publications</td><td>container for published artifact elements</td>
+ <td>0..1</td></tr>
+ <tr><td>dependencies</td><td>container for dependency elements</td>
+ <td>0..1</td></tr>
+ <tr><td>conflicts</td><td>section to configure the conflict managers to use</td>
+ <td>0..1</td></tr>
+</tbody>
+</table>
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/artifact-conf.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/artifact-conf.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/artifact-conf.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/artifact-conf.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,46 @@
+<!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">
+<b>Tag:</b> conf <b>Parent:</b> <a href="../../doc/ivyfile/artifact.html">artifact</a><br/>
+<br/>
+Indicates a public configuration in which enclosing artifact is published.
+<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>name</td><td>the name of the module public configuration in which this artifact is published.
+ '*' wildcard can be used to designate all public configurations of this module</td>
+ <td>Yes</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/artifact-conf.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude-conf.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude-conf.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude-conf.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude-conf.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,46 @@
+<!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">
+<b>Tag:</b> conf <b>Parent:</b> <a href="../../doc/ivyfile/artifact-exclude.html">artifact</a><br/>
+<br/>
+Specify a configuration in which the enclosing artifact exclusion should be included.
+
+<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>name</td><td>the name of the master configuration in which the enclosing artifact should be excluded</td>
+ <td>Yes</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude-conf.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,83 @@
+<!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">
+<b>Tag:</b> exclude <b>Parent:</b> <a href="../../doc/ivyfile/dependency.html">dependency</a>
+
+This feature gives you more control on a dependency for which you do not control its ivy file.
+It enables to restrict the artifacts required, by excluding artifacts being published by the dependency or any of its transitive dependencies,
+even if configuration does not a good separation of published artifacts
+
+The same principle concerning configuration as for include applies to this exclude feature (see above the include feature).
+
+Note that exclusion is always done AFTER inclusion has been done.
+
+<span class="since">since 1.3</span> This exclude feature can also be used not only to exclude artifacts but also to exclude whole modules. Indeed when you exclude artifacts, it doesn't avoid ivy to search for the module itself, and to resolve the dependencies of the module. But you can also exclude the whole module, which means that the module will not be downloaded at all, and so its own dependencies will not be resolved. For sure, this is usually done to exclude not a direct dependency but an indirect one. To exclude a whole module, you just have to not specify any artifact name, type and ext in your exclude rule. For instance:
+<code type="xml">
+<dependency name="A" rev="1.0">
+ <exclude module="B"/>
+</dependency>
+</code>
+
+<span class="since">since 2.0</span> A [[doc/ivyfile/exclude module wide exclude]] can also be used to exclude dependencies for the whole module (and not only in the context of one dependency as it is the case here).
+<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>org</td><td>the organisation of the dependency module or artifact to exclude, or a regexp matching this organisation <span class="since">since 1.3</span></td>
+ <td>No, defaults to *</td></tr>
+ <tr><td>module</td><td>the name of the dependency module or the artifact to exclude, or a regexp matching this module name <span class="since">since 1.3</span></td>
+ <td>No, defaults to *</td></tr>
+ <tr><td>name</td><td>the name of an artifact of the dependency module to add to the exclude list, or an expression matching this name (see matcher attribute below)</td>
+ <td>No, defaults to *</td></tr>
+ <tr><td>type</td><td>the type of the artifact of the dependency module to add to the exclude list, or a regexp matching this name</td>
+ <td>No, defaults to *</td></tr>
+ <tr><td>ext</td><td>the extension of the artifact of the dependency module to add to the exclude list, or an expression matching this name (see matcher attribute below)</td>
+ <td>No, defaults to type</td></tr>
+ <tr><td>matcher</td><td>the <a href="../concept.html#matcher">matcher</a> to use to match the modules to excludes <span class="since">since 1.3</span></td>
+ <td>No, defaults to exactOrRegexp in pre 1.3 ivy files, and exact in 1.3 and superior</td></tr>
+ <tr><td>conf</td><td>comma separated list of the master configurations in which this artifact should be included.
+ '*' wildcard can be used to designate all configurations of this module</td>
+ <td>No, defaults to '*', unless nested conf are specified</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td><a href="../../doc/ivyfile/artifact-exclude-conf.html">conf</a></td><td>configuration in which the artifact should be included</td>
+ <td>0..n</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/artifact-exclude.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/artifact.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/artifact.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/artifact.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/artifact.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,94 @@
+<!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">
+<b>Tag:</b> artifact <b>Parent:</b> <a href="../../doc/ivyfile/publications.html">publications</a>
+
+Declares an artifact published by this module. This is especially useful for other modules dependending on this one. They thus get all published artifacts belonging to the configurations asked. Indeed, each published artifact declares in which public configuration it is published. Thus a module depending on this module only get artifacts marked with the asked configurations, taking into account configurations extension (see <a href="../../doc/ivyfile/conf.html">configuration declaration</a>).
+
+The configurations in which an artifact is published can be configured in two ways:
+<ul>
+<li>conf attribute on artifact element</li>
+<li>conf subelement</li>
+</ul>
+The twos are equivalent, it is only a matter of preference. However, do not mix both for one artifact.
+
+<span class="since">since 1.4</span> The artifact element as default values for all its attributes, so if you want to declare a default artifact you can just declare it like that:<code type="xml">
+<artifact />
+</code>If this is the only artifact declared, then it's equivalent to having no publication section at all.
+
+<span class="since">since 1.4</span> It is possible to give a url at which artifacts can be found. This is not mandatory, and even not recommended. This is only a convenient way to deal with an existing repository with a bad layout, but should not be avoided in an enterprise repository.
+
+<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>name</td><td>the name of the published artifact. This name must not include revision.</td>
+ <td>No, defaults to the name of the module</td></tr>
+ <tr><td>type</td><td>the type of the published artifact. It's usually its extension, but not necessarily. For instance, ivy files are of type 'ivy' but have 'xml' extension</td>
+ <td>No, defaults to jar</td></tr>
+ <tr><td>ext</td><td>the extension of the published artifact</td>
+ <td>No, defaults to type</td></tr>
+ <tr><td>conf</td><td>comma separated list of public configurations in which this artifact is published.
+ '*' wildcard can be used to designate all public configurations of this module</td>
+ <td>No, defaults to '*' if neither conf attribute nor conf children element is given</td></tr>
+ <tr><td>url</td><td>a url at which this artifact can be found if it isn't located at the standard location in the repository <span class="since">since 1.4</span></td>
+ <td>No, defaults to no url</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td><a href="../../doc/ivyfile/artifact-conf.html">conf</a></td><td>indicates a public configuration in which this artifact is published</td>
+ <td>0..n</td></tr>
+</tbody>
+</table>
+<h1>Examples</h1>
+<code type="xml">
+<artifact />
+</code>
+Declares an artifact with the name of the module as name, type and ext jar, and published in all configurations.
+
+<hr />
+<code type="xml">
+<artifact name="foo-src" type="source" ext="zip" conf="src" />
+</code>
+Declares an artifact foo-src, of type 'source' with extension 'zip', and published in the src configuration.
+
+<hr />
+<code type="xml">
+<artifact name="foo" url="http://www.acme.com/repository/barbaz/foo-1.2-bar.jar" />
+</code>
+Declares an artifact foo, of type and extension 'jar' located at the url http://www.acme.com/repository/barbaz/foo-1.2-bar.jar. This url will only be used if the artifact cannot be found at its standard location.
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/artifact.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/conf.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/conf.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/conf.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/conf.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,86 @@
+<!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">
+<b>Tag:</b> conf <b>Parent:</b> <a href="../../doc/ivyfile/configurations.html">configurations</a>
+
+Declares a configuration of this module. As described in the reference page, a configuration is a way to use or construct a module. Some modules may be used in different ways (think about hibernate which can be used inside or outside an application server), and this way may alter the artifacts you need (in the case of hibernate, jta.jar is needed only if it is used outside an application server). Moreover, a module may need some other modules and artifacts only at build time, and some others at runtime. All those differents ways to use or build a module are called in ivy configurations.
+
+The conf element in the configurations section declares one configuration. This declaration gives the name of the configuration declared, its visibility and the other configurations of the module it extends.
+
+Visibility is used to indicate whether or not a configuration can be used from other modules depending on this one. Thus a private configuration is only used for internal purpose (maybe at build time), and other modules cannot declare to depend on it.
+
+A configuration can also extend one or several other ones of the same module. When a configuration extends another one, then all artifacts required in the extended configuration will also be required in the configuration that extends the other one. For instance, if configuration B extends configuration A, and if artifacts art1 and art2 are required in configuration A, then they will be automatically required in configuration B. On the other hand, artifacts required in configuration B are not necessarily required in configuration A.
+
+This notion is very helpful to define configurations which are similar with some differences.
+
+<span class="since">since 1.4</span> The extends attribute can use the following wildcards:<table class="ivy-attributes">
+<tr><td>*</td><td>all other configurations</td></tr>
+<tr><td>*(public)</td><td>all other public configurations</td></tr>
+<tr><td>*(private)</td><td>all other private configurations</td></tr>
+</table>
+<br/>
+
+<span class="since">since 1.4</span> A whole configuration can be declared as non transitive, so that all dependencies resolved in this configuration will be resolved with transitivity disabled. Note that the transitivity is disabled for all the configuration dependencies (including those obtained because this conf extends other ones), and only for this configuration (which means that a conf extending this one with transitivityy enabled will get transitive dependencies even for dependencies being part of the non transitive configuration).
+This is very useful to build a compile configuration, for instance, forcing the dependency declaration on each direct dependency, with no risk to forget some because of transitivity.
+
+<span class="since">since 1.4</span> This tag supports <a href="../../doc/concept#extra.html">extra attributes</a>.
+<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>name</td><td>the name of the declared configuration</td>
+ <td>Yes</td></tr>
+ <tr><td>description</td><td>a description for the declared configuration</td>
+ <td>No</td></tr>
+ <tr><td>visibility</td><td>the visibility of the declared configuration.
+ 'public' means that this configuration can be used by other modules, while 'private' means that this configuration is used only in the module itself, and is not exposed to other modules</td>
+ <td>No, defaults to public</td></tr>
+ <tr><td>extends</td><td>a comma separated list of configurations of this module that the
+ current configuration extends</td>
+ <td>No, defaults to none</td></tr>
+ <tr><td>transitive</td><td>a boolean to indicate if this conf is transitive or not <span class="since">since 1.4</span></td>
+ <td>No, defaults to true</td></tr>
+ <tr><td>deprecated</td><td>indicates that this conf has been deprecated by giving the date of the deprecation.
+ It should be given in this format: yyyyMMddHHmmss</td>
+ <td>No, by default the conf is not deprecated</td></tr>
+</tbody>
+</table>
+
+<h1>Examples</h1>
+<code type="xml">
+<conf name="core" visibility="private" />
+<conf name="compile" extends="core" transitive="false" visibility="private" />
+<conf name="runtime" extends="compile" description="everything needed to run this module" />
+</code>
+Declares three configurations, core compile and runtime, with only the runtime one accessible from other modules, and with the compile one being non transitive.
+Therefore the core configuration will only be composed of dependencies declared in the core configuration itself, the compile configuration will be composed of all dependencies required in either core or compile configuration, but without transivity (neither for core nor compile dependencies), and runtime will be composed of all dependencies, all transitively, including the dependencies declared only in compile.
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/conf.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/configurations.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/configurations.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/configurations.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/configurations.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,92 @@
+<!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">
+<b>Tag:</b> configurations <b>Parent:</b> <a href="../../doc/ivyfile.html">ivy-module</a>
+
+Container for configuration element. If this container is not present, it is assumed that the module has one public configuration called 'default'.
+
+<span class="since">since 1.3</span> You can define a new default conf mapping on this container by specifying the defaultconfmapping attribute.
+
+A default conf mapping is very similar to the defaultconf which can be set on the dependencies tag, but it has a slightly different behaviour.
+The default conf mapping not only defines the conf mapping to use when no conf mapping is specified for a dependency in this ivy file, but it also modify the way ivy interprets conf mapping with no mapped conf. In this case, Ivy will look in the default conf mapping and use the conf mapping defined in the default conf mapping for the conf for which there is no mapped conf.
+
+See <a href="../../doc/ivyfile/dependency#defaultconfmapping.html">examples on the dependency</a> page.
+
+<span class="since">since 1.4</span> You can activate a confmappingoverride mode for all configurations, in which case the extending configurations will override the mappings of the configurations they extend from.
+
+
+<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>defaultconfmapping</td><td>the default conf mapping to use in this ivy file <span class="since">since 1.3</span></td>
+ <td>No, defaults to no default conf mapping</td></tr>
+ <tr><td>confmappingoverride</td><td>true to activate configuration mapping override, false otherwise <span class="since">since 1.4</span></td>
+ <td>No, defaults to false</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td><a href="../../doc/ivyfile/conf.html">conf</a></td><td>declares a configuration of this module</td>
+ <td>0..n</td></tr>
+ <tr><td><a href="../../doc/ivyfile/include.html">include</a></td><td>include configurations from another file</td>
+ <td>0..n</td></tr>
+</tbody>
+</table>
+
+<h1>Configuration mappings details</h1>
+When Ivy parses your Ivy file, it will create (internally) modify the configuration mapping of your dependencies.
+For instance, say you have:
+<code type="xml">
+<configurations defaultconfmapping="conf1->other1;conf2->other2">
+ <conf name="conf1" />
+ <conf name="conf2" extends="conf1" />
+</configurations>
+<dependencies>
+ <dependency name="other-module" conf="conf1" />
+</dependencies>
+</code>
+When Ivy parses this file, it will construct the following dependency (in-memory only):
+<code type="xml"><dependency name="other-module" conf="conf1->other1" /></code>
+
+So, if you now resolve the conf2 configuration, you will only get the other1 dependencies of your other-module.
+
+But when you set confmappingoverride to true, Ivy will construct the following dependency in memory:
+<code type="xml"><dependency name="other-module" conf="conf1->other1;conf2->other2" /></code>
+As you can see, the defaultmappings of the extending configurations are also added (although you didn't explicitly defined them)
+
+When you now resolve the conf2 configuration, you'll get the other2 dependencies of your other-module.
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/configurations.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/conflicts.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/conflicts.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/conflicts.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/conflicts.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,67 @@
+<!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">
+<b>Tag:</b> conflicts <b>Parent:</b> <a href="../../doc/ivyfile/ivy-module.html">ivy-module</a><br/><br/>
+
+Container for conflict manager elements, used to indicate how conflicts should be resolved
+for this module. <br/><br/>
+
+The list of built-in conflict managers available is listed on the <a href="../../doc/configuration/conflict-managers.html">conflict manager configuration page</a>.<br/><br/>
+
+Conflicts manager are used during the resolve operation, i.e. when ivy analyse the graph of dependencies
+and download corresponding ivy files and artifacts. The fact to manage conflict at resolve time
+enables to minimize downloads: when a module is evicted by a conflict manager, it is not downloaded.<br/><br/>
+
+There are two things optimized during conflict resolution: download of artifacts and download
+of ivy files. The first is always ensured by ivy, i.e. artifacts of a module evicted will never
+be downloaded. The second is not as simple to handle because to know what are the conflicts
+ivy needs to know the dependency graph, and to know the dependency graph, it has to download
+ivy files. But ivy is highly optimized on this too, and it tries to evict modules as soon as possible.<br/>
+That's why the order of dependencies is important for download optimization. Indeed ivy
+traverses the dependency graph in the order in which dependencies are declared in the ivy files,
+and each time it encounters a dependency on a module, it first check if there is a conflict on this module,
+and if this is the case, it asks the conflict manager to resolve the conflict. Then if the module is evicted,
+it does not download its ivy file, and the whole branch is not traversed, which can saves
+a lot of time.<br/><br/>
+
+If this container is not present, a default conflict manager is used for all modules.
+The current default conflict manager is the "latest-revision" conflict manager.
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td><a href="../../doc/ivyfile/manager.html">manager</a></td><td>declares a conflict manager for this module</td>
+ <td>1..n</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/conflicts.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/dependencies.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/dependencies.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/dependencies.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/dependencies.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,68 @@
+<!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">
+<b>Tag:</b> dependencies <b>Parent:</b> <a href="../../doc/ivyfile/.html">ivy-module</a>
+
+Container for dependency elements, used to describe the dependencies of this module.
+If this container is not present, it is assumed that the module has no dependency at all.
+
+This container let the possibility to define two very similar things: defaultconf and defaultconfmapping.
+
+<code>defaultconf</code> exists since Ivy 1.1 and enables to define the default conf attribute to use when no conf is defined for a dependency in this ivy file. It is only used when no conf mapping is defined, and has no influence in other cases.
+
+<code>defaultconfmapping</code> exists since Ivy 1.3 and enables not only to define the default conf mapping when no conf is specified for a dependency in this ivy file, but it also influence the way conf mapping with no mapped conf are interpreted (see <a href="../../doc/ivyfile/configurations.html">configurations doc page</a> for details about this).
+
+Note that if both defaultconf and defaultconfmapping are defined, it's the defaultconfmapping that is used. Note also that if several defaultconfmapping are defined (one in the configurations tag, one or several in included configurations file, and/or one in the dependency tag, then it's only the last which is taken into account, the others will have no effect at all.
+<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>defaultconf</td><td>the default configuration to use when none is specified in a dependency. <span class="since">since 1.1</span></em></td>
+ <td>No, defaults to *->*</td></tr>
+ <tr><td>defaultconfmapping</td><td>the default configuration mapping to use in this ivy file. <span class="since">since 1.3</span></em></td>
+ <td>No, defaults to no default conf mapping</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td><a href="../../doc/ivyfile/dependency.html">dependency</a></td><td>declares a dependency for this module</td>
+ <td>0..n</td></tr>
+ <tr><td><a href="../../doc/ivyfile/exclude.html">exclude</a></td><td>excludes artifacts, modules or whole organizations from the set of dependencies of this module <span class="since">since 2.0</span></td>
+ <td>0..n</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/dependencies.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact-conf.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact-conf.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact-conf.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact-conf.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,46 @@
+<!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">
+<b>Tag:</b> conf <b>Parent:</b> <a href="../../doc/ivyfile/dependency-artifact.html">artifact</a>
+
+Specify a configuration in which the enclosing artifact specification should be included.
+
+<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>name</td><td>the name of the master configuration in which the enclosing artifact should be included</td>
+ <td>Yes</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact-conf.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,107 @@
+<!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">
+<b>Tag:</b> artifact <b>Parent:</b> <a href="../../doc/ivyfile/dependency.html">dependency</a>
+
+This feature gives you more control on a dependency for which you do not control its ivy file.
+It enables to specify the artifacts required, if the dependency has no ivy file.
+
+Indeed, when a module has no ivy file, it is assumed that it publishes exactly one artifact having the same name as the module itself. But when this module publishes more artifacts, or simply does not respect the name rule, and if you cannot deliver an ivy file for it (because you do not control the repository, for instance - think about maven ibiblio repository, to give no name), then this feature let you specify the artifacts names you want to get.
+
+Each artifact specification can be given in the context of particular master configurations. By default, if no configuration is specified, artifacts specification apply to all master configurations. But you can specify that a specification applies only to one or several master configurations, using either inline or nested conf specification. In this case, do not forget that if you do not specify any specification for a particular configuration, then no specification will apply for this configuration and it will be resolved not taking into account any specification.
+
+For instance, imagine you have A, B & C master configurations. If you specify art1 in A & B and art2 in A, then C will not be specified at all, and will thus assume the default artifact. To prevent this, you have to specify a configuration mapping for the dependency, mapping only A & B to some or all dependency configurations.
+
+Example:
+<code type="xml">
+<dependency org="yourorg" name="yourmodule9" rev="9.1" conf="A,B->default">
+ <artifact name="art1" type="jar" conf="A,B"/>
+ <artifact name="art2" type="jar" conf="A"/>
+</dependency>
+</code>
+
+<span class="since">since 1.4</span> It's possible to indicate the url at which the artifact can be found. This is not mandatory, and even not recommended with an enterprise repository. Note that Ivy will always look at the location where the artifact should be and only use the url if it cannot be found at the standard location in the repository.
+
+<span class="since">since 2.0</span> This feature can also be used for modules having their own module descriptor, but which doesn't declare an artifact you know that is published. Note that in this case artifacts declared to be published by the dependency will be ignored, so do not forget to include all artifacts you want.
+
+<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>name</td><td>the name of an artifact of the dependency module</td>
+ <td>Yes</td></tr>
+ <tr><td>type</td><td>the type of the artifact of the dependency module</td>
+ <td>Yes</td></tr>
+ <tr><td>ext</td><td>the extension of the artifact of the dependency module</td>
+ <td>No, defaults to type</td></tr>
+ <tr><td>conf</td><td>comma separated list of the master configurations in which this artifact should be included.
+ '*' wildcard can be used to designate all configurations of this module</td>
+ <td>No, defaults to '*', unless nested conf are specified</td></tr>
+ <tr><td>url</td><td>an url where this artifact can be found if it isn't present at the standard location in the repository <span class="since">since 1.4</span></td>
+ <td>No, defaults to no url</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td><a href="../../doc/ivyfile/dependency-artifact-conf.html">conf</a></td><td>configuration in which the artifact should be included</td>
+ <td>0..n</td></tr>
+</tbody>
+</table>
+<h1>Examples</h1>
+<code type="xml">
+<dependency org="foo" name="bar" rev="1.0">
+ <artifact name="baz" type="jar"/>
+</dependency>
+</code>
+Declares a dependency on module bar which only publish one artifact: baz.jar.
+
+<hr/>
+<code type="xml">
+<dependency org="foo" name="bar" rev="1.0">
+ <artifact name="baz" type="jar" url="http://www.acme.com/repository/bar/baz-1.0-acme.jar"/>
+</dependency>
+</code>
+Same as above, except that if the artifact is not found at its standard location, Ivy will use http://www.acme.com/repository/bar/baz-1.0-acme.jar to download it.
+
+<hr/>
+<code type="xml">
+<dependency org="foo" name="bar" rev="1.0">
+ <include name="*"/>
+ <artifact name="baz" type="source" ext="jar"/>
+</dependency>
+</code>
+Declares a dependency on module bar for which all artifacts declared will be used (thanks to the include tag) plus an artifact baz of type source and ext jar (which is not declared in module bar module descriptor).
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/dependency-artifact.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/dependency-conf.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/dependency-conf.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/dependency-conf.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/dependency-conf.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,61 @@
+<!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">
+<b>Tag:</b> conf <b>Parent:</b> <a href="../../doc/ivyfile/dependency.html">dependency</a><br/>
+<br/>
+Describes a configuration mapping for a dependency. See also the inline configuration mapping
+in dependency element.
+
+<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>name</td><td>the name of the master configuration to map.
+ '*' wildcard can be used to designate all configurations of this module</td>
+ <td>Yes</td></tr>
+ <tr><td>mapped</td><td>a comma separated list of dependency configurations to which this
+ master configuration should be mapped</td>
+ <td>No, default to the same configuration as master one, unless nested mapped elements are specified</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td><a href="../../doc/ivyfile/mapped.html">mapped</a></td><td>map dependency configurations for this master configuration</td>
+ <td>0..n</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/dependency-conf.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/dependency-include-conf.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/dependency-include-conf.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/dependency-include-conf.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/dependency-include-conf.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,46 @@
+<!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">
+<b>Tag:</b> conf <b>Parent:</b> <a href="../../doc/ivyfile/dependency-include.html">include</a>
+
+Specify a configuration in which the enclosing artifact inclusion should be included.
+
+<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>name</td><td>the name of the master configuration in which the enclosing artifact should be included</td>
+ <td>Yes</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/dependency-include-conf.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: incubator/ivy/core/trunk/doc/ivyfile/dependency-include.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/ivyfile/dependency-include.html?view=auto&rev=553243
==============================================================================
--- incubator/ivy/core/trunk/doc/ivyfile/dependency-include.html (added)
+++ incubator/ivy/core/trunk/doc/ivyfile/dependency-include.html Wed Jul 4 08:41:45 2007
@@ -0,0 +1,78 @@
+<!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">
+<b>Tag:</b> include <b>Parent:</b> <a href="../../doc/ivyfile/dependency.html">dependency</a>
+
+This feature gives you more control on a dependency for which you do not control its ivy file.
+It enables to restrict the artifacts required by including only the artifacts given here, even if configuration does not a good separation of published artifacts.
+
+Each artifact restriction can be given in the context of particular master configurations. By default, if no configuration is specified, artifacts restriction apply to all master configurations. But you can specify that a restriction applies only to one or several master configurations, using either inline or nested conf specification. In this case, do not forget that if you do not specify any restriction for a particular configuration, then no restriction will apply for this configuration and it will be resolved not taking into account any restriction.
+
+For instance, imagine you have A, B & C master configurations. If you restrict to art1 in A & B and art2 in A, then C will not be restricted at all, and will thus get all artifacts of all dependency configurations if you do not specify a configuration mapping. To prevent this, you have to specify a configuration mapping for the dependency, mapping only A & B to some or all dependency configurations.
+
+Example:
+<code type="xml">
+<dependency org="yourorg" name="yourmodule9" rev="9.1" conf="A,B->default">
+ <include name="art1" type="jar" conf="A,B"/>
+ <include name="art2" type="jar" conf="A"/>
+</dependency>
+</code>
+
+<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>name</td><td>the name of an artifact of the dependency module to add to the include list, or an expression matching this name (see matcher attribute below)</td>
+ <td>No, defaults to .*</td></tr>
+ <tr><td>type</td><td>the type of the artifact of the dependency module to add to the include list, or an expression matching this name (see matcher attribute below)</td>
+ <td>No, defaults to .*</td></tr>
+ <tr><td>ext</td><td>the extension of the artifact of the dependency module to add to the include list, or an expression matching this name (see matcher attribute below)</td>
+ <td>No, defaults to type</td></tr>
+ <tr><td>matcher</td><td>the <a href="../concept.html#matcher">matcher</a> to use to match the modules to include <span class="since">since 2.0</span></td>
+ <td>No, defaults to exactOrRegexp in pre 1.3 ivy files, and exact in 1.3 and superior</td></tr>
+ <tr><td>conf</td><td>comma separated list of the master configurations in which this artifact should be included.
+ '*' wildcard can be used to designate all configurations of this module</td>
+ <td>No, defaults to '*', unless nested conf are specified</td></tr>
+</tbody>
+</table>
+<h1>Child elements</h1>
+<table class="ivy-children">
+<thead>
+ <tr><th class="ivy-chld">Element</th><th class="ivy-chld-desc">Description</th><th class="ivy-chld-card">Cardinality</th></tr>
+</thead>
+<tbody>
+ <tr><td><a href="../../doc/ivyfile/dependency-include-conf.html">conf</a></td><td>configuration in which the artifact should be included</td>
+ <td>0..n</td></tr>
+</tbody>
+</table>
+
+ </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/ivy/core/trunk/doc/ivyfile/dependency-include.html
------------------------------------------------------------------------------
svn:eol-style = native