http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/namespace/fromtosystem.html ---------------------------------------------------------------------- diff --git a/doc/settings/namespace/fromtosystem.html b/doc/settings/namespace/fromtosystem.html deleted file mode 100644 index 11ee113..0000000 --- a/doc/settings/namespace/fromtosystem.html +++ /dev/null @@ -1,46 +0,0 @@ -<!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> - <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> fromsystem / tosystem - -<span class="tagdoc" id="ivysettings.namespaces.namespace.fromsystem">Defines a one way translation rule, i.e. a translation from system namespace to the defined namespace or vice versa.</span> -<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>[[settings/namespace/src]]</td><td>defines a source name which can be accepted</td> - <td>1..n</td></tr> - <tr><td>[[settings/namespace/dest]]</td><td>defines the translation to apply when a name is accepted by an src pattern</td> - <td>1</td></tr> -</tbody> -</table> - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/namespace/rule.html ---------------------------------------------------------------------- diff --git a/doc/settings/namespace/rule.html b/doc/settings/namespace/rule.html deleted file mode 100644 index d580317..0000000 --- a/doc/settings/namespace/rule.html +++ /dev/null @@ -1,48 +0,0 @@ -<!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> - <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> rule - -<span class="tagdoc" id="ivysettings.namespaces.namespace.rule">Defines a new namespace rule. A rule defines a translation between system namespace and the defined namespace, and vice versa.</span> - -See the [[settings/namespace]] doc for details. - -<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>[[settings/namespace/fromtosystem fromsystem]]</td><td>defines the translation to apply from the system namespace to the defined namespace</td> - <td>1</td></tr> - <tr><td>[[settings/namespace/fromtosystem tosystem]]</td><td>defines the translation to apply from the defined namespace to the system namespace</td> - <td>1</td></tr> -</tbody> -</table> - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/namespace/src.html ---------------------------------------------------------------------- diff --git a/doc/settings/namespace/src.html b/doc/settings/namespace/src.html deleted file mode 100644 index 197bbeb..0000000 --- a/doc/settings/namespace/src.html +++ /dev/null @@ -1,48 +0,0 @@ -<!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> - <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> src - -<span class="tagdoc" id="ivysettings.namespaces.namespace.rule.fromsystem.src">Defines the acceptation part of a translation rule.</span> If a name matches this src, it will be translated using the dest part. -<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 to match as a regexp</td> - <td>No, defaults to .*</td></tr> - <tr><td>module</td><td>the module name to match as a regexp</td> - <td>No, defaults to .*</td></tr> - <tr><td>rev</td><td>the revision to match as a regexp</td> - <td>No, defaults to .*</td></tr> -</tbody> -</table> - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/namespaces.html ---------------------------------------------------------------------- diff --git a/doc/settings/namespaces.html b/doc/settings/namespaces.html deleted file mode 100644 index 52d4426..0000000 --- a/doc/settings/namespaces.html +++ /dev/null @@ -1,58 +0,0 @@ -<!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> - <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> namespaces - -<span class="tagdoc" id="ivysettings.namespaces">Namespaces are an advanced feature of Ivy which let you use resolvers in which module names and organisations are not consistent between each other.</span> - -For instance, if you want to use both a maven2 repository and an ivyrep, you will face some naming issues. For example, all apache commons projects are declared to be part of the organisation <i>apache</i> in ivyrep whereas in maven2 ibiblio repository, their organisation is same as the module. - -So if you try to use both maven2 and ivyrep repositories, you will face some issues like: -<quote> -How do I declare a dependency on commons-lang? -I have an error while trying to resolve module xxx. It says that it depends on [commons-httpclient commons-httpclient] and that it isn't available. -... -</quote> - -Ivy's answer to this issue is called namespaces. In short, you can attach a namespace to each dependency resolver in Ivy, and each namespace defines rules to convert names from the system namespace to the defined namespace itself, and vice versa. - -This very powerful feature is thoroughly used in the <a href="../tutorial/build-repository/advanced.html">build your own repository tutorial</a>, so is the best place to see an example of what can be done with namespaces. - -<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>[[settings/namespace]]</td><td>defines a new namespace</td> - <td>0..n</td></tr> -</tbody> -</table> - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/outputters.html ---------------------------------------------------------------------- diff --git a/doc/settings/outputters.html b/doc/settings/outputters.html deleted file mode 100644 index 3322b26..0000000 --- a/doc/settings/outputters.html +++ /dev/null @@ -1,65 +0,0 @@ -<!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> - <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> outputters - -<span class="tagdoc" id="ivysettings.outputters">Defines a list of report outputters usable in ivy. </span> - -A report outputter is used at the end of the resolve process to generate a report of how the resolve has been performed. - -Two report outputters are registered by default: -<ul> -<li>a log report outputter ([[gitfile:src/java/org/apache/ivy/plugins/report/LogReportOutputter.java LogReportOutputter]])</li>which produces the output on the console at the end of the resolve, which looks like this: -<code> - --------------------------------------------------------------------- - | | modules || artifacts | - | conf | number| search|dwnlded|evicted|| number|dwnlded| - --------------------------------------------------------------------- - | default | 1 | 1 | 0 | 0 || 1 | 1 | - --------------------------------------------------------------------- -</code> -<li>an xml report outputter ([[gitfile:src/java/org/apache/ivy/plugins/report/XmlReportOutputter.java XmlReportOutputter]])</li>which produces an xml report in the cache, which is mandatory for correct Ivy behaviour, since it's that report which is used when you do a post resolve step in a separate build from the resolve itself. It's also this xml report which is processed to generate all the different reports available in the [[ant:report]] task. -</ul> - -The child tag used for the parser must be equal to a name of a report outputter type (added with the typedef tag). - -To see how to define your own report outputter see <a href="../extend.html">Extending Ivy documentation</a> - -<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>any report outputter</td><td>adds a report outputter to the list of available ones</td> - <td>0..n</td></tr> -</tbody> -</table> - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/parsers.html ---------------------------------------------------------------------- diff --git a/doc/settings/parsers.html b/doc/settings/parsers.html deleted file mode 100644 index 1ddc973..0000000 --- a/doc/settings/parsers.html +++ /dev/null @@ -1,53 +0,0 @@ -<!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> - <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> parsers - -<span class="tagdoc" id="ivysettings.parsers">Defines a list of module descriptor parsers usable in ivy.</span> Each parser defines which resources (which descriptor file) it accepts. -The child tag used for the parser must be equal to a name of a parser type (added with the typedef tag). - -Note that when looking for a parser, ivy queries the parsers list in the reverse order. So the last parser in the list will be queried first. Consequently, if the last parser accepts all resources, the other parsers will never have a chance to parse the resource. - -Two parsers are available by default and thus do not need to be declared in this section: -<ul> -<li>ivy file parser</li> this is the parser used for ivy xml files. This parser is used for resources that aren't accepted by any other parser. -<li>pom parser</li>this parser is able to parse maven2 pom files -</ul> -<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>any module descriptor parser</td><td>adds a module descriptor parser to the list of available parsers</td> - <td>0..n</td></tr> -</tbody> -</table> - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/properties.html ---------------------------------------------------------------------- diff --git a/doc/settings/properties.html b/doc/settings/properties.html deleted file mode 100644 index b117883..0000000 --- a/doc/settings/properties.html +++ /dev/null @@ -1,51 +0,0 @@ -<!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> - <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> properties<br/> -<br/> -<span class="tagdoc" id="ivysettings.properties">Loads a properties file into ivy variables.</span> See the variables chapter above for details about ivy variables. - -<span class="since">Since 2.0</span>: it is possible to access environment variables. This can be done by specifying the environment attribute. This attribute specifies the prefix which can be used to access these environment variables. For instance, if you specify environment="env", you can access the PATH environment variable with the env.PATH property name. - -<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>file</td><td>a path to a properties file to load</td> - <td rowspan="2">One of these</td></tr> - <tr><td>environment</td><td>the prefix to use when retrieving environment variables <span class="since">(since 2.0)</span></td></tr> - <tr><td>override</td><td>indicates if the variable found in the properties file should override its previous value, if any <span class="since">(since 1.3)</span></td> - <td>No, defaults to true</td></tr> -</tbody> -</table> - - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/property.html ---------------------------------------------------------------------- diff --git a/doc/settings/property.html b/doc/settings/property.html deleted file mode 100644 index b18e5ae..0000000 --- a/doc/settings/property.html +++ /dev/null @@ -1,70 +0,0 @@ -<!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> - <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> property - -<span class="tagdoc" id="ivysettings.property">Defines an ivy variable.</span> <span class="since">since 1.3</span> - -The optional override attribute enables you to avoid overriding the previous value of the variable, which makes the definition behave like an ant property, which is particularly useful to define default values (values which are used only if they haven't been defined yet). -<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 variable to define</td> - <td>Yes</td></tr> - <tr><td>value</td><td>the new value the variable must take</td> - <td>Yes</td></tr> - <tr><td>override</td><td>true if the previous value (if any) of the variable should overriden, false otherwise</td> - <td>No, defaults to true</td></tr> - <tr><td>ifset</td><td>the variable will be set only if the provided 'ifset' variable is already set (Since 2.4)</td><td>No</td></tr> - <tr><td>unlessset</td><td>the variable will not be set unless the provided 'unlessset' variable is set (Since 2.4)</td><td>No</td></tr> -</tbody> -</table> -<h1>Examples</h1> -<code type="xml"> -<property name="myvar" value="myvalue"/> -</code> -Sets the variable myvar to the value myvalue. -<hr/> -<code type="xml"> -<property name="myvar" value="myvalue" override="false"/> -</code> -Sets the variable myvar to the value myvalue only if myvar has not been set yet. -<hr/> -<code type="xml"> - <properties environment="env"/> - <property name="ivy.repos.server" value="${env.IVY_SERVER}" override="false" ifset="env.IVY_SERVER" /> - <property name="ivy.repos.server" value="http://ivy:8081"; override="false"/> -</code> -If the environment variable is set, it takes precedence over of default value. - - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/resolvers.html ---------------------------------------------------------------------- diff --git a/doc/settings/resolvers.html b/doc/settings/resolvers.html deleted file mode 100644 index 13e4b6c..0000000 --- a/doc/settings/resolvers.html +++ /dev/null @@ -1,211 +0,0 @@ -<!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> - <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> resolvers - -<span class="tagdoc" id="ivysettings.resolvers">Defines a list of dependency resolvers usable in ivy.</span> Each dependency resolver is identified by its name, given as an attribute. - -The child tag used for the dependency resolver must be equal to a name of a dependency resolver type (either built-in or added with the typedef tag). - -<span class="since">since 1.3</span> Once defined, resolvers can be referenced by their name, using the following syntax: -<code type="xml"> -<resolver ref="alreadydefinedresolver"/> -</code> -Note that this works only if the resolver has already been defined and NOT if it is defined later in the ivysettings file. -<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>any resolver</td><td>adds a resolver to the list of available resolvers</td> - <td>1..n</td></tr> -</tbody> -</table> - -<h1>Built-in Resolvers</h1> -Ivy comes with a set of built-in dependency resolvers that handle most common needs. - -If you don't find the one you want here, you can also check if someone has contributed it on the [[links links page]], or even <a href="../extend.html">write your own</a>. - -There are basically two types of resolvers in Ivy: composite and standard. A composite resolver is a resolver which delegates the work to other resolvers. The other resolvers are standard resolvers. - -Here is the list of built-in resolvers: - -<table class="ivy-attributes"> -<thead> - <tr><th>Name</th><th>Type</th><th>Description</th></tr> -</thead> -<tbody> -<tr><td><a href="../resolver/ivyrep.html">IvyRep</a></td><td>Standard</td><td>Finds ivy files on ivyrep and artifacts on ibiblio.</td></tr> -<tr><td><a href="../resolver/ibiblio.html">IBiblio</a></td><td>Standard</td><td>Finds artifacts on ibiblio.</td></tr> -<tr><td><a href="../resolver/packager.html">Packager</a></td><td>Standard</td><td>Finds ivy files and packaging instructions via URLs, then creates artifacts by following the instructions.</td></tr> -<tr><td><a href="../resolver/filesystem.html">FileSystem</a></td><td>Standard</td><td>This very performant resolver finds ivy files and artifacts in your file system.</td></tr> -<tr><td><a href="../resolver/url.html">Url</a></td><td>Standard</td><td>Finds ivy files and artifacts in any repository accessible with urls.</td></tr> -<tr><td><a href="../resolver/vfs.html">Vfs</a></td><td>Standard</td><td>Finds ivy files and artifacts in any repository accessible with <a href="http://jakarta.apache.org/commons/vfs/";>apache commons vfs</a>.</td></tr> -<tr><td><a href="../resolver/ssh.html">ssh</a></td><td>Standard</td><td>Finds ivy files and artifacts in any repository accessible with ssh.</td></tr> -<tr><td><a href="../resolver/sftp.html">sftp</a></td><td>Standard</td><td>Finds ivy files and artifacts in any repository accessible with sftp.</td></tr> -<tr><td><a href="../resolver/jar.html">Jar</a></td><td>Standard</td><td>Finds ivy files and artifacts within a specified jar.</td></tr> -<tr><td><a href="../resolver/chain.html">Chain</a></td><td>Composite</td><td>Delegates the finding to a chain of sub resolvers.</td></tr> -<tr><td><a href="../resolver/dual.html">Dual</a></td><td>Composite</td><td>Delegates the finding of ivy files to one resolver and of artifacts to another.</td></tr> -<tr><td><a href="../resolver/obr.html">OBR</a></td><td>Standard</td><td>Resolve modules as OSGi bundles listed by an OSGi obr.xml.</td></tr> -<tr><td><a href="../resolver/updatesite.html">Eclipse updatesite</a></td><td>Standard</td><td>Resolve modules as OSGi bundles which are hosted on an Eclipse update site.</td></tr> -</tbody> -</table> - -<h1><a name="common">Common features and attributes</a></h1> -All resolvers of the same type share some common features and attributes detailed here. -<h2>Features</h2> -<h3>validation</h3> -All standard resolvers support several options for validation. - -The <i>validate</i> attribute is used to configure if ivy files should be checked against the ivy file xml schema. - -The checkconsistency attribute allows you to enable or disable consistency checking between what is expected by Ivy when it finds a module descriptor, and what the module descriptor actually contains. - -The descriptor attribute lets you define if module descriptors are mandatory or optional. - -The checksums attribute is used to define the list of checksums files to use to check if the content of downloaded files has not been corrupted (eg during transfer). -<h3>force</h3> -Any standard resolver can be used in force mode, which is used mainly to handle local development builds. In force mode, the resolver attempts to find a dependency whatever the requested revision is (internally it replace the requested revision by 'latest.integration'), and if it finds one, it forces this revision to be returned, even when used in a chain with returnFirst=false. - -By using such a resolver at the beginning of a chain, you can be sure that Ivy will pick up whatever module is available in this resolver (usually a private local build) instead of the real requested revision. This allows to handle use case like a developer working on modules A and C, where A -> B -> C, and pick up the local build for C without having to publish a local version of B. -<span class="since">since 2.0</span> - -<h3>Maven</h3> - -Any resolver which is able to parse a Maven pom.xml file has to detect the related sources or javadocs artifacts. This often involves sevrals network connection even if neither the sources nor the javadoc are requested to be downloaded. - -<span class="since">since 2.5</span> Setting the property <tt>ivy.maven.lookup.sources<tt> to <tt>false</tt> disable the lookup of the sources artifact. -And setting the property <tt>ivy.maven.lookup.javadoc<tt> to <tt>false</tt> disable the lookup of the javadoc artifact. - -<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><th>Composite</th><th>Standard</th></tr> -</thead> -<tbody> - <tr><td>name</td><td>the name which identifies the resolver</td> - <td>Yes</td> - <td>Yes</td> - <td>Yes</td> - </tr> - <tr><td>validate</td><td>indicates if resolved ivy files should be validated against ivy xsd</td> - <td>No, defaults to call setting</td> - <td>Yes</td> - <td>Yes</td> - </tr> - <tr><td>force</td><td>Indicates if this resolver should be used in force mode (see above). <span class="since">since 2.0</span></td> - <td>No, defaults to false</td> - <td>No</td> - <td>Yes</td> - </tr> - <tr><td>checkmodified</td><td>Indicates if this resolver should check lastmodified date to know if an ivy file is up to date.</td> - <td>No, defaults to ${ivy.resolver.default.check.modified}</td> - <td>No</td> - <td>Yes</td> - </tr> - <tr><td>changingPattern</td><td>Indicates for which revision pattern this resolver should check lastmodified date to know if an artifact file is up to date. <span class="since">since 1.4</span>. See <a href="../concept.html#change">cache and change management</a> for details.</td> - <td>No, defaults to none</td> - <td>Yes</td> - <td>Yes</td> - </tr> - <tr><td>changingMatcher</td><td>The name of the <a href="../concept.html#matcher">pattern matcher</a> to use to match a revision against the configured changingPattern. <span class="since">since 1.4</span>. See <a href="../concept.html#change">cache and change management</a> for details.</td> - <td>No, defaults to exactOrRegexp</td> - <td>Yes</td> - <td>Yes</td> - </tr> - <tr><td>alwaysCheckExactRevision</td><td>Indicates if this resolver should check the given revision even if it's a special one (like latest.integration). <span class="since">since 1.3</span></td> - <td>No, defaults to ${ivy.default.always.check.exact.revision}</td> - <td>No</td> - <td>Yes</td> - </tr> - <tr><td>namespace</td><td>The name of the namespace to which this resolver belons <span class="since">since 1.3</span></td> - <td>No, defaults to 'system'</td> - <td>Yes</td> - <td>Yes</td> - </tr> - <tr><td>checkconsistency</td><td>true to check consistency of module descriptors found by this resolver, false to avoid consistency check <span class="since">since 1.3</span></td> - <td>No, defaults to true</td> - <td>No</td> - <td>Yes</td> - </tr> - <tr><td>descriptor</td><td>'optional' if a module descriptor (usually an ivy file) is optional for this resolver, 'required' to refuse modules without module descriptor <span class="since">since 2.0</span></td> - <td>No, defaults to 'optional'</td> - <td>No (except dual)</td> - <td>Yes</td> - </tr> - <tr><td>allownomd</td><td><em>DEPRECATED. Use descriptor="required | optional" instead.</em> - true if the absence of module descriptor (usually an ivy file) is authorised for this resolver, false to refuse modules without module descriptor <span class="since">since 1.4</span></td> - <td>No, defaults to true</td> - <td>No (except dual)</td> - <td>Yes</td> - </tr> - <tr><td>checksums</td><td>a comma separated list of <a href="../concept.html#checksum">checksum algorithms</a> to use both for publication and checking <span class="since">since 1.4</span></td> - <td>No, defaults to ${ivy.checksums}</td> - <td>No</td> - <td>Yes</td> - </tr> - <tr><td>latest</td><td>The name of the latest strategy to use.</td> - <td>No, defaults to 'default'</td> - <td>Yes</td> - <td>Yes</td> - </tr> - <tr><td>cache</td><td>The name of the cache manager to use.</td> - <td>No, defaults to the value of the default attribute of caches</td> - <td>No</td> - <td>Yes</td> - </tr> - <tr><td>signer</td><td>The name of the [[settings/signers detached signature generator]] to use when publishing artifacts. <span class="since">(since 2.2)</span></td> - <td>No, by default published artifacts will not get signed by Ivy.</td> - <td>No</td> - <td>Yes</td> - </tr> -</tbody> -</table> - -<h1>Examples</h1> -<code type="xml"> -<resolvers> - <filesystem name="1" cache="cache-1"> - <ivy pattern="${ivy.settings.dir}/1/[organisation]/[module]/ivys/ivy-[revision].xml"/> - <artifact pattern="${ivy.settings.dir}/1/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/> - </filesystem> - <chain name="chain1"> - <resolver ref="1"/> - <ivyrep name="ivyrep"/> - </chain> - <chain name="chain2" returnFirst="true" dual="true"> - <resolver ref="1"/> - <ibiblio name="ibiblio"/> - </chain> -</resolvers> -</code> -Defines a filesystem resolver, named '1', which is then used in two chains, the first which combines the filesystem resolver with an ivyrep resolver, and second which combines the filesystem resolver with an ibiblio resolver, and which returns the first module found, and uses the whole chain to download artifacts (see corresponding resolvers documentation for details about them). Resolver 1 will use a cache named 'cache-1' which should have been defined under the caches element. - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/settings.html ---------------------------------------------------------------------- diff --git a/doc/settings/settings.html b/doc/settings/settings.html deleted file mode 100644 index 993d815..0000000 --- a/doc/settings/settings.html +++ /dev/null @@ -1,81 +0,0 @@ -<!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> - <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> settings - -<span class="tagdoc" id="ivysettings.settings">Configures some important ivy info: default resolver, latest strategy, conflict manager...</span> - -The default resolver is used whenever nothing else is configured in the modules section of the settings file. It should give the name of a dependency resolver defined in the [[settings/resolvers]] section of the settings file. - -The default latest strategy and conflict manager can also be configured here. - -<em>validate</em> indicates if ivy files should generally be validated against the xsd or not. This setting is only a default value, and can be overridden: -1) in ant tasks -2) in resolvers -So if there is a setting in the resolver, it always wins against all other settings. - -<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>defaultResolver</td><td>the name of the default resolver to use</td> - <td>No, but all modules should be configured in the modules section if not provided</td></tr> - <tr><td>defaultLatestStrategy</td><td>the name of the default latest strategy to use</td> - <td>No, defaults to latest-revision</td></tr> - <tr><td>defaultConflictManager</td><td>the name of the default conflict manager to use</td> - <td>No, defaults to latest-revision</td></tr> - <tr><td>defaultBranch</td><td>the default branch to use for all modules, except if they have a [[settings/module module specific branch setting]]. <span class="since">since 1.4</span></td> - <td>No, defaults to no default branch</td></tr> - <tr><td>defaultResolveMode</td><td>the default [[ant:resolve resolve mode]] to use for all modules, except if they have a [[settings/module module specific resolve mode setting]]. <span class="since">since 2.0</span></td> - <td>No, defaults to 'default'</td></tr> - <tr><td><a name="circularDependencyStrategy"></a>circularDependencyStrategy</td><td>the name of the <a href="../concept.html#circular">circular dependency strategy</a> to use <span class="since">since 1.4</span></td> - <td>No, defaults to warn</td></tr> - <tr><td>validate</td><td>Indicates if ivy files should be validated against ivy.xsd or not.</td> - <td>No, defaults to true</td></tr> - <tr><td>useRemoteConfig</td><td>true to configure ivyrep and ibiblio resolver from a remote configuration file (updated with changes in those repository structure if any) (<span class="since">since 1.2</span>)</td> - <td>No, defaults to false</td></tr> - <tr><td>httpRequestMethod</td><td>specifies the HTTP method to use to retrieve information about an URL. Possible values are 'GET' and 'HEAD'. This setting can be used to solve problems with firewalls and proxies. (<span class="since">since 2.0</span>)</td> - <td>No, defaults to 'HEAD'</td></tr> - <tr><td><s>defaultCache</s></td><td>a path to a directory to use as default basedir for both resolution and repository cache(s). - <i>Deprecated, we recommend using defaultCacheDir on the [[settings/caches]] tag instead</i></td> - <td>No, defaults to .ivy2/cache in user home</td></tr> - <tr><td><s>checkUpToDate</s></td><td>Indicates if date should be checked before retrieving artifacts from cache. - <i>Deprecated, we recommend using overwriteMode on the [[use/retrieve]] task instead</i></td> - <td>No, defaults to true</td></tr> - <tr><td><s>cacheIvyPattern</s></td><td>a pattern to indicate where ivy files should be put in cache. - <i>Deprecated, we recommend using ivyPattern on the [[settings/caches]] tag instead</i></td> - <td>No, defaults to [organisation]/[module]/ivy-[revision].xml</td></tr> - <tr><td><s>cacheArtifactPattern</s></td><td>a pattern to indicate where artifact files should be put in cache. - <i>Deprecated, we recommend using artifactPattern on the [[settings/caches]] tag instead</i></td> - <td>No, defaults to [organisation]/[module]/[type]s/[artifact]-[revision].[ext]</td></tr> -</tbody> -</table> -</textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/signers.html ---------------------------------------------------------------------- diff --git a/doc/settings/signers.html b/doc/settings/signers.html deleted file mode 100644 index 5ea94e9..0000000 --- a/doc/settings/signers.html +++ /dev/null @@ -1,96 +0,0 @@ -<!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> - <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> signers -<span class="since">since 2.2</span> - -<span class="tagdoc" id="ivysettings.signers">Defines a list of detached signature generators usable in ivy. Each generator is identified by its name, given as an attribute. -The child tags used to configure the signature generator must be equal to the name of a signature generator type (either built-in or added with the typedef tag).</span> - -Ivy supports the following signature generator out of the box: -<ul> -<li>pgp</li> generates an OpenPGP compatible ASCII armored detached signature. -</ul> - - -<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>any signature generator</td><td>adds a signature generator to the list of registered generators</td> - <td>1..n</td></tr> -</tbody> -</table> - -<h1>Built-in Generators</h1> - -<h2>PGP</h2> - -This generator is capable of generating an OpenPGP compatible ASCII armored detached signature. - -<b>Remark:</b> This generator uses the <a href="http://www.bouncycastle.org/java.html";>BouncyCastle OpenPGP</a> library. Before this generator can be used, these libraries must be available on Ivy's classpath. - - -<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 signature generator.</td> - <td>Yes</td> - </tr> - <tr><td>secring</td><td>The location of the secret keyring.</td> - <td>No, defaults to ${user.home}/.gnupg/secring.gpg</td> - </tr> - <tr><td>keyId</td><td>The identifier of the key to use. The keyword 'auto' can be used to indicate a key will be selected automatically.</td> - <td>No, defaults to 'auto'.</td> - </tr> - <tr><td>password</td><td>The password of the private key.</td> - <td>Yes</td> - </tr> -</tbody> -</table> - -<h1>Examples</h1> -<code type="xml"> -<signers> - <pgp name="mypgp" password="my-password" /> -</signers> -</code> -Defines a detached signature generator with name 'mypgp' which uses the secret key ring on the default location and automatically selects a private key. -<hr/> -<code type="xml"> -<signers> - <pgp name="mypgp" password="my-password" keyId="123ABC45"/> -</signers> -</code> -Same as before, but this time the key '123ABC45' is used to generate the detached signature. -</textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/status.html ---------------------------------------------------------------------- diff --git a/doc/settings/status.html b/doc/settings/status.html deleted file mode 100644 index dfce4e9..0000000 --- a/doc/settings/status.html +++ /dev/null @@ -1,48 +0,0 @@ -<!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> - <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> status - -<span class="tagdoc" id="ivysettings.statuses.status">Define one available module status.</span> - -See [[settings/statuses]] page for details about how statuses are defined. - -<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>name of status defined</td> - <td>Yes</td></tr> - <tr><td>integration</td><td>true if this is an integration status, false otherwise</td> - <td>No, defaults to false</td></tr> -</tbody> -</table> - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/statuses.html ---------------------------------------------------------------------- diff --git a/doc/settings/statuses.html b/doc/settings/statuses.html deleted file mode 100644 index 4537fcc..0000000 --- a/doc/settings/statuses.html +++ /dev/null @@ -1,72 +0,0 @@ -<!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> - <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> statuses - -<span class="tagdoc" id="ivysettings.statuses">Defines the list of available statuses.</span> <span class="since">since 1.4</span> - -By default, ivy has 3 statuses: release, milestone and integration. By adding a statuses section to your ivysettings file, you define the statuses you want to use. Note that in this case if you still want to have ivy default statuses you will have to declare them. - -The integration property on each status is only used for recursive delivery, an integration dependency being delivered if the caller is not in integration state itself. - -The default status is the one used when none is defined in a module descriptor. If not specified, it defaults to the last defined status. - -The statuses order is important, the first is considered the more mature, the last the less mature. This is used to know if a status is compatible with a latest.<em><status></em> version matcher. - -<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>default</td><td>the name of the status to use when none is declared in an ivy file</td> - <td>No, defaults to the last status declared</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>[[settings/status]]</td><td>defines a new status</td> - <td>0..n</td></tr> -</tbody> -</table> -<h1>Examples</h1> -<code type="xml"> -<statuses default="bronze"> - <status name="gold" integration="false"/> - <status name="silver" integration="false"/> - <status name="bronze" integration="true"/> -</statuses> -</code> -Defines 3 statuses, gold, silver and bronze. The default status used when none is declared in an ivy file will be bronze. -It is also considered as an integration status, and thus doesn't trigger any recrusive delivery. - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/triggers.html ---------------------------------------------------------------------- diff --git a/doc/settings/triggers.html b/doc/settings/triggers.html deleted file mode 100644 index 58d2c03..0000000 --- a/doc/settings/triggers.html +++ /dev/null @@ -1,357 +0,0 @@ -<!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> - <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> triggers -<span class="since">since 1.4</span> - -<span class="tagdoc" id="ivysettings.triggers">Defines a list of triggers to activate on some Ivy events.</span> - -A trigger is an action which is performed whenever a particular event occurs. -Ivy supports 3 type of triggers out of the box: -<ul> -<li>ant-call</li> calls a target in the same build as the original one whenever a particular event occurs. -<li>ant-build</li> calls an ant build which may be in another ant build script. -<li>log</li> echo a message, usually in a file -</ul> - -If you want to use a different trigger, you can <a href="../extend.html">implement your own</a>. - -The following events are available in Ivy: -<table class="ivy-children"> -<thead> - <tr><th>Name</th><th>Attributes</th><th>Description</th></tr> -</thead> -<tbody> - <tr><td>pre-resolve</td> - <td> - <ul> - <li>organisation</li>the organisation of the module for which the dependencies will be resolved - <li>module</li>the name of the module for which the dependencies will be resolved - <li>revision</li>the revision of the module for which the dependencies will be resolved - <li>conf</li>comma separated list of configurations which will be resolved - </ul> - </td> - <td>Fired at the beginning of the resolve process, before module dependencies and transitive dependencies are resolved.</td> - </tr> - <tr><td>pre-resolve-dependency</td> - <td> - <ul> - <li>organisation</li>the organisation of the dependency resolved - <li>module</li>the name of the dependency resolved - <li>req-revision</li>the requested revision for the dependency <span class="since">since 2.0</span> (provided for consistency with post-resolve-dependency) - <li>req-revision-default</li>the default requested revision constraint for the dependency <span class="since">since 2.0</span> - <li>req-revision-dynamic</li>the requested revision dynamic constraint for the dependency <span class="since">since 2.0</span> - <li>revision</li>the requested revision for the dependency - <li>resolver</li>the name of the resolver used to resolve the dependency - </ul> - </td> - <td>Fired before each dependency is resolved. In this case resolved means resolving the actual revision if the requested revision is a version constraint and not a static version, and downloading all necessary metadata information.</td> - </tr> - <tr><td>post-resolve-dependency</td> - <td> - <ul> - <li>organisation</li>the organisation of the dependency resolved - <li>module</li>the name of the dependency resolved - <li>req-revision</li>the requested revision for the dependency <span class="since">since 2.0</span> - <li>req-revision-default</li>the default requested revision constraint for the dependency <span class="since">since 2.0</span> - <li>req-revision-dynamic</li>the requested revision dynamic constraint for the dependency <span class="since">since 2.0</span> - <li>revision</li>the revision of the dependency resolved, or the requested revision if the resolution was not successful - <li>resolved</li>true if the resolution was successful, false otherwise - <li>duration</li>the time elapsed to resolve the dependency (in ms) <span class="since">since 2.0</span> - <li>resolver</li>the name of the resolver used to resolve the dependency - <li>any extra attribute</li>all extra attributes found on the info tag of the resolved dependency are available <span class="since">since 2.0</span> - </ul> - </td> - <td>Fired after each dependency is resolved</td> - </tr> - <tr><td>post-resolve</td> - <td> - <ul> - <li>organisation</li>the organisation of the module for which the dependencies have been resolved - <li>module</li>the name of the module for which the dependencies have been resolved - <li>revision</li>the revision of the module for which the dependencies have been resolved - <li>conf</li>comma separated list of configurations resolved - <li>resolve-id</li>the identifier of the resolution process <span class="since">since 2.0</span> - <li>nb-dependencies</li>total number of dependencies, including transitive and evicted ones <span class="since">since 2.0</span> - <li>nb-artifacts</li>total number of artifacts resolved, excluding metadata artifacts <span class="since">since 2.0</span> - <li>resolve-duration</li>the time (in ms) elapsed to resolve dependencies, before dowloading artifacts <span class="since">since 2.0</span> - <li>download-duration</li>the time (in ms) elapsed to download all artifacts, excluding metadata artifacts downloaded during the first phase of the resolution process <span class="since">since 2.0</span> - <li>download-size</li>the total size (in bytes) of all downloaded artifacts, excluding metadata artifacts. Only artifacts actually downloaded (not in cache or used from their original location) are considered <span class="since">since 2.0</span> - </ul> - </td> - <td>Fired at the end of the resolve process, when all module dependencies have been resolved</td> - </tr> - <tr><td>pre-download-artifact</td> - <td> - <ul> - <li>organisation</li>the organisation of the artifact which is about to be downloaded - <li>module</li>the name of the module of the artifact which is about to be downloaded - <li>revision</li>the revision of the the artifact which is about to be downloaded - <li>artifact</li>the name of the the artifact which is about to be downloaded - <li>type</li>the type of the the artifact which is about to be downloaded - <li>ext</li>the extension of the the artifact which is about to be downloaded - <li>metadata</li>true if the artifact to be downloaded is a metadata artifact, false for published artifacts <span class="since">since 2.0</span> - <li>resolver</li>the name of the resolver used to download the artifact - <li>origin</li>the origin location from which it will be downloaded - <li>local</li>true if it's a local artifact, false otherwise - </ul> - </td> - <td>Fired before an artifact is downloaded from a repository to the cache</td> - </tr> - <tr><td>post-download-artifact</td> - <td> - <ul> - <li>organisation</li>the organisation of the artifact which was just downloaded - <li>module</li>the name of the module of the artifact which was just downloaded - <li>revision</li>the revision of the the artifact which was just downloaded - <li>artifact</li>the name of the the artifact which was just downloaded - <li>type</li>the type of the the artifact which was just downloaded - <li>ext</li>the extension of the the artifact which was just downloaded - <li>metadata</li>true if the downloaded artifact is a metadata artifact, false for published artifacts <span class="since">since 2.0</span> - <li>resolver</li>the name of the resolver used to download the artifact - <li>origin</li>the origin location from which it was downloaded - <li>local</li>true if it's a local artifact, false otherwise - <li>size</li>the size in bytes of the downloaded artifact - <li>duration</li>the time elapsed to download the artifact (in ms) <span class="since">since 2.0</span> - <li>file</li>the file to which it has been downloaded - </ul> - </td> - <td>Fired after an artifact has been downloaded from a repository to the cache</td> - </tr> - <tr><td>pre-retrieve <br/><span class="since">since 2.0</span></td> - <td> - <ul> - <li>organisation</li>the organisation of the module for which the dependencies will be retrieved - <li>module</li>the name of the module for which the dependencies will be retrieved - <li>revision</li>the revision of the module for which the dependencies will be retrieved - <li>conf</li>comma separated list of configurations which will be retrieved - <li>symlink</li>true if Ivy will use symbolic links instead of copies on supported platforms, false otherwise - <li>sync</li>true if the retrieve process will be performed in sync mode, false otherwise - </ul> - </td> - <td>Fired at the beginning of the retrieve process.</td> - </tr> - <tr><td>post-retrieve <br/><span class="since">since 2.0</span></td> - <td> - <ul> - <li>organisation</li>the organisation of the module for which the dependencies have been retrieved - <li>module</li>the name of the module for which the dependencies will be retrieved - <li>revision</li>the revision of the module for which the dependencies have been retrieved - <li>conf</li>comma separated list of configurations which have been retrieved - <li>symlink</li>true if Ivy used symbolic links instead of copies on supported platforms, false otherwise - <li>sync</li>true if the retrieve process has been performed in sync mode, false otherwise - <li>duration</li>the time elapsed in ms during the retrieve process - <li>size</li>the total size of artifacts which have actually been copied (or symlinked) - <li>nbCopied</li>the number of artifacts copied or symlinked - <li>nbUptodate</li>the number of artifacts which were already present and up to date at the destination location - </ul> - </td> - <td>Fired at the end of the retrieve process.</td> - </tr> - <tr><td>pre-retrieve-artifact <br/><span class="since">since 2.1</span></td> - <td> - <ul> - <li>organisation</li>the organisation of the artifact which is about to be retrieved - <li>module</li>the name of the module of the artifact which is about to be retrieved - <li>revision</li>the revision of the the artifact which is about to be retrieved - <li>artifact</li>the name of the the artifact which is about to be retrieved - <li>type</li>the type of the the artifact which is about to be retrieved - <li>ext</li>the extension of the the artifact which is about to be retrieved - <li>metadata</li>true if the retrieved artifact is a metadata artifact, false for published artifacts - <li>size</li>the size in bytes of the retrieved artifact - <li>from</li>the absolute path from which it will be retrieved (usually a location in cache) - <li>to</li>the absolute path to which it will be retrieved - </ul> - </td> - <td>Fired before an artifact is retrieved from the cache to a local location</td> - </tr> - <tr><td>post-retrieve-artifact <br/><span class="since">since 2.1</span></td> - <td> - <ul> - <li>organisation</li>the organisation of the artifact which has just been retrieved - <li>module</li>the name of the module of the artifact which has just been retrieved - <li>revision</li>the revision of the the artifact which has just been retrieved - <li>artifact</li>the name of the the artifact which has just been retrieved - <li>type</li>the type of the the artifact which has just been retrieved - <li>ext</li>the extension of the the artifact which has just been retrieved - <li>metadata</li>true if the retrieved artifact is a metadata artifact, false for published artifacts - <li>size</li>the size in bytes of the retrieved artifact - <li>from</li>the absolute path from which it has just been retrieved (usually a location in cache) - <li>to</li>the absolute path to which it has just been retrieved - </ul> - </td> - <td>Fired after an artifact is retrieved from the cache to a local location</td> - </tr> - <tr><td>pre-publish-artifact <br/><span class="since">since 2.0</span></td> - <td> - <ul> - <li>organisation</li>the organisation of the artifact which is about to be published - <li>module</li>the name of the module of the artifact which is about to be published - <li>revision</li>the revision of the the artifact which is about to be published - <li>artifact</li>the name of the the artifact which is about to be published - <li>type</li>the type of the the artifact which is about to be published - <li>ext</li>the extension of the the artifact which is about to be published - <li>resolver</li>the name of the resolver into which the artifact is about to be published - <li>file</li>the absolute path of the source file for the artifact - <li>overwrite</li>"true" if the new data will overwrite existing artifacts, "false" otherwise - </ul> - </td> - <td>Fired before an artifact is published into a repository</td> - </tr> - <tr><td>post-publish-artifact <br/><span class="since">since 2.0</span></td> - <td> - <ul> - <li>organisation</li>the organisation of the artifact that was published - <li>module</li>the name of the module of the artifact that was published - <li>revision</li>the revision of the the artifact that was published - <li>artifact</li>the name of the the artifact that was published - <li>type</li>the type of the the artifact that was published - <li>ext</li>the extension of the the artifact that was published - <li>resolver</li>the name of the resolver into which the artifact was published - <li>file</li>the absolute path of the source file for the artifact - <li>overwrite</li>"true" if the new data overwrote existing artifacts, "false" otherwise - <li>status</li>"successful" if the artifact published successfully; "failed" if the artifact failed to publish, or if the status is unknown - </ul> - </td> - <td>Fired after an artifact is published into a repository. Note that this event is fired whether or not the publication succeeded. The "status" property can be checked to verify success.</td> - </tr> -</tbody> -</table> - - -The child tag used for the dependency resolver must be equal to a name of a trigger type (either built-in or added with the typedef tag). - -<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>any trigger</td><td>adds a trigger to the list of registered triggers</td> - <td>1..n</td></tr> -</tbody> -</table> - -<h1>Built-in Triggers</h1> -Ivy comes with 3 built-in triggers: - -<table class="ivy-attributes"> -<thead> - <tr><th>Name</th><th>Description</th></tr> -</thead> -<tbody> -<tr><td>ant-build</td><td>Triggers an ant build. Note that by default the ant build is triggered only once per build file, the property onlyonce can be set to false to change this.</td></tr> -<tr><td>ant-call</td><td>Calls a target in the current ant build.</td></tr> -<tr><td>log</td><td>Logs a message on the console or in a log file.</td></tr> -</tbody> -</table> - - -<h1><a name="common">Common attributes</a></h1> -All triggers share some common attributes detailed here. - -Among these attributes, you will find how to select when the trigger should be performed. You have to provide an event name, which is simple, but you can also use a filter expression. The syntax for this expression is very simple and limited: -you can use the = operator to compare an attribute (left operande) with a value (right operande). -you can use AND OR NOT as boolean operators -you cannot use parenthesis to change the precedence - -<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 trigger for identification purpose only</td> - <td>Yes</td> - </tr> - <tr><td>event</td><td>the name of the event on which the trigger should be performed</td> - <td>Yes</td> - </tr> - <tr><td>filter</td><td>a filter expression used to restrict when the trigger should be performed</td> - <td>No, defaults to no filter</td> - </tr> -</tbody> -</table> - -<h1>Examples</h1> -<code type="xml"> -<triggers> - <ant-build antfile="${ivy.settings.dir}/[module]/build.xml" target="publish" - event="pre-resolve-dependency" filter="revision=latest.integration"/> -</triggers> -</code> -Triggers an ant build of the ant file ${ivy.settings.dir}/[module]/build.xml (where [module] is replaced by the name of the dependency resolved) with the target "publish", just before resolving a dependency with a latest.integration revision. -Note that by default the ant build is triggered only once per build file. See below to see how to trigger the build more than once. -<hr/> -<code type="xml"> -<triggers> - <ant-build antfile="${ivy.settings.dir}/[module]/build.xml" target="publish" - event="pre-resolve-dependency" filter="revision=latest.integration" - onlyonce="false" /> -</triggers> -</code> -Same as before, but this time the builds will be triggered as many time as the dependency is resolved, instead of only once. -<hr/> -<code type="xml"> -<triggers> - <ant-call target="unzip" prefix="dep" - event="post-download-artifact" filter="type=zip AND status=successful"/> -</triggers> -</code> -Triggers an ant call of the target unzip just after downloading a zip artifact, prefixing all parameters to the target with 'dep'. -Here is how the target can look like: -<code type="xml"> -<target name="unzip"> - <echo> - unzipping artifact: - organisation=${dep.organisation} - module=${dep.module} - revision=${dep.revision} - artifact=${dep.artifact} - type=${dep.type} - ext=${dep.ext} - origin=${dep.origin} - local=${dep.local} - size=${dep.size} - file=${dep.file} - </echo> - <mkdir dir="${basedir}/out"/> - <unzip src="${dep.file}" dest="${basedir}/out"/> -</target> -</code> -<hr/> -<code type="xml"> -<triggers> - <log file="ivy.log" - message='downloaded "${origin}" to "${file}" (${duration}ms - ${size}B)' - event="post-download-artifact" filter="status=successful"/> -</triggers> -</code> -Logs any successful artifact download, with information on the source and destination, and details on download size and duration. - -The file attribute is optional, the log trigger will output messages to console if it isn't provided.</textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/typedef.html ---------------------------------------------------------------------- diff --git a/doc/settings/typedef.html b/doc/settings/typedef.html deleted file mode 100644 index 7cd5afe..0000000 --- a/doc/settings/typedef.html +++ /dev/null @@ -1,47 +0,0 @@ -<!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> - <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> typedef<br/> -<br/> -<span class="tagdoc" id="ivysettings.typedef">Defines a new type in ivy. Useful to define new dependency resolvers, in particular, but also latest strategies.</span> -See <a href="../extend.html">how to write and plug your own dependency resolver</a> for details. -<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 type to define. This name is then used as an xml tag.</td> - <td>Yes</td></tr> - <tr><td>classname</td><td>the fully qualified class name of the type to define.</td> - <td>Yes</td></tr> -</tbody> -</table> - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/settings/version-matchers.html ---------------------------------------------------------------------- diff --git a/doc/settings/version-matchers.html b/doc/settings/version-matchers.html deleted file mode 100644 index e53cd2f..0000000 --- a/doc/settings/version-matchers.html +++ /dev/null @@ -1,140 +0,0 @@ -<!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> - <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> version-matchers - -<span class="tagdoc" id="ivysettings.version-matchers">Defines a list of version matchers.</span> <span class="since">since 1.4</span> - -The child tag used for the version matcher must be equal to a name of a report outputter type (added with the typedef tag). - -A version matcher is used to evaluate if a dependency version constraint matches a dependency version. - -<h1>Attributes</h1> -<table class="ivy-attributes"> -<thead> - <tr><th class"ivy-att">Attribute</th><th class="ivy-att-desc">Descrition</th><th class="ivy-att-req">Required</th></tr> -</thead> -<tbody> - <tr><td>usedefaults</td> - <td>when set to true, includes the built-in version matchers (Latest, Sub Revision, and Version Ranger Matcher). Exact Revision Matcher is always included</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>any version matcher</td><td>adds a version matcher to the list of available ones</td> - <td>0..n</td></tr> -</tbody> -</table> - -<h1>Built-in Version Matchers</h1> -<h2>Exact Revesion Matcher</h2> -A matcher that matches a dependency revision id to the module revision id using simple string equality. - -<h2>Sub Revision Matcher</h2> -A matcher that matches all revisions starting with a specific prefix. The syntax is: [prefix]+ - -<table class="ivy-children"> -<thead> - <tr><th class="ivy-chld">Revision</th><th class="ivy-chld-desc">Matches</th></tr> -</thead> -<tbody> - -<tr><td>1.0.+</td><td>all revisions starting with '1.0.', like 1.0.1, 1.0.5, 1.0.a</td></tr> -<tr><td>1.1+</td><td>all revisions starting with '1.1', like 1.1, 1.1.5, but also 1.10, 1.11</td></tr> -</table> - -<h2>Latest (Status) Matcher</h2> - -A matcher that matches versions based on their status. The predefined statuses in Ivy are 'release', 'milestone' and 'integration'. It's possible to define your own statuses, see [[settings/statuses]] for more details. - -<table class="ivy-children"> -<thead> - <tr><th class="ivy-chld">Revision</th><th class="ivy-chld-desc">Matches</th></tr> -</thead> -<tbody> - -<tr><td>latest.integration</td><td>all versions</td></tr> -<tr><td>latest.milestone</td><td>all modules having at least 'milestone' as status</td></tr> -<tr><td>latest.release</td><td>all modules having at least 'release' as status</td></tr> -<tr><td>latest.[any status]</td><td>all modules having at least the specified status</td></tr> -</table> - -<h2>Version Range Matcher</h2> - -Range types are exhaustively listed by example in the table below. - -<table class="ivy-children"> -<thead> - <tr><th class="ivy-chld">Revision</th><th class="ivy-chld-desc">Matches</th></tr> -</thead> -<tbody> - -<tr><td> [1.0,2.0] </td><td> all versions greater or equal to 1.0 and lower or equal to 2.0</td></tr> - -<tr><td> [1.0,2.0[ </td><td> all versions greater or equal to 1.0 and lower than 2.0</td></tr> - -<tr><td> ]1.0,2.0] </td><td> all versions greater than 1.0 and lower or equal to 2.0<tr> - -<tr><td> ]1.0,2.0[ </td><td> all versions greater than 1.0 and lower than 2.0</td></tr> - -<tr><td> [1.0,) </td><td> all versions greater or equal to 1.0 </td></tr> - -<tr><td> ]1.0,) </td><td> all versions greater than 1.0</td></tr> - -<tr><td> (,2.0] </td><td> all versions lower or equal to 2.0</td></tr> - -<tr><td> (,2.0[ </td><td> all versions lower than 2.0 </td></tr> - -</tbody> -</table> - -<h2>Version Pattern Matcher</h2> - -The version pattern matcher allows for more flexibility in pattern matching at the cost of adding a matcher declaration in Ivy settings. A simple example is given below. - -<h3>Settings.xml</h3> -<code type="xml"> -<pattern-vm> - <match revision="foo" pattern="${major}\.${minor}\.\d+" args="major, minor" matcher="regexp" /> -</pattern-vm> -</code> - -<h3>Ivy.xml</h3> -<code type="xml"> -<dependency org="acme" name="tool" rev="foo(1, 3)" /> -</code> - -The version pattern matcher may contain more than one match element. The matcher will attempt to match a dependency revision against each match in sequence, checking the revision tag (e.g. foo(..)) and then the pattern. -Matcher types may be one of "regexp", "exact", "glob", or "exactOrRegexp". Glob pattern matching requires Apache ORO 2.0.8 or higher to be on the classpath.</textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/standalone.html ---------------------------------------------------------------------- diff --git a/doc/standalone.html b/doc/standalone.html deleted file mode 100644 index 56ebe03..0000000 --- a/doc/standalone.html +++ /dev/null @@ -1,146 +0,0 @@ -<!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 can be used as a standalone program very easily. All you need is a Java 5+ runtime environment (JRE)! - -Then here is how to call it: -<code> -java -jar ivy.jar -? -</code> -It will display an online help like this: -<code> -==== settings options - -settings <settingsfile> use given file for settings - -cache <cachedir> use given directory for cache - -novalidate do not validate ivy files against xsd - -m2compatible use maven2 compatibility - -==== resolve options - -ivy <ivyfile> use given file as ivy file - -dependency <organisation> <module> <revision> - use this instead of ivy file to do the rest of the - work with this as a dependency. - -confs <configurations> resolve given configurations - -==== retrieve options - -retrieve <retrievepattern> use given pattern as retrieve pattern - -sync use sync mode for retrieve - -==== cache path options - -cachepath <cachepathfile> outputs a classpath consisting of all dependencies - in cache (including transitive ones) of the given - ivy file to the given cachepathfile - -==== deliver options - -deliverto <ivypattern> use given pattern as resolved ivy file pattern - -==== publish options - -publish <resolvername> use given resolver to publish to - -publishpattern <artpattern> use given pattern to find artifacts to publish - -revision <revision> use given revision to publish the module - -status <status> use given status to publish the module - -==== http auth options - -realm <realm> use given realm for HTTP AUTH - -host <host> use given host for HTTP AUTH - -username <username> use given username for HTTP AUTH - -passwd <passwd> use given password for HTTP AUTH - -==== launcher options - -main <main> the FQCN of the main class to launch - -args <args> the arguments to give to the launched process - -cp <cp> extra classpath to use when launching process - -==== message options - -debug set message level to debug - -verbose set message level to verbose - -warn set message level to warn - -error set message level to error - -==== help options - -? display this help - -deprecated show deprecated options -</code> - -<span class="since">since 1.3</span> System properties are included as ivy variables, so you can easily define an ivy variable like this: -<code> -java -Dmyivyvar=myvalue org.apache.ivy.Main [parameters] -</code> - - -<h1>Examples</h1> -<code> -java -jar ivy.jar -</code> -calls ivy with default configuration using ivy.xml in the current dir -<hr/> -<code> -java -jar ivy.jar -settings path/to/myivysettings.xml -ivy path/to/myivy.xml -</code> -calls ivy with given ivysettings file using given ivy file -<hr/> -<span class="since">since 1.3</span> -<code> -java -jar ivy.jar -settings path/to/myivysettings.xml -dependency apache commons-lang 2.0 -</code> -calls ivy with given ivysettings file and resolve apache commons-lang 2.0. - -This is equivalent to: -<code> -java -jar ivy.jar -settings path/to/myivysettings.xml -ivy ivy.xml -</code> -with ivy.xml like this: -<code type="xml"> -<ivy-module version="1.0"> - <info organisation="org" - module="standalone" - revision="working" - /> - <dependencies> - <dependency org="apache" name="commons-lang" rev="2.0" conf="default->*"/> - </dependencies> -</ivy-module> -</code> -<hr/> -<span class="since">since 1.3</span> -<code> -java -jar ivy.jar -settings path/to/myivysettings.xml -ivy path/to/myivy.xml -cachepath mycachefile.txt -</code> -calls ivy with given ivysettings file and resolve the dependencies found in the given ivy file, and then output the classpath of resolved artifacts in cache in a file. This file can then be used to define a classpath corresponding to all the resolved dependencies for any java program. - -<hr/> -<span class="since">since 1.4</span> -<code> -java -jar ivy.jar -settings path/to/myivysettings.xml -dependency bar foo 2.0 -main org.bar.foo.FooMain -</code> -calls ivy with given ivysettings file and resolve bar foo 2.0, and then run org.foo.FooMain class with the resolved artifacts as classpath - - - </textarea> -<script type="text/javascript">xooki.postProcess();</script> -</body> -</html> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0c769150/doc/style/ant.css ---------------------------------------------------------------------- diff --git a/doc/style/ant.css b/doc/style/ant.css deleted file mode 100644 index 3c25d3b..0000000 --- a/doc/style/ant.css +++ /dev/null @@ -1,50 +0,0 @@ -/* - * 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. - * - */ - -table.ant { - border-collapse:collapse; - width:90%; - margin:auto; - margin-top: 10px; -} -.ant thead { - background-color:#DEE4CD; - border:1px solid #7A9437; -} -.ant tbody { - background-color:#FFFFFF; - border:1px solid #7A9437; -} - -.ant th { - font-family:monospace; - border:1px solid #7A9437; - padding:5px; -} - -.ant td { - border:1px dotted #7A9437; - padding:5px; -} - -th.ant-att { - width:15%; -} -th.ant-desc { - width:50%; -}
