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/03 14:45:47 UTC

svn commit: r552858 - in /incubator/ivy/core/trunk/doc: doc/ivyfile/artifact-exclude.html doc/ivyfile/dependencies.html doc/ivyfile/exclude.html toc.json

Author: xavier
Date: Tue Jul  3 07:45:46 2007
New Revision: 552858

URL: http://svn.apache.org/viewvc?view=rev&rev=552858
Log:
add doc for IVY-431

Added:
    incubator/ivy/core/trunk/doc/doc/ivyfile/exclude.html   (with props)
Modified:
    incubator/ivy/core/trunk/doc/doc/ivyfile/artifact-exclude.html
    incubator/ivy/core/trunk/doc/doc/ivyfile/dependencies.html
    incubator/ivy/core/trunk/doc/toc.json

Modified: incubator/ivy/core/trunk/doc/doc/ivyfile/artifact-exclude.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/doc/ivyfile/artifact-exclude.html?view=diff&rev=552858&r1=552857&r2=552858
==============================================================================
--- incubator/ivy/core/trunk/doc/doc/ivyfile/artifact-exclude.html (original)
+++ incubator/ivy/core/trunk/doc/doc/ivyfile/artifact-exclude.html Tue Jul  3 07:45:46 2007
@@ -41,6 +41,8 @@
   <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>

Modified: incubator/ivy/core/trunk/doc/doc/ivyfile/dependencies.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/doc/ivyfile/dependencies.html?view=diff&rev=552858&r1=552857&r2=552858
==============================================================================
--- incubator/ivy/core/trunk/doc/doc/ivyfile/dependencies.html (original)
+++ incubator/ivy/core/trunk/doc/doc/ivyfile/dependencies.html Tue Jul  3 07:45:46 2007
@@ -30,7 +30,7 @@
 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 defines two very similar things: defaultconf and defaultconfmapping.
+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.
 
@@ -56,6 +56,8 @@
 </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>

Added: incubator/ivy/core/trunk/doc/doc/ivyfile/exclude.html
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/doc/ivyfile/exclude.html?view=auto&rev=552858
==============================================================================
--- incubator/ivy/core/trunk/doc/doc/ivyfile/exclude.html (added)
+++ incubator/ivy/core/trunk/doc/doc/ivyfile/exclude.html Tue Jul  3 07:45:46 2007
@@ -0,0 +1,60 @@
+<!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: 2};</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/dependencies.html">dependencies</a>
+
+<span class="since">since 2.0</span> This feature gives you more control on a dependency for which you do not control its ivy file. 
+It allows to exclude artifacts, modules or organizations from the list of dependencies for the whole module.
+
+It is very similar to the [[doc/ivyfile/artifact-exclude dependency exclude]] element, except that it applies to a whole module, which can be very useful when a lot of dependencies transitively bring a module you don't 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>org</td><td>the organization of the dependency module or artifact to exclude, or a regexp matching this organization</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</td>
+        <td>No, defaults to *</td></tr>
+    <tr><td>artifact</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</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></textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Propchange: incubator/ivy/core/trunk/doc/doc/ivyfile/exclude.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/ivy/core/trunk/doc/toc.json
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/doc/toc.json?view=diff&rev=552858&r1=552857&r2=552858
==============================================================================
--- incubator/ivy/core/trunk/doc/toc.json (original)
+++ incubator/ivy/core/trunk/doc/toc.json Tue Jul  3 07:45:46 2007
@@ -749,7 +749,15 @@
                                   ]
                               }
                             ]
-                        }
+                        },
+                        {
+                          "id":"doc/ivyfile/exclude",
+                          "title":"exclude",
+                          "children": [
+
+                            ]
+,
+                          "level":2                        }
                       ]
                   },
                   {