You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by hi...@apache.org on 2017/06/30 15:54:40 UTC
[1/3] ant-ivy git commit: use highlightjs to put colors on the xml
snipsets
Repository: ant-ivy
Updated Branches:
refs/heads/master 25a67d80c -> 0851fa776
use highlightjs to put colors on the xml snipsets
Project: http://git-wip-us.apache.org/repos/asf/ant-ivy/repo
Commit: http://git-wip-us.apache.org/repos/asf/ant-ivy/commit/5bc940ca
Tree: http://git-wip-us.apache.org/repos/asf/ant-ivy/tree/5bc940ca
Diff: http://git-wip-us.apache.org/repos/asf/ant-ivy/diff/5bc940ca
Branch: refs/heads/master
Commit: 5bc940ca65beef9bb79aaa83f6e976685fbe0a05
Parents: 25a67d8
Author: Nicolas Lalevée <ni...@hibnet.org>
Authored: Fri Jun 30 16:39:39 2017 +0200
Committer: Nicolas Lalevée <ni...@hibnet.org>
Committed: Fri Jun 30 16:39:39 2017 +0200
----------------------------------------------------------------------
asciidoc/ant.adoc | 10 +++++-----
asciidoc/ivyfile.adoc | 4 ++--
asciidoc/ivyfile/artifact-exclude.adoc | 4 +---
asciidoc/ivyfile/artifact.adoc | 8 ++++----
asciidoc/ivyfile/conf.adoc | 2 +-
asciidoc/ivyfile/configurations.adoc | 6 +++---
asciidoc/ivyfile/dependency-artifact.adoc | 8 ++++----
asciidoc/ivyfile/dependency-include.adoc | 2 +-
asciidoc/ivyfile/dependency.adoc | 14 +++++++-------
asciidoc/ivyfile/include.adoc | 4 ++--
asciidoc/templates/document.html.slim | 3 +++
asciidoc/use/artifactproperty.adoc | 4 ++--
asciidoc/use/artifactreport.adoc | 6 +++---
asciidoc/use/buildlist.adoc | 10 +++++-----
asciidoc/use/buildnumber.adoc | 12 ++++++------
asciidoc/use/buildobr.adoc | 8 ++++----
asciidoc/use/cachepath.adoc | 6 +++---
asciidoc/use/checkdepsupdate.adoc | 4 ++--
asciidoc/use/cleancache.adoc | 6 +++---
asciidoc/use/configure.adoc | 8 ++++----
asciidoc/use/convertmanifest.adoc | 2 +-
asciidoc/use/convertpom.adoc | 2 +-
asciidoc/use/deliver.adoc | 2 +-
asciidoc/use/dependencytree.adoc | 2 +-
asciidoc/use/findrevision.adoc | 4 ++--
asciidoc/use/fixdeps.adoc | 4 ++--
asciidoc/use/info.adoc | 12 ++++++------
asciidoc/use/install.adoc | 2 +-
asciidoc/use/listmodules.adoc | 6 +++---
asciidoc/use/makepom.adoc | 4 ++--
asciidoc/use/postresolvetask.adoc | 2 +-
asciidoc/use/publish.adoc | 2 +-
asciidoc/use/report.adoc | 8 ++++----
asciidoc/use/repreport.adoc | 12 ++++++------
asciidoc/use/resolve.adoc | 14 +++++++-------
asciidoc/use/resources.adoc | 14 +++++++-------
asciidoc/use/retrieve.adoc | 16 ++++++++--------
asciidoc/use/settings.adoc | 12 ++++++------
build-release.xml | 4 +++-
39 files changed, 128 insertions(+), 125 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ant.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ant.adoc b/asciidoc/ant.adoc
index c424333..836ecc0 100644
--- a/asciidoc/ant.adoc
+++ b/asciidoc/ant.adoc
@@ -23,7 +23,7 @@ If you use ant version *1.6.0* or superior, you just have to add Ivy's namespace
If you want to make your build handle ivy.jar in either ant lib dir or a local lib dir, you can use a taskdef like this:
-[source]
+[source,xml]
----
<path id="ivy.lib.path">
<fileset dir="path/to/dir/with/ivy/jar" includes="*.jar"/>
@@ -36,7 +36,7 @@ Combined with the antlib definition in the project namespace, it will load Ivy c
If you use ant *1.5.1* or superior, you have to define the tasks you use in your build file. For instance:
-[source]
+[source,xml]
----
<taskdef name="ivy-configure" classname="org.apache.ivy.ant.IvyConfigure"/>
<taskdef name="ivy-resolve" classname="org.apache.ivy.ant.IvyResolve"/>
@@ -55,14 +55,14 @@ If you use an ant version lower than 1.5.1, you can not use the ivy tasks... you
Once your build file is ok to call ivy tasks, the simplest way to use ivy is to call the ivy retrieve task with no parameters:
-[source]
+[source,xml]
----
<ivy:retrieve />
----
This calls ivy with default values, which might be ok in several projects. In fact, it is equivalent to:
-[source]
+[source,xml]
----
<target name="resolve">
<ivy:configure />
@@ -134,7 +134,7 @@ image::images/main-tasks.png[]
Here is a more complete example of build file using Ivy:
-[source]
+[source,xml]
----
<project xmlns:ivy="antlib:org.apache.ivy.ant" name="sample" default="resolve">
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile.adoc b/asciidoc/ivyfile.adoc
index ff413a8..3a662c9 100644
--- a/asciidoc/ivyfile.adoc
+++ b/asciidoc/ivyfile.adoc
@@ -21,7 +21,7 @@ Ivy use is entirely based on _module descriptors_ known as "ivy files". Ivy file
Here is the simplest ivy file you can write:
-[source]
+[source,xml]
----
<ivy-module version="2.0">
@@ -38,7 +38,7 @@ Before beginning the reference itself, it is required to have in mind the termin
For those familiar with xml schema, the schema used to validate ivy files can be found link:http://ant.apache.org/ivy/schemas/ivy.xsd[here]. For those using xsd aware IDE, you can declare the xsd in your ivy files to benefit from code completion / validation:
-[source]
+[source,xml]
----
<?xml version="1.0" encoding="UTF-8"?>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile/artifact-exclude.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/artifact-exclude.adoc b/asciidoc/ivyfile/artifact-exclude.adoc
index daa3315..5f92493 100644
--- a/asciidoc/ivyfile/artifact-exclude.adoc
+++ b/asciidoc/ivyfile/artifact-exclude.adoc
@@ -29,13 +29,11 @@ Note that exclusion is always done AFTER inclusion has been done.
*__since 1.3__* This exclude feature can also be used not only to exclude artifacts but also to exclude whole modules. Indeed when you exclude artifacts, it doesn't avoid ivy to search for the module itself, and to resolve the dependencies of the module. But you can also exclude the whole module, which means that the module will not be downloaded at all, and so its own dependencies will not be resolved. For sure, this is usually done to exclude not a direct dependency but an indirect one. To exclude a whole module, you just have to not specify any artifact name, type and ext in your exclude rule. For instance:
-[source]
+[source,xml]
----
-
<dependency name="A" rev="1.0">
<exclude module="B"/>
</dependency>
-
----
*__since 2.0__* A link:../ivyfile/exclude.html[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).
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile/artifact.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/artifact.adoc b/asciidoc/ivyfile/artifact.adoc
index 891aa55..59ca2b3 100644
--- a/asciidoc/ivyfile/artifact.adoc
+++ b/asciidoc/ivyfile/artifact.adoc
@@ -31,7 +31,7 @@ The configurations in which an artifact is published can be configured in two wa
The two are equivalent, it is only a matter of preference. However, do not mix both for one artifact.
*__since 1.4__* The artifact element has default values for all its attributes, so if you want to declare a default artifact you can just declare it like that:
-[source]
+[source,xml]
----
<artifact />
@@ -76,7 +76,7 @@ If this is the only artifact declared, then it's equivalent to having no publica
== Examples
-[source]
+[source,xml]
----
<artifact />
@@ -89,7 +89,7 @@ Declares an artifact with the name of the module as name, type and ext jar, and
'''
-[source]
+[source,xml]
----
<artifact name="foo-src" type="source" ext="zip" conf="src" />
@@ -102,7 +102,7 @@ Declares an artifact foo-src, of type 'source' with extension 'zip', and publish
'''
-[source]
+[source,xml]
----
<artifact name="foo" url="http://www.acme.com/repository/barbaz/foo-1.2-bar.jar" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile/conf.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/conf.adoc b/asciidoc/ivyfile/conf.adoc
index fe74d63..34540df 100644
--- a/asciidoc/ivyfile/conf.adoc
+++ b/asciidoc/ivyfile/conf.adoc
@@ -67,7 +67,7 @@ This is very useful to build a compile configuration, for instance, forcing the
== Examples
-[source]
+[source,xml]
----
<conf name="core" visibility="private" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile/configurations.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/configurations.adoc b/asciidoc/ivyfile/configurations.adoc
index 52a51b0..0eba2fb 100644
--- a/asciidoc/ivyfile/configurations.adoc
+++ b/asciidoc/ivyfile/configurations.adoc
@@ -66,7 +66,7 @@ See link:#defaultconfmapping[examples below] to clarify the behavior of these tw
When Ivy parses your Ivy file, it will create (internally) modify the configuration mapping of your dependencies.
For instance, say you have:
-[source]
+[source,xml]
----
<configurations defaultconfmapping="conf1->other1;conf2->other2">
@@ -81,7 +81,7 @@ For instance, say you have:
When Ivy parses this file, it will construct the following dependency (in-memory only):
-[source]
+[source,xml]
----
<dependency name="other-module" conf="conf1->other1" />
----
@@ -90,7 +90,7 @@ So, if you now resolve the conf2 configuration, you will only get the other1 dep
But when you set confmappingoverride to true, Ivy will construct the following dependency in memory:
-[source]
+[source,xml]
----
<dependency name="other-module" conf="conf1->other1;conf2->other2" />
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile/dependency-artifact.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency-artifact.adoc b/asciidoc/ivyfile/dependency-artifact.adoc
index 450c7cf..7a55144 100644
--- a/asciidoc/ivyfile/dependency-artifact.adoc
+++ b/asciidoc/ivyfile/dependency-artifact.adoc
@@ -30,7 +30,7 @@ For instance, imagine you have A, B & C master configurations. If you specify ar
Example:
-[source]
+[source,xml]
----
<dependency org="yourorg" name="yourmodule9" rev="9.1" conf="A,B->default">
@@ -75,7 +75,7 @@ Example:
== Examples
-[source]
+[source,xml]
----
<dependency org="foo" name="bar" rev="1.0">
@@ -90,7 +90,7 @@ Declares a dependency on module bar which only publish one artifact: baz.jar.
'''
-[source]
+[source,xml]
----
<dependency org="foo" name="bar" rev="1.0">
@@ -105,7 +105,7 @@ Same as above, except that if the artifact is not found at its standard location
'''
-[source]
+[source,xml]
----
<dependency org="foo" name="bar" rev="1.0">
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile/dependency-include.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency-include.adoc b/asciidoc/ivyfile/dependency-include.adoc
index a740279..6e23aa4 100644
--- a/asciidoc/ivyfile/dependency-include.adoc
+++ b/asciidoc/ivyfile/dependency-include.adoc
@@ -28,7 +28,7 @@ For instance, imagine you have A, B & C master configurations. If you restrict t
Example:
-[source]
+[source,xml]
----
<dependency org="yourorg" name="yourmodule9" rev="9.1" conf="A,B->default">
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile/dependency.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency.adoc b/asciidoc/ivyfile/dependency.adoc
index eea96a5..3378daa 100644
--- a/asciidoc/ivyfile/dependency.adoc
+++ b/asciidoc/ivyfile/dependency.adoc
@@ -180,7 +180,7 @@ where _att_ is the name of the attribute shared by the configurations of the gro
For instance, if you have:
-[source]
+[source,xml]
----
<configurations>
@@ -195,7 +195,7 @@ For instance, if you have:
Then you can do:
-[source]
+[source,xml]
----
<dependency org="acme" name="foo" rev="2.0" conf="*[axis=platform]->default"/>
@@ -299,7 +299,7 @@ See link:../ivyfile/conflicts.html[conflicts manager] for details.
== Examples
-[source]
+[source,xml]
----
<dependency org="jayasoft" name="swtbinding" revision="0.2"/>
@@ -311,7 +311,7 @@ Declares a dependency on the module swtbinding from jayasoft in its revision 0.2
'''
-[source]
+[source,xml]
----
<dependency org="jayasoft" name="swtbinding" branch="fix-103" revision="latest.integration"/>
@@ -323,7 +323,7 @@ Same as above except that it will take the latest revision on the branch 'fix-10
'''
-[source]
+[source,xml]
----
<dependency name="mymodule" revision="latest.integration" conf="test->default"/>
@@ -341,7 +341,7 @@ from the same organisation as the module in which the dependency is declared. Th
'''
-[source]
+[source,xml]
----
<dependency org="apache" name="commons-lang" revision="2.0" force="true" conf="default"/>
@@ -395,7 +395,7 @@ from foo, in revision 3.0. The dependencies of bar will themselves not be includ
'''
-[source]
+[source,xml]
----
<dependency org="foo" name="bar" revision="3.0" changing="true" conf="compile->runtime(default)"/>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/ivyfile/include.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/include.adoc b/asciidoc/ivyfile/include.adoc
index 1c9f505..3ed13a2 100644
--- a/asciidoc/ivyfile/include.adoc
+++ b/asciidoc/ivyfile/include.adoc
@@ -41,7 +41,7 @@ When delivering an ivy file with such an inclusion, the included configuration f
== Examples
-[source]
+[source,xml]
----
<ivy-module version="1.0">
@@ -62,7 +62,7 @@ When delivering an ivy file with such an inclusion, the included configuration f
with included-configurations.xml like this:
-[source]
+[source,xml]
----
<configurations defaultconfmapping="*->@">
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/templates/document.html.slim
----------------------------------------------------------------------
diff --git a/asciidoc/templates/document.html.slim b/asciidoc/templates/document.html.slim
index f85af80..5a8bd92 100644
--- a/asciidoc/templates/document.html.slim
+++ b/asciidoc/templates/document.html.slim
@@ -25,8 +25,11 @@ html lang=(attr :lang, 'en' unless attr? :nolang)
link rel="stylesheet" type="text/css" href="#{page.relativeRoot}style/style.css"
script src="#{page.relativeRoot}js/jquery.pack.js" type="text/javascript"
script src="#{page.relativeRoot}js/jquery.treeview.js" type="text/javascript"
+ link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"
+ script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js" type="text/javascript"
javascript:
$(document).ready(function(){$("#treemenu").Treeview({speed: "fast",store: true});});
+ hljs.initHighlightingOnLoad();
body
div id="body"
table id="header" summary="Navigation elements." border="0" cellpadding="0" cellspacing="0" width="100%"
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/artifactproperty.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/artifactproperty.adoc b/asciidoc/use/artifactproperty.adoc
index 19ab13c..a962f82 100644
--- a/asciidoc/use/artifactproperty.adoc
+++ b/asciidoc/use/artifactproperty.adoc
@@ -49,7 +49,7 @@ _WARNING_: Before 2.0, the behavior was to overwrite the properties. Since 2.0,
Suppose we have one dependency called `mydep` in revision 1.0 publishing two artifacts: `foo.jar` and `bar.jar`.
Then:
-[source]
+[source,xml]
----
<artifactproperty conf="build"
name="[module].[artifact]-[revision]"
@@ -58,7 +58,7 @@ Then:
will set two properties:
-[source]
+[source,properties]
----
mydep.foo-1.0 = my/cache/dir/mydep/foo-1.0.jar
mydep.bar-1.0 = my/cache/dir/mydep/bar-1.0.jar
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/artifactreport.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/artifactreport.adoc b/asciidoc/use/artifactreport.adoc
index 86df3d5..6051e78 100644
--- a/asciidoc/use/artifactreport.adoc
+++ b/asciidoc/use/artifactreport.adoc
@@ -30,7 +30,7 @@ See this link:http://www.jaya.free.fr/ivy/doc/articles/ease-multi-module.html[ar
Here is an example of generate file:
-[source]
+[source,xml]
----
<?xml version="1.0" encoding="UTF-8"?>
<modules>
@@ -74,14 +74,14 @@ Here is an example of generate file:
== Examples
-[source]
+[source,xml]
----
<ivy:artifactreport tofile="${basedir}/path/to/myreport.xml" />
----
Generates the artifact report for all configurations resolved during the last resolve call (in the same build).
-[source]
+[source,xml]
----
<ivy:artifactreport tofile="${basedir}/path/to/myreport.xml" conf="default"/>
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/buildlist.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/buildlist.adoc b/asciidoc/use/buildlist.adoc
index 8d55ab5..54a4055 100644
--- a/asciidoc/use/buildlist.adoc
+++ b/asciidoc/use/buildlist.adoc
@@ -82,7 +82,7 @@ FileSets are used to select sets of files to order.
== Examples
-[source]
+[source,xml]
----
<ivy:buildlist reference="build-path">
<fileset dir="projects" includes="**/build.xml"/>
@@ -93,14 +93,14 @@ Builds a list of `build.xml` files sorted according to the `ivy.xml` files found
This list can then be used like that:
-[source]
+[source,xml]
----
<subant target="build" buildpathref="build-path" />
----
'''
-[source]
+[source,xml]
----
<ivy:buildlist reference="build-path" ivyfilepath="ivy/ivy.xml" reverse="true">
<fileset dir="projects" includes="**/build.xml"/>
@@ -111,7 +111,7 @@ Builds a list of `build.xml` files sorted according to the `ivy.xml` files found
'''
-[source]
+[source,xml]
----
<ivy:buildlist reference="build-path" ivyfilepath="ivy/ivy.xml" root="myapp">
<fileset dir="projects" includes="**/build.xml"/>
@@ -122,7 +122,7 @@ Builds a list of `build.xml` files sorted according to the `ivy.xml` files found
'''
-[source]
+[source,xml]
----
<ivy:buildlist reference="build-path" ivyfilepath="ivy/ivy.xml" leaf="mymodule">
<fileset dir="projects" includes="**/build.xml"/>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/buildnumber.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/buildnumber.adoc b/asciidoc/use/buildnumber.adoc
index cb53e93..5270470 100644
--- a/asciidoc/use/buildnumber.adoc
+++ b/asciidoc/use/buildnumber.adoc
@@ -73,7 +73,7 @@ Note that when asking for revision 1, you can get a revision 10.0. To avoid that
Here is how it can be used (suppose 1.3.1 is the latest version of ivy in the repository):
-[source]
+[source,xml]
----
<ivy:buildnumber organisation="apache" module="ivy" />
----
@@ -82,7 +82,7 @@ will set 1.3.1 as revision, 1.3.2 as new revision, 1 as build number and 2 as ne
'''
-[source]
+[source,xml]
----
<ivy:buildnumber organisation="apache" module="ivy" revision="1.3" />
----
@@ -91,7 +91,7 @@ will set 1.3.1 as revision, 1.3.2 as new revision, 1 as build number and 2 as ne
'''
-[source]
+[source,xml]
----
<ivy:buildnumber organisation="apache" module="ivy" revision="1.2" />
----
@@ -100,7 +100,7 @@ will set 1.2 as revision, 1.2.1 as new revision, no build number and 1 as new bu
'''
-[source]
+[source,xml]
----
<ivy:buildnumber organisation="apache" module="ivy" revision="1." />
----
@@ -109,7 +109,7 @@ will set 1.3.1 as revision, 1.4 as new revision, 3 as build number and 4 as new
'''
-[source]
+[source,xml]
----
<ivy:buildnumber organisation="apache" module="ivy" revision="3." />
----
@@ -118,7 +118,7 @@ will set no revision, 3.0 as new revision, no build number and 0 as new build nu
'''
-[source]
+[source,xml]
----
<ivy:buildnumber organisation="apache" module="ivy" revision="1.4-RC" defaultBuildNumber="1" revSep=""/>
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/buildobr.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/buildobr.adoc b/asciidoc/use/buildobr.adoc
index b8ddc94..ce746a0 100644
--- a/asciidoc/use/buildobr.adoc
+++ b/asciidoc/use/buildobr.adoc
@@ -47,7 +47,7 @@ NB: among every listed files or artifacts, only the actually OSGi bundles will b
== Examples
-[source]
+[source,xml]
----
<ivy:buildobr baseDir="${eclipse.home}" out="${basedir}/target/repo-eclipse.xml" indent="true" />
----
@@ -56,7 +56,7 @@ Builds an indented OBR descriptor from an Eclipse install, with their path relat
'''
-[source]
+[source,xml]
----
<ivy:configure file="ivysettings.xml" />
<ivy:buildobr resolverName="my-file-resolver" out="${basedir}/target/repo-eclipse.xml" />
@@ -66,7 +66,7 @@ Configure an Ivy settings and builds an OBR descriptor from jars resolved by the
'''
-[source]
+[source,xml]
----
<ivy:configure file="ivysettings.xml" />
<ivy:buildobr cacheName="my-cache" out="${basedir}/target/repo-eclipse.xml" />
@@ -76,7 +76,7 @@ Configure an Ivy settings and builds an OBR descriptor from jars contained in th
'''
-[source]
+[source,xml]
----
<ivy:configure file="ivysettings.xml" />
<ivy:resolve file="ivy.xml" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/cachepath.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/cachepath.adoc b/asciidoc/use/cachepath.adoc
index 8ed8e9c..9903993 100644
--- a/asciidoc/use/cachepath.adoc
+++ b/asciidoc/use/cachepath.adoc
@@ -38,7 +38,7 @@ Built path is registered in ant with a given id, and can thus be used like any o
== Examples
-[source]
+[source,xml]
----
<cachepath pathid="default.classpath" conf="default" />
----
@@ -47,7 +47,7 @@ Construct an Ant path composed of all artifacts being part of the default config
'''
-[source]
+[source,xml]
----
<cachepath pathid="default.classpath" conf="default" useOrigin="true" />
----
@@ -56,7 +56,7 @@ Same as before but will use the original location for local artifacts, and the c
'''
-[source]
+[source,xml]
----
<ivy:cachepath organisation="emma" module="emma" revision="2.0.4217" inline="true" conf="ant" pathid="emma.classpath"/>
<taskdef resource="emma_ant.properties" classpathref="emma.classpath" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/checkdepsupdate.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/checkdepsupdate.adoc b/asciidoc/use/checkdepsupdate.adoc
index 1ed6ce7..f418fab 100644
--- a/asciidoc/use/checkdepsupdate.adoc
+++ b/asciidoc/use/checkdepsupdate.adoc
@@ -41,7 +41,7 @@ __mydep__ has a transitive dependency on __mytransitivedependency__ in revision
Then:
-[source]
+[source,xml]
----
<checkdepsupdate />
----
@@ -57,7 +57,7 @@ Dependencies updates available :
Same example with transitive dependencies :
-[source]
+[source,xml]
----
<checkdepsupdate showTransitive="true" />
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/cleancache.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/cleancache.adoc b/asciidoc/use/cleancache.adoc
index e4a0590..cca9fdb 100644
--- a/asciidoc/use/cleancache.adoc
+++ b/asciidoc/use/cleancache.adoc
@@ -22,7 +22,7 @@ Cleans the Ivy cache.
This task is roughly equivalent to:
-[source]
+[source,xml]
----
<delete dir="${ivy.cache.dir}" />
----
@@ -41,14 +41,14 @@ This task loads the Ivy settings as any other post settings task, and allows eas
== Examples
-[source]
+[source,xml]
----
<ivy:cleancache />
----
Cleans the cache directory as defined in the loaded settings (by default `~/.ivy2/cache`)
-[source]
+[source,xml]
----
<ivy:cleancache settingsRef="mysettings"/>
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/configure.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/configure.adoc b/asciidoc/use/configure.adoc
index 7b19738..1413ac5 100644
--- a/asciidoc/use/configure.adoc
+++ b/asciidoc/use/configure.adoc
@@ -56,7 +56,7 @@ It's also possible to configure authentication settings for multiple urls. This
=== Simplest settings
-[source]
+[source,xml]
----
<ivy:configure />
----
@@ -65,21 +65,21 @@ Use either `${ivy.settings.file}` if it exists, or the link:../samples/ivysettin
=== Configure with a file
-[source]
+[source,xml]
----
<ivy:configure file="myconffile.xml" />
----
=== Configure with an url
-[source]
+[source,xml]
----
<ivy:configure url="http://mysite.com/myconffile.xml" />
----
=== Configure multiple URLs which require autentication
-[source]
+[source,xml]
----
<ivy:configure file="path/to/my/ivysettings.xml">
<credentials host="myhost.com" realm="My Realm" username="myuser" passwd="mypasswd" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/convertmanifest.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/convertmanifest.adoc b/asciidoc/use/convertmanifest.adoc
index 6bd6dd7..29d8a27 100644
--- a/asciidoc/use/convertmanifest.adoc
+++ b/asciidoc/use/convertmanifest.adoc
@@ -30,7 +30,7 @@
== Examples
-[source]
+[source,xml]
----
<ivy:convertmanifest manifest="META-INF/MANIFEST.MF" ivyFile="ivy.xml" />
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/convertpom.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/convertpom.adoc b/asciidoc/use/convertpom.adoc
index 8f7e3cc..5204317 100644
--- a/asciidoc/use/convertpom.adoc
+++ b/asciidoc/use/convertpom.adoc
@@ -30,7 +30,7 @@
== Examples
-[source]
+[source,xml]
----
<ivy:convertpom pomFile="pom.xml" ivyFile="ivy.xml" />
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/deliver.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/deliver.adoc b/asciidoc/use/deliver.adoc
index 579f405..6bb38c1 100644
--- a/asciidoc/use/deliver.adoc
+++ b/asciidoc/use/deliver.adoc
@@ -94,7 +94,7 @@ It can also be useful if you want to trigger a recursive delivery and then ensur
Deliver an ivy file without the private configurations:
-[source]
+[source,xml]
----
<deliver conf="*(public)" />
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/dependencytree.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/dependencytree.adoc b/asciidoc/use/dependencytree.adoc
index 75e039e..99493d3 100644
--- a/asciidoc/use/dependencytree.adoc
+++ b/asciidoc/use/dependencytree.adoc
@@ -43,7 +43,7 @@ __mydep__ has a transitive dependency on __mytransitivedependency__ in revision
Then:
-[source]
+[source,xml]
----
<dependencytree />
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/findrevision.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/findrevision.adoc b/asciidoc/use/findrevision.adoc
index 1bcca9f..2ff3e49 100644
--- a/asciidoc/use/findrevision.adoc
+++ b/asciidoc/use/findrevision.adoc
@@ -38,7 +38,7 @@ If the module is not found the property is not set.
== Examples
-[source]
+[source,xml]
----
<ivy:findrevision organisation="apache" module="ivy" revision="latest.integration"/>
----
@@ -47,7 +47,7 @@ finds the latest version of ivy available in the repository and sets the propert
'''
-[source]
+[source,xml]
----
<ivy:findrevision organisation="apache" module="ivy" revision="1.0+"/>
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/fixdeps.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/fixdeps.adoc b/asciidoc/use/fixdeps.adoc
index 3f7ca7a..51c553a 100644
--- a/asciidoc/use/fixdeps.adoc
+++ b/asciidoc/use/fixdeps.adoc
@@ -56,7 +56,7 @@ These elements takes two attributes: +
== Examples
-[source]
+[source,xml]
----
<ivy:fixdeps tofile="ivy-fixed.xml" />
----
@@ -65,7 +65,7 @@ Simple fix of some dependencies.
'''
-[source]
+[source,xml]
----
<ivy:fixdeps tofile="ivy-fixed.xml">
<keep org="com.acme" module="mymodule" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/info.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/info.adoc b/asciidoc/use/info.adoc
index 1cf7785..385c1e5 100644
--- a/asciidoc/use/info.adoc
+++ b/asciidoc/use/info.adoc
@@ -78,7 +78,7 @@ Yes, if you are retrieving information about a module from an ivy repository.
Given this `ivy.xml` file:
-[source]
+[source,xml]
----
<ivy-module version="1.0" xmlns:e="http://ant.apache.org/ivy/extra">
<info organisation="apache"
@@ -103,14 +103,14 @@ Given this `ivy.xml` file:
</ivy-module>
----
-[source]
+[source,xml]
----
<ivy:info file="${basedir}/path/to/ivy.xml" />
----
Parses `+++${basedir}/path/to/ivy.xml+++` and set properties as described above accordingly:
-[source]
+[source,properties]
----
ivy.organisation=apache
ivy.module=info-all
@@ -134,21 +134,21 @@ ivy.artifact.2.extra.data=client
Given the same ivy module in a repository:
-[source]
+[source,xml]
----
<ivy:info organisation="apache" module="info-all" revision="1.0" />
----
will set the exact same set of properties as above. Using:
-[source]
+[source,xml]
----
<ivy:info organisation="apache" module="info-all" revision="1.0" property="infotest"/>
----
will set:
-[source]
+[source,properties]
----
infotest.organisation=apache
infotest.module=info-all
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/install.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/install.adoc b/asciidoc/use/install.adoc
index 8d9330d..d8fbf69 100644
--- a/asciidoc/use/install.adoc
+++ b/asciidoc/use/install.adoc
@@ -49,7 +49,7 @@ For more details about this task and its usage see the link:../tutorial/build-re
== Examples
-[source]
+[source,xml]
----
<ivy:install organisation="apache" module="commons-lang" revision="2.0" from="ivyrep" to="myfsresolver"/>
----
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/listmodules.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/listmodules.adoc b/asciidoc/use/listmodules.adoc
index 659059c..a94e824 100644
--- a/asciidoc/use/listmodules.adoc
+++ b/asciidoc/use/listmodules.adoc
@@ -42,7 +42,7 @@ To know if a module matches the criteria ivy will use the configured link:../con
== Examples
-[source]
+[source,xml]
----
<ivy:listmodules organisation="apache" module="ivy" revision="*" property="ivy.[revision]" value="found"/>
----
@@ -51,7 +51,7 @@ will find all revisions of the module ivy in the org apache, and create one prop
'''
-[source]
+[source,xml]
----
<ivy:listmodules organisation="*" module="ivy*" revision="1.0" matcher="glob" property="modules.[module]" value="[organisation]"/>
----
@@ -59,7 +59,7 @@ will find all revisions of the module ivy in the org apache, and create one prop
use the glob matcher to find all modules which name starts with ivy with revision 1.0, and sets for each a property with module name found and organisation for value.
Example:
-[source]
+[source,properties]
----
modules.ivy=apache
modules.ivyde=apache
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/makepom.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/makepom.adoc b/asciidoc/use/makepom.adoc
index 9991b7b..1a03e37 100644
--- a/asciidoc/use/makepom.adoc
+++ b/asciidoc/use/makepom.adoc
@@ -47,7 +47,7 @@ Note that each property can be given a value manually in the Ant build file. In
The default template that ships with Ivy looks like this:
-[source]
+[source,xml]
----
${ivy.pom.license}
${ivy.pom.header}
@@ -104,7 +104,7 @@ These elements takes the following attributes: +
== Examples
-[source]
+[source,xml]
----
<ivy:makepom ivyfile="${basedir}/path/to/ivy.xml" pomfile="${basedir}/path/to/module.pom" conf="default,runtime">
<mapping conf="default" scope="compile"/>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/postresolvetask.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/postresolvetask.adoc b/asciidoc/use/postresolvetask.adoc
index d8001d9..232b969 100644
--- a/asciidoc/use/postresolvetask.adoc
+++ b/asciidoc/use/postresolvetask.adoc
@@ -88,7 +88,7 @@ There is one important difference with the ivy.xml's link:../ivyfile/dependencie
== Examples
-[source]
+[source,xml]
----
<ivy:cachepath organisation="emma" module="emma" revision="2.0.4217" inline="true" conf="ant" pathid="emma.classpath"/>
<taskdef resource="emma_ant.properties" classpathref="emma.classpath" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/publish.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/publish.adoc b/asciidoc/use/publish.adoc
index d9ceb3a..61f27dc 100644
--- a/asciidoc/use/publish.adoc
+++ b/asciidoc/use/publish.adoc
@@ -72,7 +72,7 @@ The source artifact pattern can be specified either as an attribute on the task
== Examples
-[source]
+[source,xml]
----
<ivy:publish resolver="local" pubrevision="1.0">
<artifacts pattern="build/artifacts/jars/[artifact].[ext]" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/report.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/report.adoc b/asciidoc/use/report.adoc
index 24edd05..fe16ee6 100644
--- a/asciidoc/use/report.adoc
+++ b/asciidoc/use/report.adoc
@@ -52,7 +52,7 @@ Then following a few link:../yed.html[simple steps] you can obtain a graph like
To generate a HTML and graphml report:
-[source]
+[source,xml]
----
<report conf="compile" />
----
@@ -61,7 +61,7 @@ To generate a HTML and graphml report:
To generate a HTML report only:
-[source]
+[source,xml]
----
<report conf="compile" graph="false" />
----
@@ -70,14 +70,14 @@ To generate a HTML report only:
To generate an XML report using a custom stylesheet:
-[source]
+[source,xml]
----
<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml" />
----
To generate an XML report using a custom stylesheet which needs some parameters:
-[source]
+[source,xml]
----
<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml">
<param name="param1" expression="value1" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/repreport.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/repreport.adoc b/asciidoc/use/repreport.adoc
index 6cbd2ae..b29e43a 100644
--- a/asciidoc/use/repreport.adoc
+++ b/asciidoc/use/repreport.adoc
@@ -54,7 +54,7 @@ Moreover, to be able to list organizations, this task requires an [organisation]
To generate a xml report for all the latest versions of all the modules in your repository:
-[source]
+[source,xml]
----
<ivy:repreport />
----
@@ -63,7 +63,7 @@ To generate a xml report for all the latest versions of all the modules in your
To generate a graphml report for all the latest versions of all the modules in your repository:
-[source]
+[source,xml]
----
<ivy:repreport xml="false" graph="true" />
----
@@ -72,7 +72,7 @@ To generate a graphml report for all the latest versions of all the modules in y
To generate a xml report for all the latest versions of the modules from the organisation foo in your repository:
-[source]
+[source,xml]
----
<ivy:repreport organisation="foo" />
----
@@ -81,7 +81,7 @@ To generate a xml report for all the latest versions of the modules from the org
To generate a xml report for all the versions on the 1.x stream of the modules named bar* from the organisation foo in your repository:
-[source]
+[source,xml]
----
<ivy:repreport organisation="foo" module="bar*" revision="1.+" matcher="glob" />
----
@@ -90,7 +90,7 @@ To generate a xml report for all the versions on the 1.x stream of the modules n
To generate an XML report using a custom stylesheet:
-[source]
+[source,xml]
----
<ivy:repreport xsl="true" xslfile="my-custom-stylesheet.xsl" xslext="xml" />
----
@@ -99,7 +99,7 @@ To generate an XML report using a custom stylesheet:
To generate an XML report using a custom stylesheet which needs some parameters:
-[source]
+[source,xml]
----
<ivy:repreport xsl="true" xslfile="my-custom-stylesheet.xsl" xslext="xml">
<param name="param1" expression="value1" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/resolve.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/resolve.adoc b/asciidoc/use/resolve.adoc
index d9bf0ff..4e3d9f3 100644
--- a/asciidoc/use/resolve.adoc
+++ b/asciidoc/use/resolve.adoc
@@ -153,7 +153,7 @@ There is one important difference with the ivy.xml's link:../ivyfile/dependencie
== Examples
-[source]
+[source,xml]
----
<ivy:resolve file="path/to/ivy.xml"/>
----
@@ -162,7 +162,7 @@ Resolve all dependencies declared in path/to/ivy.xml file.
'''
-[source]
+[source,xml]
----
<ivy:resolve file="path/to/ivy.xml" transitive="false" />
----
@@ -171,7 +171,7 @@ Same as above, but with transitive dependencies disabled.
'''
-[source]
+[source,xml]
----
<ivy:resolve file="path/to/ivy.xml" conf="default, test"/>
----
@@ -180,7 +180,7 @@ Resolve the dependencies declared in the configuration `default` and `test` of t
'''
-[source]
+[source,xml]
----
<ivy:resolve file="path/to/ivy.xml" type="jar"/>
----
@@ -189,7 +189,7 @@ Resolve all dependencies declared in `path/to/ivy.xml` file, but download only `
'''
-[source]
+[source,xml]
----
<ivy:resolve organisation="apache" module="commons-lang" revision="2+" inline="true" />
----
@@ -198,7 +198,7 @@ Resolve the `commons-lang` module revision 2+ from the repository, with its depe
'''
-[source]
+[source,xml]
----
<ivy:resolve>
<dependency org="apache" name="commons-lang" rev="2+" />
@@ -211,7 +211,7 @@ Resolve of both `commons-lang` and `commons-logging`, with their dependencies bu
'''
-[source]
+[source,xml]
----
<ivy:resolve>
<dependency org="org.slf4j" module="slf4j" rev="1.6" conf="api,log4j" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/resources.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/resources.adoc b/asciidoc/use/resources.adoc
index 657cb57..96fc53b 100644
--- a/asciidoc/use/resources.adoc
+++ b/asciidoc/use/resources.adoc
@@ -24,7 +24,7 @@ This datatype share the same attributes, child elements and behaviour of a link:
== Examples
-[source]
+[source,xml]
----
<ivy:resources file="path/to/ivy.xml"/>
----
@@ -33,7 +33,7 @@ Build a resource collection of every artifacts of all dependencies declared in `
'''
-[source]
+[source,xml]
----
<ivy:resources file="path/to/ivy.xml" transitive="false" />
----
@@ -42,7 +42,7 @@ Same as above, but with transitive dependencies disabled.
'''
-[source]
+[source,xml]
----
<ivy:resources file="path/to/ivy.xml" conf="default, test"/>
----
@@ -51,7 +51,7 @@ Build a resource collection of every artifacts of the dependencies declared in t
'''
-[source]
+[source,xml]
----
<ivy:resources file="path/to/ivy.xml" type="jar"/>
----
@@ -60,7 +60,7 @@ Build a resource collection of every `jar` artifact of all dependencies declared
'''
-[source]
+[source,xml]
----
<ivy:resources organisation="apache" module="commons-lang" revision="2+" inline="true" />
----
@@ -69,7 +69,7 @@ Build a resource collection of every artifacts of `commons-lang` module revision
'''
-[source]
+[source,xml]
----
<ivy:resources>
<dependency org="apache" module="commons-lang" rev="2+" />
@@ -82,7 +82,7 @@ Build a resource collection of every artifacts of both `commons-lang` and `commo
'''
-[source]
+[source,xml]
----
<ivy:resources>
<dependency org="org.slf4j" module="slf4j" rev="1.6" conf="api,log4j" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/retrieve.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/retrieve.adoc b/asciidoc/use/retrieve.adoc
index b873aa8..024c7fe 100644
--- a/asciidoc/use/retrieve.adoc
+++ b/asciidoc/use/retrieve.adoc
@@ -71,7 +71,7 @@ Available options are the same as for link:../use/resolve.html[resolve] when use
== Examples
-[source]
+[source,xml]
----
<ivy:retrieve />
----
@@ -80,7 +80,7 @@ Retrieves dependencies using default parameters. This usually retrieves all the
'''
-[source]
+[source,xml]
----
<ivy:retrieve pattern="${lib.dir}/[conf]/[artifact].[ext]"/>
----
@@ -102,7 +102,7 @@ Note that if a dependency is required in the two configurations, it will be copi
'''
-[source]
+[source,xml]
----
<ivy:retrieve pattern="${lib.dir}/[conf]/[artifact].[ext]" sync="true" />
----
@@ -136,7 +136,7 @@ With no synchronisation, commons-logging would not have been removed by the call
'''
-[source]
+[source,xml]
----
<ivy:retrieve pattern="${lib.dir}/[type]/[artifact]-[revision].[ext]" conf="runtime"/>
----
@@ -157,7 +157,7 @@ lib
'''
-[source]
+[source,xml]
----
<ivy:retrieve pattern="${lib.dir}/[organisation]/[artifact]-[revision].[ext]" />
----
@@ -174,7 +174,7 @@ lib
junit-4.1.zip
----
-[source]
+[source,xml]
----
<ivy:retrieve pattern="${lib.dir}/[orgPath]/[artifact]-[revision].[ext]" />
----
@@ -194,7 +194,7 @@ lib
'''
-[source]
+[source,xml]
----
<ivy:retrieve organisation="foo" module="bar" inline="true" pattern="${my.install.dir}/[artifact].[ext]"/>
----
@@ -203,7 +203,7 @@ Resolves and retrieve the latest version of the module bar and its dependencies
'''
-[source]
+[source,xml]
----
<ivy:retrieve pattern="lib/[artifact]-[revision].[ext]">
<firstmatchmapper>
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/asciidoc/use/settings.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/use/settings.adoc b/asciidoc/use/settings.adoc
index 10cf985..b358d4c 100644
--- a/asciidoc/use/settings.adoc
+++ b/asciidoc/use/settings.adoc
@@ -30,7 +30,7 @@ All Ivy variables set during the settings are available in the Ant project as lo
Moreover, the variables are exposed under two names: the variable name, and the variable name suffixed by dot + the settings id.
For instance, if you load a settings with the id `myid`, and define a variable `my.variable=my.value` in the Ivy settings, both `my.variable` and `my.variable.myid` will now be available as properties in Ant and equal to `my.value`. If you later load another settings with the id `yourid`, and in this settings assign the variable `my.variable` the value `your.value`, in the Ant project you will have:
-[source]
+[source,properties]
----
my.variable=my.value
my.variable.myid=my.value
@@ -67,7 +67,7 @@ A special attention should be applied when you have a multi-project build with `
=== Simplest settings
-[source]
+[source,xml]
----
<ivy:settings />
----
@@ -78,21 +78,21 @@ This simplest setting is implicit.
=== Configure with a file
-[source]
+[source,xml]
----
<ivy:settings file="mysettings.xml" />
----
=== Configure with an url
-[source]
+[source,xml]
----
<ivy:settings url="http://mysite.com/mysettings.xml" />
----
=== Configure multiple realms which require autentication
-[source]
+[source,xml]
----
<ivy:settings file="path/to/my/ivysettings.xml">
<credentials host="myhost.com" realm="My Realm" username="myuser" passwd="mypasswd" />
@@ -104,7 +104,7 @@ This simplest setting is implicit.
You can use multiple ivy settings during a build. Then every ivy task should specify the settings it uses using the `settingsRef` attribute.
-[source]
+[source,xml]
----
<ivy:settings id="ivy.normal.settings" file="normal_settings.xml" />
<ivy:settings id="ivy.release.settings" file="release_settings.xml" />
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/5bc940ca/build-release.xml
----------------------------------------------------------------------
diff --git a/build-release.xml b/build-release.xml
index baf8f3f..4b138d3 100644
--- a/build-release.xml
+++ b/build-release.xml
@@ -168,7 +168,9 @@
<target name="generate-doc" depends="generate-tutorial-output,default-version">
<ivy:cachepath pathid="asciidoctor.path" organisation="org.asciidoctor" module="asciidoctor-ant" revision="1.5.4" inline="true"/>
<taskdef uri="antlib:org.asciidoctor.ant" resource="org/asciidoctor/ant/antlib.xml" classpathref="asciidoctor.path"/>
- <asciidoctor:convert sourceDirectory="${doc.src.dir}" outputDirectory="${doc.build.dir}" backend="xhtml5" templateDir="${doc.src.dir}/templates" preserveDirectories="true">
+ <asciidoctor:convert sourceDirectory="${doc.src.dir}" outputDirectory="${doc.build.dir}" backend="xhtml5"
+ templateDir="${doc.src.dir}/templates" preserveDirectories="true"
+ sourceHighlighter="highlightjs">
<attribute key="basedir" value="${doc.src.dir}"/>
<attribute key="imagesdir" value=""/>
<attribute key="version" value="${build.version}" />
[2/3] ant-ivy git commit: review the ivy file part of the doc about
the use of code formatting
Posted by hi...@apache.org.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/manager.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/manager.adoc b/asciidoc/ivyfile/manager.adoc
index ab05ea4..a1d6f60 100644
--- a/asciidoc/ivyfile/manager.adoc
+++ b/asciidoc/ivyfile/manager.adoc
@@ -19,33 +19,23 @@
*Tag:* manager *Parent:* link:../ivyfile/conflicts.html[conflicts]
-
-
*__(since 2.0)__* the conflicts section is deprecated. Use the link:../ivyfile/conflict.html[conflict] instead.
Specify a a conflict manager for one or several dependencies.
-The way to specify a conflict manager is by giving indication to which dependencies
-the conflict manager applies (by giving organisation and module names or name regexp),
-and then specifying the conflict manager, either by giving its name or by
-specifying a fixed revision list, in which case a fixed conflicts manager is used.
-
-
+The way to specify a conflict manager is by giving indication to which dependencies the conflict manager applies (by giving organisation and module names or name regexp), and then specifying the conflict manager, either by giving its name or by specifying a fixed revision list, in which case a fixed conflicts manager is used.
See link:../ivyfile/conflicts.html[Conflicts Manager] for details on conflicts manager in general.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|org|the name, or an expression matching the name of organisation to which this conflict manager should apply (see matcher attribute below)|No, defaults to '`$$*$$`' (match all)
-|module|the name, or an expression matching the name of module to which this conflict manager should apply (see matcher attribute below)|No, defaults to '`$$*$$`' (match all)
-|name|the name of the conflict manager to use|Exactly one of two
+|org|the name, or an expression matching the name of organisation to which this conflict manager should apply (see `matcher` attribute below)|No, defaults to `$$*$$` (match all)
+|module|the name, or an expression matching the name of module to which this conflict manager should apply (see `matcher` attribute below)|No, defaults to `$$*$$` (match all)
+|name|the name of the conflict manager to use
+.2+.^|Exactly one of two
|rev|a comma separated list of revisions this conflict manager should select
-|matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used *__since 1.3__*|No, defaults to exactOrRegexp in pre 1.3 ivy files, and exact in 1.3 and superior
+|matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used *__since 1.3__*|No, defaults to `exactOrRegexp` in pre 1.3 ivy files, and `exact` in 1.3 and superior
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/mapped.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/mapped.adoc b/asciidoc/ivyfile/mapped.adoc
index 58c7bdf..b7ffa3b 100644
--- a/asciidoc/ivyfile/mapped.adoc
+++ b/asciidoc/ivyfile/mapped.adoc
@@ -19,19 +19,14 @@
*Tag:* mapped *Parent:* link:../ivyfile/dependency-conf.html[conf]
-
-
Describes a mapped dependency configuration for a master configuration.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the dependency configuration mapped.
- '`$$*$$`' wildcard can be used to designate all configurations of this module|Yes
-|=======
-
+`$$*$$` wildcard can be used to designate all configurations of this module|Yes
+|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/override.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/override.adoc b/asciidoc/ivyfile/override.adoc
index 2f036f5..86bc79e 100644
--- a/asciidoc/ivyfile/override.adoc
+++ b/asciidoc/ivyfile/override.adoc
@@ -19,8 +19,6 @@
*Tag:* override *Parent:* link:../ivyfile/dependencies.html[dependencies]
-
-
*__(since 2.0)__*
Specify an override mediation rule, overriding the revision and/or branch requested for a transitive dependency.
@@ -31,17 +29,14 @@ Overriding is done before any else, in a phase called dependency descriptor medi
Note that even though no attribute is required, it makes no sense to set no attributes at all. It would mean that overriding is triggered for all transitive dependencies, but doesn't override anything. Most of the time, at least org or module should be set to override only a subset of transitive dependencies, and at least branch or rev should be set to actually override something.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|org|the name, or an expression matching the name of organisation to which overriding should be applied (see matcher attribute below)|No, defaults to '`$$*$$`' (match all)
-|module|the name, or an expression matching the name of module to which overriding should be applied (see matcher attribute below)|No, defaults to '`$$*$$`' (match all)
+|org|the name, or an expression matching the name of organisation to which overriding should be applied (see matcher attribute below)|No, defaults to `$$*$$` (match all)
+|module|the name, or an expression matching the name of module to which overriding should be applied (see matcher attribute below)|No, defaults to `$$*$$` (match all)
|branch|the branch to set for all the overriden dependency descriptors|No, by default branch is not overriden
|rev|the revision to set for all the overriden dependency descriptors|No, by default revision is not overriden
-|matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used|No, defaults to exact
+|matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used|No, defaults to `exact`
|=======
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/publications.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/publications.adoc b/asciidoc/ivyfile/publications.adoc
index 8f1dede..87cbba0 100644
--- a/asciidoc/ivyfile/publications.adoc
+++ b/asciidoc/ivyfile/publications.adoc
@@ -19,33 +19,25 @@
*Tag:* publications *Parent:* link:../ivyfile.html[ivy-module]
-
-
-Container for artifact elements, used to describe the artifacts published by this module.
+Container for `artifact` elements, used to describe the artifacts published by this module.
If this container is not present, it is assumed that the module has one artifact, with the same name as the module, and published in all module configurations.
-
-Thus if you have a module which publishes no artifacts (a sort of virtual module, made only to integrate several other modules as a whole), you have to include a publications element with no artifact sub element.
+Thus if you have a module which publishes no artifacts (a sort of virtual module, made only to integrate several other modules as a whole), you have to include a publications element with no `artifact` sub element.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|defaultconf|comma separated list of public configurations in which artifacts are published by default (when no specific configurations are set on the artifact element).
- '`$$*$$`' wildcard can be used to designate all public configurations of this module. *__since 2.0__*|No, defaults to '`$$*$$`'
+ `$$*$$` wildcard can be used to designate all public configurations of this module. *__since 2.0__*|No, defaults to `$$*$$`
|=======
-
== Child elements
-
[options="header",cols="20%,60%,20%"]
|=======
|Element|Description|Cardinality
|link:../ivyfile/artifact.html[artifact]|declares a published artifact for this module|0..n
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/repository.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/repository.adoc b/asciidoc/ivyfile/repository.adoc
index ca0d056..9a339b8 100644
--- a/asciidoc/ivyfile/repository.adoc
+++ b/asciidoc/ivyfile/repository.adoc
@@ -19,22 +19,16 @@
*Tag:* repository *Parent:* link:../ivyfile/info.html[info]
-
-
-Gives information about a public repository where the module can be found. This information
-is given as an indication, repositories being able to be down over time.
+Gives information about a public repository where the module can be found. This information is given as an indication, repositories being able to be down over time.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the repository. Try to respect spelling for common repositories (ibiblio, ivyrep, ...)|Yes
|url|an url pointing to the repository.|Yes
|pattern|an ivy pattern to find modules on this repository|No, but it's recommended to indicate it.
-|ivys|true if ivy file can be found on this repository|No, defaults to false.
-|artifacts|true if module artifacts can be found on this repository|No, defaults to false.
+|ivys|`true` if ivy file can be found on this repository|No, defaults to `false`.
+|artifacts|`true` if module artifacts can be found on this repository|No, defaults to `false`.
|=======
-
-
[3/3] ant-ivy git commit: review the ivy file part of the doc about
the use of code formatting
Posted by hi...@apache.org.
review the ivy file part of the doc about the use of code formatting
Project: http://git-wip-us.apache.org/repos/asf/ant-ivy/repo
Commit: http://git-wip-us.apache.org/repos/asf/ant-ivy/commit/0851fa77
Tree: http://git-wip-us.apache.org/repos/asf/ant-ivy/tree/0851fa77
Diff: http://git-wip-us.apache.org/repos/asf/ant-ivy/diff/0851fa77
Branch: refs/heads/master
Commit: 0851fa77618358ee978fc90a61082740526d1dc8
Parents: 5bc940c
Author: Nicolas Lalevée <ni...@hibnet.org>
Authored: Fri Jun 30 17:53:14 2017 +0200
Committer: Nicolas Lalevée <ni...@hibnet.org>
Committed: Fri Jun 30 17:53:14 2017 +0200
----------------------------------------------------------------------
asciidoc/ivyfile.adoc | 34 +--
asciidoc/ivyfile/artifact-conf.adoc | 8 +-
asciidoc/ivyfile/artifact-exclude-conf.adoc | 6 -
asciidoc/ivyfile/artifact-exclude.adoc | 22 +-
asciidoc/ivyfile/artifact.adoc | 37 +--
asciidoc/ivyfile/conf.adoc | 30 +--
asciidoc/ivyfile/configurations.adoc | 41 ++-
asciidoc/ivyfile/conflict.adoc | 16 +-
asciidoc/ivyfile/conflicts.adoc | 14 +-
asciidoc/ivyfile/dependencies.adoc | 22 +-
asciidoc/ivyfile/dependency-artifact-conf.adoc | 4 -
asciidoc/ivyfile/dependency-artifact.adoc | 30 +--
asciidoc/ivyfile/dependency-conf.adoc | 17 +-
asciidoc/ivyfile/dependency-include-conf.adoc | 4 -
asciidoc/ivyfile/dependency-include.adoc | 19 +-
asciidoc/ivyfile/dependency.adoc | 266 +++-----------------
asciidoc/ivyfile/description.adoc | 5 -
asciidoc/ivyfile/exclude.adoc | 20 +-
asciidoc/ivyfile/extends.adoc | 16 +-
asciidoc/ivyfile/include.adoc | 16 +-
asciidoc/ivyfile/info.adoc | 8 +-
asciidoc/ivyfile/ivyauthor.adoc | 5 -
asciidoc/ivyfile/license.adoc | 4 -
asciidoc/ivyfile/manager.adoc | 22 +-
asciidoc/ivyfile/mapped.adoc | 9 +-
asciidoc/ivyfile/override.adoc | 11 +-
asciidoc/ivyfile/publications.adoc | 14 +-
asciidoc/ivyfile/repository.adoc | 12 +-
28 files changed, 157 insertions(+), 555 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile.adoc b/asciidoc/ivyfile.adoc
index 3a662c9..dcd38e4 100644
--- a/asciidoc/ivyfile.adoc
+++ b/asciidoc/ivyfile.adoc
@@ -23,13 +23,11 @@ Here is the simplest ivy file you can write:
[source,xml]
----
-
<ivy-module version="2.0">
<info organisation="myorg"
module="mymodule"
/>
</ivy-module>
-
----
If you want to see a sample module descriptor using almost all possibilities of ivy files, check this one, link:samples/ivy-sample-xslt.xml[with] or link:samples/ivy-sample.xml[without] xslt.
@@ -40,7 +38,6 @@ For those familiar with xml schema, the schema used to validate ivy files can be
[source,xml]
----
-
<?xml version="1.0" encoding="UTF-8"?>
<ivy-module version="2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -50,35 +47,26 @@ For those familiar with xml schema, the schema used to validate ivy files can be
module="mymodule"
/>
</ivy-module>
-
----
-
== Dynamic and [[resolved]]resolved ivy files
-
A module descriptor (ivy file) is needed both before and after the publication of each revision of the module. Depending on the case, a module descriptor can be either _dynamic_ or _resolved_.
-
=== Dynamic descriptor for module development
-
-During the module development time, between publications, the descriptor helps in managing all the possibly changing dependencies of the module. For that purpose, development time ivy files can declare dynamic dependencies to allow for a greater flexibility of use. link:ivyfile/dependency.html#revision[Dynamic revision] references like "latest.integration" or "1.0.+" are possible and may resolve to different artifacts at different times. Variables can be used for even more flexibility. Development time ivy files are hence called "dynamic", because they can produce different results over time. The dynamic ivy files are normally considered source files and kept with them (under SCM control).
-
+During the module development time, between publications, the descriptor helps in managing all the possibly changing dependencies of the module. For that purpose, development time ivy files can declare dynamic dependencies to allow for a greater flexibility of use. link:ivyfile/dependency.html#revision[Dynamic revision] references like `latest.integration` or `1.0.+` are possible and may resolve to different artifacts at different times. Variables can be used for even more flexibility. Development time ivy files are hence called _dynamic_, because they can produce different results over time. The dynamic ivy files are normally considered source files and kept with them (under SCM control).
=== Resolved descriptors for publishing
-
-At each publication, another kind of a module descriptor is needed to document the dependencies of the particular published revision of the module. For that purpose, the descriptor usually needs to be fixed as its dependencies should no longer change. In doing so, the published module revision gets fixed, explicitly resolved dependencies. No variables are allowed either. Such publication-friendly, static ivy files are called "resolved", because they should always produce the same results. The resolved ivy files are comparable to published artifacts and are kept with them in a repository.
+At each publication, another kind of a module descriptor is needed to document the dependencies of the particular published revision of the module. For that purpose, the descriptor usually needs to be fixed as its dependencies should no longer change. In doing so, the published module revision gets fixed, explicitly resolved dependencies. No variables are allowed either. Such publication-friendly, static ivy files are called _resolved_, because they should always produce the same results. The resolved ivy files are comparable to published artifacts and are kept with them in a repository.
Resolved ivy files are generated from their original dynamic ivy files via the link:use/deliver.html[deliver] task.
Note that although it is technically possible to publish module revisions with dynamic ivy files, it is not a generally recommended practice.
-
== Hierarchical Index
-
* *ivy-module*
** link:ivyfile/info.html[info]
*** link:ivyfile/license.html[license]
@@ -106,11 +94,6 @@ Note that although it is technically possible to publish module revisions with d
** link:ivyfile/conflicts.html[conflicts]
*** link:ivyfile/manager.html[manager]
-
-
-
-
-
== ivy-module
*Tag:* ivy-module
@@ -119,23 +102,20 @@ The root tag of any ivy file (module descriptor).
=== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|version|the version of the ivy file specification - should be '2.0' with current version of ivy|Yes
|=======
-
=== Child elements
-
[options="header"]
|=======
|Element|Description|Cardinality
-|info|contains information about the described module|1
-|configurations|container for configuration elements|0..1
-|publications|container for published artifact elements|0..1
-|dependencies|container for dependency elements|0..1
-|conflicts|section to configure the conflict managers to use|0..1
+|link:ivyfile/info.html[info]|contains information about the described module|1
+|link:ivyfile/configurations.html[configurations]|container for configuration elements|0..1
+|link:ivyfile/publications.html[publications]|container for published artifact elements|0..1
+|link:ivyfile/dependencies.html[dependencies]|container for dependency elements|0..1
+|link:ivyfile/conflicts.html[conflicts]|section to configure the conflict managers to use|0..1
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/artifact-conf.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/artifact-conf.adoc b/asciidoc/ivyfile/artifact-conf.adoc
index ffe5ed9..4ba0475 100644
--- a/asciidoc/ivyfile/artifact-conf.adoc
+++ b/asciidoc/ivyfile/artifact-conf.adoc
@@ -19,18 +19,14 @@
*Tag:* conf *Parent:* link:../ivyfile/artifact.html[artifact]
-
-
Indicates a public configuration in which enclosing artifact is published.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the module public configuration in which this artifact is published.
- '`$$*$$`' wildcard can be used to designate all public configurations of this module|Yes
-|=======
-
+`$$*$$` wildcard can be used to designate all public configurations of this module|Yes
+|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/artifact-exclude-conf.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/artifact-exclude-conf.adoc b/asciidoc/ivyfile/artifact-exclude-conf.adoc
index ed5f3be..1861a9a 100644
--- a/asciidoc/ivyfile/artifact-exclude-conf.adoc
+++ b/asciidoc/ivyfile/artifact-exclude-conf.adoc
@@ -19,18 +19,12 @@
*Tag:* conf *Parent:* link:../ivyfile/artifact-exclude.html[artifact]
-
-
Specify a configuration in which the enclosing artifact exclusion should be included.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the master configuration in which the enclosing artifact should be excluded|Yes
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/artifact-exclude.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/artifact-exclude.adoc b/asciidoc/ivyfile/artifact-exclude.adoc
index 5f92493..d27964a 100644
--- a/asciidoc/ivyfile/artifact-exclude.adoc
+++ b/asciidoc/ivyfile/artifact-exclude.adoc
@@ -19,9 +19,7 @@
*Tag:* exclude *Parent:* link:../ivyfile/dependency.html[dependency]
-This feature gives you more control on a dependency for which you do not control its ivy file.
-It enables to restrict the artifacts required, by excluding artifacts being published by the dependency or any of its transitive dependencies,
-even if configuration does not a good separation of published artifacts
+This feature gives you more control on a dependency for which you do not control its ivy file. It enables to restrict the artifacts required, by excluding artifacts being published by the dependency or any of its transitive dependencies, even if configuration does not a good separation of published artifacts
The same principle concerning configuration as for include applies to this exclude feature (see the link:../ivyfile/dependency-include.html[include] feature).
@@ -40,24 +38,22 @@ Note that exclusion is always done AFTER inclusion has been done.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|org|the organisation of the dependency module or artifact to exclude, or a regexp matching this organisation *__since 1.3__*|No, defaults to '`$$*$$`'
-|module|the name of the dependency module or the artifact to exclude, or a regexp matching this module name *__since 1.3__*|No, defaults to '`$$*$$`'
-|name|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)|No, defaults to '`$$*$$`'
-|type|the type of the artifact of the dependency module to add to the exclude list, or a regexp matching this name|No, defaults to '`$$*$$`'
-|ext|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)|No, defaults to type
-|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to excludes *__since 1.3__*|No, defaults to exactOrRegexp in pre 1.3 ivy files, and exact in 1.3 and superior
+|org|the organisation of the dependency module or artifact to exclude, or a regexp matching this organisation *__since 1.3__*|No, defaults to `$$*$$`
+|module|the name of the dependency module or the artifact to exclude, or a regexp matching this module name *__since 1.3__*|No, defaults to `$$*$$`
+|name|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)|No, defaults to `$$*$$`
+|type|the type of the artifact of the dependency module to add to the exclude list, or a regexp matching this name|No, defaults to `$$*$$`
+|ext|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)|No, defaults to the value of `type`
+|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to excludes *__since 1.3__*|No, defaults to `exactOrRegexp` in pre 1.3 ivy files, and `exact` in 1.3 and superior
|conf|comma separated list of the master configurations in which this artifact should be excluded.
- '`$$*$$`' wildcard can be used to designate all configurations of this module|No, defaults to '`$$*$$`', unless nested conf are specified
-|=======
+`$$*$$` wildcard can be used to designate all configurations of this module|No, defaults to `$$*$$`, unless nested conf are specified
+|=======
== Child elements
-
[options="header",cols="20%,60%,20%"]
|=======
|Element|Description|Cardinality
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/artifact.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/artifact.adoc b/asciidoc/ivyfile/artifact.adoc
index 59ca2b3..d173453 100644
--- a/asciidoc/ivyfile/artifact.adoc
+++ b/asciidoc/ivyfile/artifact.adoc
@@ -23,90 +23,71 @@ Declares an artifact published by this module. This is especially useful for oth
The configurations in which an artifact is published can be configured in two ways:
-
-* conf attribute on artifact element +
-
-* conf subelement +
+* `conf` attribute on an `artifact` element
+* `conf` subelement
The two are equivalent, it is only a matter of preference. However, do not mix both for one artifact.
*__since 1.4__* The artifact element has default values for all its attributes, so if you want to declare a default artifact you can just declare it like that:
[source,xml]
----
-
<artifact />
-
----
If this is the only artifact declared, then it's equivalent to having no publication section at all.
-*__since 1.4__* It is possible to give a url at which artifacts can be found. This is not mandatory, and even not recommended. This is only a convenient way to deal with an existing repository with a bad layout, but should not be avoided in an enterprise repository.
+*__since 1.4__* It is possible to give an `url` at which artifacts can be found. This is not mandatory, and even not recommended. This is only a convenient way to deal with an existing repository with a bad layout, but should not be avoided in an enterprise repository.
*__since 1.4__* This tag supports link:../concept.html#extra[extra attributes].
*__since 2.4__* This tag supports the 'packaging' attributes; complete documentation can be found in the link:../concept.html#packaging[concept page].
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the published artifact. This name must not include revision.|No, defaults to the name of the module
-|type|the type of the published artifact. It's usually its extension, but not necessarily. For instance, ivy files are of type 'ivy' but have 'xml' extension|No, defaults to jar
-|ext|the extension of the published artifact|No, defaults to type
+|type|the type of the published artifact. It's usually its extension, but not necessarily. For instance, ivy files are of type `ivy` but have `xml` extension|No, defaults to `jar`
+|ext|the extension of the published artifact|No, defaults to the value of `type`
|conf|comma separated list of public configurations in which this artifact is published.
- '`$$*$$`' wildcard can be used to designate all public configurations of this module|No, defaults to defaultconf attribute value on parent publications element.
+
+`$$*$$` wildcard can be used to designate all public configurations of this module|No, defaults to `defaultconf` attribute value on parent publications element.
|url|a url at which this artifact can be found if it isn't located at the standard location in the repository *__since 1.4__*|No, defaults to no url
|packaging|a comma separated list of link:../concept.html#packaging[packaging] types *__since 2.4__*|No, defaults to no packaging
|=======
-
== Child elements
-
[options="header",cols="20%,60%,20%"]
|=======
|Element|Description|Cardinality
|link:../ivyfile/artifact-conf.html[conf]|indicates a public configuration in which this artifact is published|0..n
|=======
-
== Examples
-
[source,xml]
----
-
<artifact />
-
----
Declares an artifact with the name of the module as name, type and ext jar, and published in all configurations.
-
'''
-
[source,xml]
----
-
<artifact name="foo-src" type="source" ext="zip" conf="src" />
-
----
-Declares an artifact foo-src, of type 'source' with extension 'zip', and published in the src configuration.
-
+Declares an artifact `foo-src`, of type `source` with extension `zip`, and published in the `src` configuration.
'''
-
[source,xml]
----
-
<artifact name="foo" url="http://www.acme.com/repository/barbaz/foo-1.2-bar.jar" />
-
----
-Declares an artifact foo, of type and extension 'jar' located at the url http://www.acme.com/repository/barbaz/foo-1.2-bar.jar. This url will only be used if the artifact cannot be found at its standard location.
+Declares an artifact `foo`, of type and extension `jar'` located at the url `$$http://www.acme.com/repository/barbaz/foo-1.2-bar.jar$$`. This url will only be used if the artifact cannot be found at its standard location.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/conf.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/conf.adoc b/asciidoc/ivyfile/conf.adoc
index 34540df..79811e0 100644
--- a/asciidoc/ivyfile/conf.adoc
+++ b/asciidoc/ivyfile/conf.adoc
@@ -21,9 +21,9 @@
Declares a configuration of this module. As described in the reference page, a configuration is a way to use or construct a module. Some modules may be used in different ways (think about hibernate which can be used inside or outside an application server), and this way may alter the artifacts you need (in the case of hibernate, jta.jar is needed only if it is used outside an application server). Moreover, a module may need some other modules and artifacts only at build time, and some others at runtime. All those differents ways to use or build a module are called in Ivy module configurations.
-The conf element in the configurations section declares one configuration. This declaration gives the name of the configuration declared, its visibility and the other configurations of the module it extends.
+The `conf` element in the configurations section declares one configuration. This declaration gives the name of the configuration declared, its visibility and the other configurations of the module it extends.
-Visibility is used to indicate whether or not a configuration can be used from other modules depending on this one. Thus a private configuration is only used for internal purpose (maybe at build time), and other modules cannot declare to depend on it.
+`visibility` is used to indicate whether or not a configuration can be used from other modules depending on this one. Thus a private configuration is only used for internal purpose (maybe at build time), and other modules cannot declare to depend on it.
A configuration can also extend one or several other ones of the same module. When a configuration extends another one, then all artifacts required in the extended configuration will also be required in the configuration that extends the other one. For instance, if configuration B extends configuration A, and if artifacts art1 and art2 are required in configuration A, then they will be automatically required in configuration B. On the other hand, artifacts required in configuration B are not necessarily required in configuration A.
@@ -37,9 +37,6 @@ This notion is very helpful to define configurations which are similar with some
|`*(private)`|all other private configurations
|=======
-
-
-
*__since 1.4__* A whole configuration can be declared as non transitive, so that all dependencies resolved in this configuration will be resolved with transitivity disabled. Note that the transitivity is disabled for all the configuration dependencies (including those obtained because this conf extends other ones), and only for this configuration (which means that a conf extending this one with transitivityy enabled will get transitive dependencies even for dependencies being part of the non transitive configuration).
This is very useful to build a compile configuration, for instance, forcing the dependency declaration on each direct dependency, with no risk to forget some because of transitivity.
@@ -47,34 +44,31 @@ This is very useful to build a compile configuration, for instance, forcing the
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the declared configuration|Yes
|description|a description for the declared configuration|No
-|visibility|the visibility of the declared configuration.
- 'public' means that this configuration can be used by other modules, while 'private' means that this configuration is used only in the module itself, and is not exposed to other modules|No, defaults to public
+|visibility|the visibility of the declared configuration.
+
+`public` means that this configuration can be used by other modules, while `private` means that this configuration is used only in the module itself, and is not exposed to other modules|No, defaults to `public`
|extends|a comma separated list of configurations of this module that the
current configuration extends|No, defaults to none
-|transitive|a boolean to indicate if this conf is transitive or not *__since 1.4__*|No, defaults to true
-|deprecated|indicates that this conf has been deprecated by giving the date of the deprecation.
- It should be given in this format: `yyyyMMddHHmmss`|No, by default the conf is not deprecated
-|=======
-
+|transitive|a boolean to indicate if this conf is transitive or not *__since 1.4__*|No, defaults to `true`
+|deprecated|indicates that this conf has been deprecated by giving the date of the deprecation.
+It should be given in this format: `yyyyMMddHHmmss`|No, by default the conf is not deprecated
+|=======
== Examples
-
[source,xml]
----
-
<conf name="core" visibility="private" />
<conf name="compile" extends="core" transitive="false" visibility="private" />
<conf name="runtime" extends="compile" description="everything needed to run this module" />
-
----
-Declares three configurations, core compile and runtime, with only the runtime one accessible from other modules, and with the compile one being non transitive.
-Therefore the core configuration will only be composed of dependencies declared in the core configuration itself, the compile configuration will be composed of all dependencies required in either core or compile configuration, but without transivity (neither for core nor compile dependencies), and runtime will be composed of all dependencies, all transitively, including the dependencies declared only in compile.
+Declares three configurations, `core`, `compile` and `runtime`, with only the `runtime` one accessible from other modules, and with the `compile` one being non transitive.
+
+Therefore the `core` configuration will only be composed of dependencies declared in the `core` configuration itself, the `compile` configuration will be composed of all dependencies required in either `core` or `compile` configuration, but without transivity (neither for core nor compile dependencies), and `runtime` will be composed of all dependencies, all transitively, including the dependencies declared only in `compile`.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/configurations.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/configurations.adoc b/asciidoc/ivyfile/configurations.adoc
index 0eba2fb..e944830 100644
--- a/asciidoc/ivyfile/configurations.adoc
+++ b/asciidoc/ivyfile/configurations.adoc
@@ -19,39 +19,34 @@
*Tag:* configurations *Parent:* link:../ivyfile.html[ivy-module]
-A container for configuration elements. If this container is not present, it is assumed that the module has one public configuration called 'default'.
+A container for configuration elements. If this container is not present, it is assumed that the module has one public configuration called `default`.
-*__since 2.2__* You can define the default conf on this container by specifying the defaultconf attribute. This attribute defines the conf mapping to use when no conf mapping is specified for a dependency in this ivy file.
+*__since 2.2__* You can define the default conf on this container by specifying the `defaultconf` attribute. This attribute defines the conf mapping to use when no conf mapping is specified for a dependency in this ivy file.
-*__since 1.3__* You can define a default conf mapping on this container by specifying the defaultconfmapping attribute.
+*__since 1.3__* You can define a default conf mapping on this container by specifying the `defaultconfmapping` attribute.
-This attribute modifies the way ivy interprets conf mapping with no mapped conf. In this case, Ivy will look in the default conf mapping and use the conf mapping defined in the default conf mapping for the conf for which there is no mapped conf.
+This attribute modifies the way Ivy interprets conf mapping with no mapped conf. In this case, Ivy will look in the default conf mapping and use the conf mapping defined in the default conf mapping for the conf for which there is no mapped conf.
-In order to maintain backwards compatibility with Ivy 2.1.0 and earlier, the defaultconfmapping also provides one additional function. If no defaultconf is specified (on either the configurations tag or the dependencies tag), the defaultconfmapping becomes the default configuration for dependencies in this ivy file when no configuration is specified. In other words, in addition to altering the interpretation of individual configurations with no mapping, defaultconfmapping also performs exactly like defaultconf in the absence of a definition for defaultconf.
+In order to maintain backwards compatibility with Ivy 2.1.0 and earlier, the `defaultconfmapping` also provides one additional function. If no `defaultconf` is specified (on either the configurations tag or the dependencies tag), the `defaultconfmapping` becomes the default configuration for dependencies in this ivy file when no configuration is specified. In other words, in addition to altering the interpretation of individual configurations with no mapping, `defaultconfmapping` also performs exactly like `defaultconf` in the absence of a definition for `defaultconf`.
-If several defaultconfmapping or defaultconf attributes are defined (in the configurations tag, one or several in an included configurations file, and/or in the dependency tag, then it's only the last definition of each property which is taken into account. The others will have no effect at all.
+If several `defaultconfmapping` or `defaultconf` attributes are defined (in the configurations tag, one or several in an included configurations file, and/or in the dependency tag, then it's only the last definition of each property which is taken into account. The others will have no effect at all.
See link:#defaultconfmapping[examples below] to clarify the behavior of these two attributes together.
-*__since 1.4__* You can activate a confmappingoverride mode for all configurations, in which case the extending configurations will override the mappings of the configurations they extend from.
-
-
+*__since 1.4__* You can activate a `confmappingoverride` mode for all configurations, in which case the extending configurations will override the mappings of the configurations they extend from.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|defaultconf|the default conf to use in this ivy file *__since 2.2__*|No, defaults to no default conf
|defaultconfmapping|the default conf mapping to use in this ivy file *__since 1.3__*|No, defaults to no default conf mapping
-|confmappingoverride|true to activate configuration mapping override, false otherwise *__since 1.4__*|No, defaults to false
+|confmappingoverride|`true` to activate configuration mapping override, `false` otherwise *__since 1.4__*|No, defaults to `false`
|=======
-
== Child elements
-
[options="header",cols="20%,60%,20%"]
|=======
|Element|Description|Cardinality
@@ -59,16 +54,13 @@ See link:#defaultconfmapping[examples below] to clarify the behavior of these tw
|link:../ivyfile/include.html[include]|include configurations from another file|0..n
|=======
-
-
== Configuration mappings details
When Ivy parses your Ivy file, it will create (internally) modify the configuration mapping of your dependencies.
-For instance, say you have:
+For instance, say you have:
[source,xml]
----
-
<configurations defaultconfmapping="conf1->other1;conf2->other2">
<conf name="conf1" />
<conf name="conf2" extends="conf1" />
@@ -76,33 +68,31 @@ For instance, say you have:
<dependencies>
<dependency name="other-module" conf="conf1" />
</dependencies>
-
----
When Ivy parses this file, it will construct the following dependency (in-memory only):
-
[source,xml]
----
<dependency name="other-module" conf="conf1->other1" />
----
-So, if you now resolve the conf2 configuration, you will only get the other1 dependencies of your other-module.
+So, if you now resolve the `conf2` configuration, you will only get the other1 dependencies of your other-module.
-But when you set confmappingoverride to true, Ivy will construct the following dependency in memory:
+But when you set `confmappingoverride` to `true`, Ivy will construct the following dependency in memory:
[source,xml]
----
<dependency name="other-module" conf="conf1->other1;conf2->other2" />
----
-As you can see, the defaultmappings of the extending configurations are also added (although you didn't explicitly defined them)
+As you can see, the `defaultmappings` of the extending configurations are also added (although you didn't explicitly defined them)
-When you now resolve the conf2 configuration, you'll get the other2 dependencies of your other-module.
+When you now resolve the `conf2` configuration, you'll get the `other2` dependencies of your `other-module`.
-
-== Examples involving defaultconf and defaultconfmapping
+== Examples involving defaultconf and [[defaultconfmapping]]defaultconfmapping
The table below indicates how Ivy interprets the conf attribute according to how link:../ivyfile/configurations.html[defaultconfmapping] and link:../ivyfile/configurations.html[defaultconf] are set:
+
[options="header",cols="15%,40%,15%,30%"]
|=======
|defaultconf|defaultconfmapping|conf|ivy interpretation
@@ -115,5 +105,4 @@ The table below indicates how Ivy interprets the conf attribute according to how
| |`$$runtime->*;test->default$$`| |`$$runtime->*;test->default$$`
| |`$$runtime->*;test->default$$`|`runtime`|`$$runtime->*$$`
| |`$$runtime->*;test->default$$`|`test`|`$$test->default$$`
-
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/conflict.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/conflict.adoc b/asciidoc/ivyfile/conflict.adoc
index 37bc26e..2cddacc 100644
--- a/asciidoc/ivyfile/conflict.adoc
+++ b/asciidoc/ivyfile/conflict.adoc
@@ -19,8 +19,6 @@
*Tag:* conflict *Parent:* link:../ivyfile/dependencies.html[dependencies]
-
-
*__(since 2.0)__*
Specify a a conflict manager for one or several dependencies.
@@ -35,19 +33,17 @@ That's why the order of dependencies is important for download optimization. Ind
If no specific conflict manager is defined, a default conflict manager is used for all modules.
-The current default conflict manager is the "latest-revision" conflict manager.
-
+The current default conflict manager is the `latest-revision` conflict manager.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|org|the name, or an expression matching the name of organisation to which this conflict manager should apply (see matcher attribute below)|No, defaults to '`$$*$$`' (match all)
-|module|the name, or an expression matching the name of module to which this conflict manager should apply (see matcher attribute below)|No, defaults to '`$$*$$`' (match all)
-|manager|the name of the conflict manager to use|Exactly one of two
+|org|the name, or an expression matching the name of organisation to which this conflict manager should apply (see `matcher` attribute below)|No, defaults to `$$*$$` (match all)
+|module|the name, or an expression matching the name of module to which this conflict manager should apply (see `matcher` attribute below)|No, defaults to `$$*$$` (match all)
+|manager|the name of the conflict manager to use
+.2+.^|Exactly one of two
|rev|a comma separated list of revisions this conflict manager should select
-|matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used|No, defaults to exact
+|matcher|the link:../concept.html#matcher[matcher] to use to match the modules for which the conflict manager should be used|No, defaults to `exact`
|=======
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/conflicts.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/conflicts.adoc b/asciidoc/ivyfile/conflicts.adoc
index 88f232d..c517bfb 100644
--- a/asciidoc/ivyfile/conflicts.adoc
+++ b/asciidoc/ivyfile/conflicts.adoc
@@ -19,25 +19,17 @@
*Tag:* conflicts *Parent:* link:../ivyfile.html[ivy-module]
-
-
*__(since 2.0)__* the conflicts section is deprecated. Use the link:../ivyfile/conflict.html[conflict] instead.
Container for conflict manager elements, used to indicate how conflicts should be resolved
for this module.
-
-
The list of built-in conflict managers available is listed on the link:../settings/conflict-managers.html[conflict manager configuration page].
-
-
Conflicts manager are used during the resolve operation, i.e. when ivy analyse the graph of dependencies
and download corresponding ivy files and artifacts. The fact to manage conflict at resolve time
enables to minimize downloads: when a module is evicted by a conflict manager, it is not downloaded.
-
-
There are two things optimized during conflict resolution: download of artifacts and download
of ivy files. The first is always ensured by ivy, i.e. artifacts of a module evicted will never
be downloaded. The second is not as simple to handle because to know what are the conflicts
@@ -51,10 +43,8 @@ and if this is the case, it asks the conflict manager to resolve the conflict. T
it does not download its ivy file, and the whole branch is not traversed, which can saves
a lot of time.
-
-
If this container is not present, a default conflict manager is used for all modules.
-The current default conflict manager is the "latest-revision" conflict manager.
+The current default conflict manager is the `latest-revision` conflict manager.
== Child elements
@@ -64,5 +54,3 @@ The current default conflict manager is the "latest-revision" conflict manager.
|Element|Description|Cardinality
|link:../ivyfile/manager.html[manager]|declares a conflict manager for this module|1..n
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/dependencies.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependencies.adoc b/asciidoc/ivyfile/dependencies.adoc
index 4002d05..fe05aa8 100644
--- a/asciidoc/ivyfile/dependencies.adoc
+++ b/asciidoc/ivyfile/dependencies.adoc
@@ -24,32 +24,18 @@ If this container is not present, it is assumed that the module has no dependenc
This container provides for two similar behaviors. An overview is given here. (See link:../ivyfile/configurations.html[configurations doc page] for more details about these behaviors).
-*__since 1.1__*
-[source]
-----
-defaultconf
-----
+*__since 1.1__* `defaultconf` defines the `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.
-Defines the 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.
-
-*__since 1.3__*
-[source]
-----
-defaultconfmapping
-----
-
-Influences the way that a conf mapping with no mapped conf is interpreted.
-
-In Ivy 2.1.0 and earlier, if both defaultconf and defaultconfmapping are defined, it's the defaultconfmapping that is used. Since Ivy 2.2.0, these attributes can be used together.
+*__since 1.3__* `defaultconfmapping` influences the way that a conf mapping with no mapped conf is interpreted.
+In Ivy 2.1.0 and earlier, if both `defaultconf` and `defaultconfmapping` are defined, it's the `defaultconfmapping` that is used. Since Ivy 2.2.0, these attributes can be used together.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|defaultconf|the default configuration to use when none is specified in a dependency. *__since 1.1__*|No, defaults to $$*->*$$
+|defaultconf|the default configuration to use when none is specified in a dependency. *__since 1.1__*|No, defaults to `$$*->*$$`
|defaultconfmapping|the default configuration mapping to use in this ivy file. *__since 1.3__*|No, defaults to no default conf mapping
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/dependency-artifact-conf.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency-artifact-conf.adoc b/asciidoc/ivyfile/dependency-artifact-conf.adoc
index b2c865f..7aac9a7 100644
--- a/asciidoc/ivyfile/dependency-artifact-conf.adoc
+++ b/asciidoc/ivyfile/dependency-artifact-conf.adoc
@@ -21,14 +21,10 @@
Specify a configuration in which the enclosing artifact specification should be included.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the master configuration in which the enclosing artifact should be included|Yes
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/dependency-artifact.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency-artifact.adoc b/asciidoc/ivyfile/dependency-artifact.adoc
index 7a55144..b7fef30 100644
--- a/asciidoc/ivyfile/dependency-artifact.adoc
+++ b/asciidoc/ivyfile/dependency-artifact.adoc
@@ -29,15 +29,12 @@ Each artifact specification can be given in the context of particular master con
For instance, imagine you have A, B & C master configurations. If you specify art1 in A & B and art2 in A, then C will not be specified at all, and will thus assume the default artifact. To prevent this, you have to specify a configuration mapping for the dependency, mapping only A & B to some or all dependency configurations.
Example:
-
[source,xml]
----
-
<dependency org="yourorg" name="yourmodule9" rev="9.1" conf="A,B->default">
<artifact name="art1" type="jar" conf="A,B"/>
<artifact name="art2" type="jar" conf="A"/>
-</dependency>
-
+</dependency>
----
*__since 1.4__* It's possible to indicate the url at which the artifact can be found. This is not mandatory, and even not recommended with an enterprise repository. Note that Ivy will always look at the location where the artifact should be and only use the url if it cannot be found at the standard location in the repository.
@@ -46,10 +43,8 @@ Example:
*__since 2.0__* This feature can also be used for modules having their own module descriptor, but which doesn't declare an artifact you know that is published. Note that in this case artifacts declared to be published by the dependency will be ignored, so do not forget to include all artifacts you want.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
@@ -57,62 +52,49 @@ Example:
|type|the type of the artifact of the dependency module|Yes
|ext|the extension of the artifact of the dependency module|No, defaults to type
|conf|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|No, defaults to '*', unless nested conf are specified
+
+`$$*$$` wildcard can be used to designate all configurations of this module|No, defaults to `$$*$$`, unless nested conf are specified
|url|an url where this artifact can be found if it isn't present at the standard location in the repository *__since 1.4__*|No, defaults to no url
|=======
-
== Child elements
-
[options="header",cols="20%,60%,20%"]
|=======
|Element|Description|Cardinality
|link:../ivyfile/dependency-artifact-conf.html[conf]|configuration in which the artifact should be included|0..n
|=======
-
== Examples
-
[source,xml]
----
-
<dependency org="foo" name="bar" rev="1.0">
<artifact name="baz" type="jar"/>
</dependency>
-
----
-Declares a dependency on module bar which only publish one artifact: baz.jar.
-
+Declares a dependency on module bar which only publish one artifact: `baz.jar`.
'''
-
[source,xml]
----
-
<dependency org="foo" name="bar" rev="1.0">
<artifact name="baz" type="jar" url="http://www.acme.com/repository/bar/baz-1.0-acme.jar"/>
</dependency>
-
----
-Same as above, except that if the artifact is not found at its standard location, Ivy will use http://www.acme.com/repository/bar/baz-1.0-acme.jar to download it.
-
+Same as above, except that if the artifact is not found at its standard location, Ivy will use `$$http://www.acme.com/repository/bar/baz-1.0-acme.jar$$` to download it.
'''
-
[source,xml]
----
-
<dependency org="foo" name="bar" rev="1.0">
<include name="*"/>
<artifact name="baz" type="source" ext="jar"/>
</dependency>
-
----
-Declares a dependency on module bar for which all artifacts declared will be used (thanks to the include tag) plus an artifact baz of type source and ext jar (which is not declared in module bar module descriptor).
+Declares a dependency on module bar for which all artifacts declared will be used (thanks to the `include` tag) plus an artifact `baz` of type `source` and ext `jar` (which is not declared in module bar module descriptor).
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/dependency-conf.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency-conf.adoc b/asciidoc/ivyfile/dependency-conf.adoc
index 458cccd..7d0fe38 100644
--- a/asciidoc/ivyfile/dependency-conf.adoc
+++ b/asciidoc/ivyfile/dependency-conf.adoc
@@ -19,32 +19,23 @@
*Tag:* conf *Parent:* link:../ivyfile/dependency.html[dependency]
-
-
-Describes a configuration mapping for a dependency. See also the inline configuration mapping
-in dependency element.
-
+Describes a configuration mapping for a dependency. See also the inline configuration mapping in dependency element.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the master configuration to map.
- '`$$*$$`' wildcard can be used to designate all configurations of this module|Yes
-|mapped|a comma separated list of dependency configurations to which this
- master configuration should be mapped|No, default to the same configuration as master one, unless nested mapped elements are specified
-|=======
+`$$*$$` wildcard can be used to designate all configurations of this module|Yes
+|mapped|a comma separated list of dependency configurations to which this master configuration should be mapped|No, default to the same configuration as master one, unless nested mapped elements are specified
+|=======
== Child elements
-
[options="header",cols="20%,60%,20%"]
|=======
|Element|Description|Cardinality
|link:../ivyfile/mapped.html[mapped]|map dependency configurations for this master configuration|0..n
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/dependency-include-conf.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency-include-conf.adoc b/asciidoc/ivyfile/dependency-include-conf.adoc
index f176eec..be3f8d6 100644
--- a/asciidoc/ivyfile/dependency-include-conf.adoc
+++ b/asciidoc/ivyfile/dependency-include-conf.adoc
@@ -21,14 +21,10 @@
Specify a configuration in which the enclosing artifact inclusion should be included.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the master configuration in which the enclosing artifact should be included|Yes
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/dependency-include.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency-include.adoc b/asciidoc/ivyfile/dependency-include.adoc
index 6e23aa4..18645c6 100644
--- a/asciidoc/ivyfile/dependency-include.adoc
+++ b/asciidoc/ivyfile/dependency-include.adoc
@@ -30,33 +30,28 @@ Example:
[source,xml]
----
-
<dependency org="yourorg" name="yourmodule9" rev="9.1" conf="A,B->default">
<include name="art1" type="jar" conf="A,B"/>
<include name="art2" type="jar" conf="A"/>
-</dependency>
-
+</dependency>
----
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|name|the name of an artifact of the dependency module to add to the include list, or an expression matching this name (see matcher attribute below)|No, defaults to '`$$.*$$`'
-|type|the type of the artifact of the dependency module to add to the include list, or an expression matching this name (see matcher attribute below)|No, defaults to '`$$.*$$`'
-|ext|the extension of the artifact of the dependency module to add to the include list, or an expression matching this name (see matcher attribute below)|No, defaults to type
-|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to include *__since 2.0__*|No, defaults to exactOrRegexp in pre 1.3 ivy files, and exact in 1.3 and superior
+|name|the name of an artifact of the dependency module to add to the include list, or an expression matching this name (see `matcher` attribute below)|No, defaults to `$$.*$$`
+|type|the type of the artifact of the dependency module to add to the include list, or an expression matching this name (see `matcher` attribute below)|No, defaults to `$$.*$$`
+|ext|the extension of the artifact of the dependency module to add to the include list, or an expression matching this name (see `matcher` attribute below)|No, defaults to the value of `type`
+|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to include *__since 2.0__*|No, defaults to `exactOrRegexp` in pre 1.3 ivy files, and `exact` in 1.3 and superior
|conf|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|No, defaults to '`$$*$$`', unless nested conf are specified
-|=======
+`$$*$$` wildcard can be used to designate all configurations of this module|No, defaults to `$$*$$`, unless nested conf are specified
+|=======
== Child elements
-
[options="header"]
|=======
|Element|Description|Cardinality
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/dependency.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/dependency.adoc b/asciidoc/ivyfile/dependency.adoc
index 3378daa..d6f3306 100644
--- a/asciidoc/ivyfile/dependency.adoc
+++ b/asciidoc/ivyfile/dependency.adoc
@@ -21,25 +21,24 @@
Declares a dependency for this module. A dependency is described by the module on which the current module depends (identified by its name, organisation and revision), and a mapping of configurations.
-
== [[revision]]Fixed and dynamic revisions
The revision can be given as a fixed one (1.5.2, for instance) or as a latest (or dynamic) one. Several possibilities for dynamic revisions are implemented in Ivy:
-
* `latest.integration` +
selects the latest revision of the dependency module.
* `latest.[any status]` *__since 1.4__* +
selects the latest revision of the dependency module with at least the specified status. +
-For instance latest.milestone will select the latest version being either a milestone or a release, and latest.release will only selects the latest release. Note that in order to find the latest revision with the appropriate status Ivy has to parse all the ivy files in your repository from the last one until it finds such a revision. Hence don't be surprised if the resolution slow down.
+For instance `latest.milestone` will select the latest version being either a `milestone` or a `release`, and `latest.release` will only selects the latest `release`. Note that in order to find the latest revision with the appropriate status Ivy has to parse all the ivy files in your repository from the last one until it finds such a revision. Hence don't be surprised if the resolution slow down.
See also link:../settings/statuses.html[statuses] to see how to configure module statuses.
-* end the revision with a '`+`' +
- selects the latest sub-revision of the dependency module. For instance,
+
+* end the revision with a `+` +
+selects the latest sub-revision of the dependency module. For instance,
if the dependency module exists in revision 1.0.3, 1.0.7 and 1.1.2, "1.0.+" will select 1.0.7.
* version ranges *__since 1.4__* +
- mathematical notation for ranges can be used to match a range of version. +
+mathematical notation for ranges can be used to match a range of version. +
Examples: +
`[1.0,2.0]` matches all versions greater or equal to 1.0 and lower or equal to 2.0 +
`[1.0,2.0[` matches all versions greater or equal to 1.0 and lower than 2.0 +
@@ -53,13 +52,11 @@ Examples: +
*__since 1.4__* If you don't find a way to expression your dependency version constraint among these, you can link:../settings/version-matchers.html[plug your own].
The way to determine which revision is the "latest" between two is configurable through the use of pluggable LatestStrategy. See link:../reference.html[ivy main concepts] for details about this.
-
== [[revision-constraint]]Revision constraint
-*__since 2.0__* The dependency tag supports two revision attributes: rev, corresponding to the default required dependency revision, and revConstraint, corresponding to a dynamic revision constraint applied on this dependency.
-
-Depending on the link:../use/resolve.html[resolve mode] used, the actual revision used during dependency resolution may vary. These revisions usually differ only for modules published in a repository. When link:../use/deliver.html[deliver] is used, dynamic version constraints are replaced by a stic version constraint, to help build reproducibility. However, the information of the original version constraint is not lost, but rather put in the revConstraint attribute. This both ensure better metadata in the repository while still allowing easier build reproducibility.
+*__since 2.0__* The `dependency` tag supports two revision attributes: `rev`, corresponding to the default required dependency revision, and `revConstraint`, corresponding to a dynamic revision constraint applied on this dependency.
+Depending on the link:../use/resolve.html[resolve mode] used, the actual revision used during dependency resolution may vary. These revisions usually differ only for modules published in a repository. When link:../use/deliver.html[deliver] is used, dynamic version constraints are replaced by a stic version constraint, to help build reproducibility. However, the information of the original version constraint is not lost, but rather put in the `revConstraint` attribute. This both ensure better metadata in the repository while still allowing easier build reproducibility.
== Configurations mapping
@@ -69,120 +66,53 @@ There are several ways to declare this mapping of configurations, choose dependi
The first way to declare this mapping is called the inline mapping. It is maybe the less natural at first, but it's powerful and concise. Inline mapping can take several forms.
+=== Specify one configuration name
+
+This means that in this master configuration the same dependency configuration is needed (except if a `defaultconfmapping` has been specified in this ivy file, see link:../ivyfile/configurations.html[configurations] for details, or table below for examples).
+For instance, if the current module has defined a configuration named '`runtime`', and the dependency too, then having an inline mapping configuration set to '`runtime`' means that in the runtime master configuration the runtime dependency configuration is required.
-* Specify one configuration name +
- This means that in this master configuration the same dependency configuration is needed (except if a `defaultconfmapping` has been specified in this ivy file, see link:../ivyfile/configurations.html[configurations] for details, or table below for examples).
-For instance, if the current module has defined a configuration named '`runtime`', and the dependency too, then having an inline mapping configuration set to '`runtime`' means that in the runtime master configuration the runtime dependency configuration is required. +
The link:../ivyfile/configurations.html#defaultconfmapping[examples on the dependency on the configurations page] explain how ivy interprets the conf attribute according to how link:../ivyfile/configurations.html[defaultconfmapping] and link:../ivyfile/configurations.html[defaultconf] is set.
+=== Specify a configuration mapping using the `$$->$$` operator
+It is separating a comma separated list of master configurations (left operand) of a comma separated list of dependency configurations (right operand).
-* Specify a configuration mapping using the `$$->$$` operator separating a comma separated list of master configurations (left operand) of a comma separated list of dependency configurations (right operand). +
-A good way to remember which side is for the master configuration (i.e. the configuration of the module defining the dependency) and which side is for the dependency configuration is to read the '$$->$$' as 'depends on'.
+A good way to remember which side is for the master configuration (i.e. the configuration of the module defining the dependency) and which side is for the dependency configuration is to read the `$$->$$` as "depends on".
In this case, all specified dependency configurations are required in all specified master configurations.
For instance, `$$A, B, C -> E, F$$` means that dependency configurations E and F are required in master configurations A, B and C.
-Note that you can use the wildcard `$$*$$` as a configuration name, meaning that all configurations (either master or dependency public ones depending on the side) are wanted. For instance, '$$* -> B, C$$' means that B & C dependency configurations are required in all master configurations.
+Note that you can use the wildcard `$$*$$` as a configuration name, meaning that all configurations (either master or dependency public ones depending on the side) are wanted. For instance, `$$* -> B, C$$` means that B & C dependency configurations are required in all master configurations.
-*__since 1.4__* you can use * wildcard followed by negated configurations to mean all but xxx. For instance, '$$*, !A, !B -> X$$' means that X dependency configuration is required in all master configurations except A and B.
+*__since 1.4__* you can use * wildcard followed by negated configurations to mean all but xxx. For instance, `$$*, !A, !B -> X$$` means that X dependency configuration is required in all master configurations except A and B.
-*__since 1.2__* '`@`' also has a special meaning as a right operand of the dependency mapping, it means map to self. This is particularly useful with '$$*$$', '$$*->@$$' meaning that all configurations of the module maps to their equivalent (same name) in the dependency.
+*__since 1.2__* `@` also has a special meaning as a right operand of the dependency mapping, it means map to self. This is particularly useful with `$$*$$`, `$$*->@$$` meaning that all configurations of the module maps to their equivalent (same name) in the dependency.
-*__since 1.4__* '`#`' can be used as right side operand to mean 'this' configuration, and thus refers to the configuration being resolved. It is slightly similar to @, except that it takes into account the configuration being actually resolved in case of a configuration extending another one.
+*__since 1.4__* `#` can be used as right side operand to mean _this_ configuration, and thus refers to the configuration being resolved. It is slightly similar to `@`, except that it takes into account the configuration being actually resolved in case of a configuration extending another one.
-Example:
-Let's foo be a module with two configurations, A and B, B extending A.
-Then a dependency declaring conf `$$A->#$$` will get A dep conf in its confs A (when resolving A, ivy will find interpret the `#` symbol as A) and B dep conf in its conf B (when resolving B, ivy will interpret the `#` symbol as B, even if this dependency is only required because of the A dependency).
+Example: Let's foo be a module with two configurations, A and B, B extending A. Then a dependency declaring conf `$$A->#$$` will get A dep conf in its confs A (when resolving A, ivy will find interpret the `#` symbol as A) and B dep conf in its conf B (when resolving B, ivy will interpret the `#` symbol as B, even if this dependency is only required because of the A dependency).
If you don't understand really how this works, do not use it :-)
-*__since 1.4__* '`%`' can be used as left side operand to mean 'all the other configurations'. This can be usefull when you only have a specific mapping for some configurations and a default mapping for all the others.
-
-Example:
-
-[source]
-----
-test->runtime;%->default
-----
-
-means that the
-[source]
-----
-test
-----
-
-configuration is mapped to the
-[source]
-----
-runtime
-----
-
-configuration, but all the other configurations are mapped to the
-[source]
-----
-default
-----
-
-configuration.
+*__since 1.4__* `%` can be used as left side operand to mean "all the other configurations". This can be usefull when you only have a specific mapping for some configurations and a default mapping for all the others. For instance, `$$test->runtime;%->default$$` means that the `test` configuration is mapped to the `runtime` configuration, but all the other configurations are mapped to the `default` configuration.
*__since 1.3__* a fallback mechanism can be used when you are not sure that the dependency will have the required conf. You can indicate to ivy that you want one configuration, but if it isn't present, use another one.
The syntax for specifying this adds the fallback conf between parenthesis right after the required conf.
-For instance,
-[source]
-----
-test->runtime(default)
-----
-
-means that in the test configuration of the module the
-[source]
-----
-runtime
-----
-
-conf of the dependency is required, but if doesn't exist, it will use the
-[source]
-----
-default
-----
-
-conf instead. If
-[source]
-----
-default
-----
-
-conf doesn't exist then it will be considered as an error. Note that the
-[source]
-----
-*
-----
-wildcard can be used as fallback conf.
+For instance, `$$test->runtime(default)$$` means that in the test configuration of the module the `runtime` conf of the dependency is required, but if doesn't exist, it will use the `default` conf instead. If `default` conf doesn't exist then it will be considered as an error. Note that the `*` wildcard can be used as fallback conf.
-*__since 2.1__* It is also possible to define dependencies on configurations intersection. A configuration intersection is defined using a '`+`' sign to separate the configuration (eg '`A+B`' means the intersection of configuration 'A' and 'B'). In that case only artifacts and dependencies defined in both configurations in the dependency will be part of the master configuration defining the dependency on the configuration intersection.
+*__since 2.1__* It is also possible to define dependencies on configurations intersection. A configuration intersection is defined using a `+` sign to separate the configuration (eg `A+B` means the intersection of configuration A and B). In that case only artifacts and dependencies defined in both configurations in the dependency will be part of the master configuration defining the dependency on the configuration intersection.
Configuration intersections can also be used when specifying the confs to link:../use/resolve.html[resolve].
-Moreover, the mapping '`$$*->@$$`' is handled as a specific case with configuration intersections: it maps also the intersections. So if one resolve conf `A+B` in a module which defines a dependency with mapping `$$*->@$$`, the mapping `$$*->@$$` is interpreted as `$$A+B->A+B$$` so the intersection of A and B will be resolved in the dependency.
-
-*__since 2.1__* you can refer to a group of configurations sharing the same value for an attribute as left side part of the dependency mapping.
+Moreover, the mapping `$$*->@$$` is handled as a specific case with configuration intersections: it maps also the intersections. So if one resolve conf `A+B` in a module which defines a dependency with mapping `$$*->@$$`, the mapping `$$*->@$$` is interpreted as `$$A+B->A+B$$` so the intersection of A and B will be resolved in the dependency.
-The syntax is
-
-[source]
-----
-*[att=value]
-----
-
-where _att_ is the name of the attribute shared by the configurations of the group, and _value_ is the value for this attribute that configurations must have to be part of the group. This is especially useful with extra attributes.
+*__since 2.1__* you can refer to a group of configurations sharing the same value for an attribute as left side part of the dependency mapping. The syntax is `*[att=value]` where `att` is the name of the attribute shared by the configurations of the group, and `value` is the value for this attribute that configurations must have to be part of the group. This is especially useful with extra attributes.
For instance, if you have:
-
[source,xml]
----
-
<configurations>
<conf name="red" e:axis="color" />
<conf name="blue" e:axis="color" />
@@ -190,72 +120,30 @@ For instance, if you have:
<conf name="windows" e:axis="platform" />
<conf name="linux" e:axis="platform"/>
</configurations>
-
----
Then you can do:
-
[source,xml]
----
-
<dependency org="acme" name="foo" rev="2.0" conf="*[axis=platform]->default"/>
-
----
To map the windows and linux configurations (the one which have the attribute axis equal to platform) to the default configuration of foo.
-*__since 1.4__* you can add simple conditions in the right side of the dependency mapping. This is done by adding a condition between '[' and ']'. If the condition evaluates to
-[source]
-----
-true
-----
-
-, the mapping is performed. If the condition evaluates to
-[source]
-----
-false
-----
-
-, the mapping will be ignored. For instance,
-[source]
-----
-test->[org=A]runtime,[org=B]default
-----
-
-means that the
-[source]
-----
-test
-----
-
-configuration will be mapped to the
-[source]
-----
-runtime
-----
-
-conf for the dependencies of organisation 'A' and to the
-[source]
-----
-default
-----
-
-conf for dependencies of organisation 'B'.
-
+*__since 1.4__* you can add simple conditions in the right side of the dependency mapping. This is done by adding a condition between `[` and `]`. If the condition evaluates to `true`, the mapping is performed. If the condition evaluates to `false`, the mapping will be ignored. For instance, `$$test->[org=A]runtime,[org=B]default$$` means that the `test` configuration will be mapped to the `runtime` conf for the dependencies of organisation A and to the `default` conf for dependencies of organisation B.
-* Specify a semi-column separated list of any of the previous specs. +
- In this case, it is the union of the mapping which is kept. For instance, '`$$A -> B; * -> C$$`' means that B conf is needed in A conf and C conf is need in all master conf... so both B & C dep conf are required in A master conf
+=== Specify a semi-column separated list of any of the previous specs.
-If you prefer more verbose mapping declaration, everything is also possible with sub elements mapping declaration.
+In this case, it is the union of the mapping which is kept. For instance, `$$A -> B; * -> C$$` means that B conf is needed in A conf and C conf is need in all master conf... so both B & C dep conf are required in A master conf
+If you prefer more verbose mapping declaration, everything is also possible with sub elements mapping declaration.
== Artifact restriction
Moreover, the dependency element also supports an artifact restriction feature (since 0.6).
See link:../ivyfile/dependency-artifact.html[dependency artifact] for details.
-
== Forcing revision
Finally, the dependency element also supports an a force attribute (since 0.8), which gives an indication
@@ -266,7 +154,6 @@ See link:../ivyfile/conflicts.html[conflicts manager] for details.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
@@ -274,18 +161,15 @@ See link:../ivyfile/conflicts.html[conflicts manager] for details.
|name|the module name of the dependency|Yes
|branch|the branch of the dependency. *__since 1.4__*|No, defaults to the default branch setting for the dependency.
|rev|the revision of the dependency. See link:#revision[above] for details.|Yes
-|revConstraint|the dynamic revision constraint originally used for this dependency. See link:#revision-constraint[above] for details.|No, defaults to the value of rev
-|force|a boolean to give an indication to conflict manager that this dependency
- should be forced to this revision (see link:../ivyfile/conflicts.html[conflicts manager])|No, defaults to false
-|conf|an inline mapping configuration spec (see above for details)|No, defaults to defaultconf attribute of dependencies element if neither conf attribute nor conf children element is given
-|transitive|true to resolve this dependency transitively, false otherwise (*__since 1.2__*)|No, defaults to true
-|changing|true if the dependency artifacts may change without revision change, false otherwise (*__since 1.2__*). See link:../concept.html#change[cache and change management] for details.|No, defaults to false
+|revConstraint|the dynamic revision constraint originally used for this dependency. See link:#revision-constraint[above] for details.|No, defaults to the value of `rev`
+|force|a boolean to give an indication to conflict manager that this dependency should be forced to this revision (see link:../ivyfile/conflicts.html[conflicts manager])|No, defaults to `false`
+|conf|an inline mapping configuration spec (see above for details)|No, defaults to `defaultconf` attribute of dependencies element if neither conf attribute nor conf children element is given
+|transitive|`true` to resolve this dependency transitively, `false` otherwise (*__since 1.2__*)|No, defaults to `true`
+|changing|`true` if the dependency artifacts may change without revision change, false otherwise (*__since 1.2__*). See link:../concept.html#change[cache and change management] for details.|No, defaults to `false`
|=======
-
== Child elements
-
[options="header",cols="20%,60%,20%"]
|=======
|Element|Description|Cardinality
@@ -294,130 +178,56 @@ See link:../ivyfile/conflicts.html[conflicts manager] for details.
|link:../ivyfile/artifact-exclude.html[exclude]|defines artifacts exclusion - use only if you do not control dependency ivy file|0..n
|=======
-
-
== Examples
-
[source,xml]
----
-
<dependency org="jayasoft" name="swtbinding" revision="0.2"/>
-
----
Declares a dependency on the module swtbinding from jayasoft in its revision 0.2. All the configuration of this dependency will be included in all configurations of the module in which the dependency is declared.
'''
-
[source,xml]
----
-
<dependency org="jayasoft" name="swtbinding" branch="fix-103" revision="latest.integration"/>
-
----
Same as above except that it will take the latest revision on the branch 'fix-103' instead of revision '0.2'.
'''
-
[source,xml]
----
-
<dependency name="mymodule" revision="latest.integration" conf="test->default"/>
-
-----
-
-Declares a dependency on the module
-[source]
-----
-mymodule
----
-from the same organisation as the module in which the dependency is declared. The latest available revision of this dependency will be used. This dependency will only be included in the test configuration of the module, and it's only the default configuration of the dependency which will be included.
+Declares a dependency on the module `mymodule` from the same organisation as the module in which the dependency is declared. The latest available revision of this dependency will be used. This dependency will only be included in the test configuration of the module, and it's only the default configuration of the dependency which will be included.
'''
-
[source,xml]
----
-
<dependency org="apache" name="commons-lang" revision="2.0" force="true" conf="default"/>
-
-----
-
-Declares a dependency on the module
-[source]
-----
-commons-lang
-----
-
-from apache, in revision 2.0. The revision 2.0 will be used even if another dependency declares itself a dependency on another version of commons-lang. Moreover, if no defaultconfmapping is defined, only the
-[source]
-----
-default
----
-conf of commons-lang will be used in the
-[source]
-----
-default
-----
-
-conf of the master module. If
-[source]
-----
-*->runtime
-----
-
-was declared as defaultconfmapping, then the runtime conf of commons-lang would be included in the default conf of the master module. Note that whatever the defaultconfmapping is, the dependency only be included in the default conf of the master module. The defaultconfmapping only changes the required dependency confs.
+Declares a dependency on the module `commons-lang` from apache, in revision 2.0. The revision 2.0 will be used even if another dependency declares itself a dependency on another version of `commons-lang`. Moreover, if no `defaultconfmapping` is defined, only the `default` conf of `commons-lang` will be used in the `default` conf of the master module. If `$$*->runtime$$` was declared as `defaultconfmapping`, then the `runtime` conf of `commons-lang` would be included in the `default` conf of the master module. Note that whatever the `defaultconfmapping` is, the dependency only be included in the default conf of the master module. The `defaultconfmapping` only changes the required dependency confs.
'''
-
-[source]
+[source,xml]
----
-
<dependency org="foo" name="bar" revision="3.0" transitive="false" conf="default->@;runtime,test->runtime"/>
-
----
-Declares a dependency on the module
-[source]
-----
-bar
-----
-
-from foo, in revision 3.0. The dependencies of bar will themselves not be included due to the setting of transitive. The default dependency conf will be included in the default master conf, and the runtime dependency conf will be included in both the runtime and test master conf.
+Declares a dependency on the module `bar` from foo, in revision 3.0. The dependencies of bar will themselves not be included due to the setting of transitive. The `default` dependency conf will be included in the `default` master conf, and the `runtime` dependency conf will be included in both the `runtime` and `test` master conf.
'''
-
[source,xml]
----
-
<dependency org="foo" name="bar" revision="3.0" changing="true" conf="compile->runtime(default)"/>
-
-----
-
-Declares a dependency on the module
-[source]
-----
-bar
-----
-
-from foo, in revision 3.0. This revision is considered to be able to change (
-[source]
-----
-changing="true"
-----
-
-), so even if it is already in ivy cache, Ivy will check if a revision is a more recent last modified date is available on the repository. The runtime conf of bar is required in the compile conf of the master module, but if bar doesn't define a runtime conf, then the
-[source]
-----
-default
----
-conf will be used.
+Declares a dependency on the module `bar` from `foo`, in revision 3.0. This revision is considered to be able to change (`changing="true"`), so even if it is already in Ivy's cache, Ivy will check if a revision is a more recent last modified date is available on the repository. The `runtime` conf of bar is required in the `compile` conf of the master module, but if bar doesn't define a `runtime` conf, then the `default` conf will be used.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/description.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/description.adoc b/asciidoc/ivyfile/description.adoc
index 2cceccc..35af9a0 100644
--- a/asciidoc/ivyfile/description.adoc
+++ b/asciidoc/ivyfile/description.adoc
@@ -19,8 +19,6 @@
*Tag:* description *Parent:* link:../ivyfile/info.html[info]
-
-
Describes the current module. This tag is the only one which can contain free text,
including html. It is used to describe the module itself, usually in a single short phrase
(it is not meant to replace the module description on the corresponding web site), and then
@@ -29,11 +27,8 @@ public configurations, how and when to use them.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|homepage|the url of the homepage of the module|No, but it's recommended to indicate it.
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/exclude.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/exclude.adoc b/asciidoc/ivyfile/exclude.adoc
index 0100f12..d51079c 100644
--- a/asciidoc/ivyfile/exclude.adoc
+++ b/asciidoc/ivyfile/exclude.adoc
@@ -19,24 +19,22 @@
*Tag:* exclude *Parent:* link:../ivyfile/dependencies.html[dependencies]
-*__since 2.0__* 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.
+*__since 2.0__* 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 link:../ivyfile/artifact-exclude.html[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.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
-|org|the organization of the dependency module or artifact to exclude, or a regexp matching this organization|No, defaults to '`$$*$$`'
-|module|the name of the dependency module or the artifact to exclude, or a regexp matching this module name|No, defaults to '`$$*$$`'
-|artifact|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)|No, defaults to '`$$*$$`'
-|type|the type of the artifact of the dependency module to add to the exclude list, or a regexp matching this name|No, defaults to '`$$*$$`'
-|ext|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)|No, defaults to type
-|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to excludes|No, defaults to exactOrRegexp in pre 1.3 ivy files, and exact in 1.3 and superior
+|org|the organization of the dependency module or artifact to exclude, or a regexp matching this organization|No, defaults to `$$*$$`
+|module|the name of the dependency module or the artifact to exclude, or a regexp matching this module name|No, defaults to `$$*$$`
+|artifact|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)|No, defaults to `$$*$$`
+|type|the type of the artifact of the dependency module to add to the exclude list, or a regexp matching this name|No, defaults to `$$*$$`
+|ext|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)|No, defaults to the value of `type`
+|matcher|the link:../concept.html#matcher[matcher] to use to match the modules to excludes|No, defaults to `exactOrRegexp` in pre 1.3 ivy files, and `exact` in 1.3 and superior
|conf|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|No, defaults to '`$$*$$`', unless nested conf are specified
+
+`$$*$$` wildcard can be used to designate all configurations of this module|No, defaults to `$$*$$`, unless nested conf are specified
|=======
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/extends.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/extends.adoc b/asciidoc/ivyfile/extends.adoc
index 0860495..5b969fe 100644
--- a/asciidoc/ivyfile/extends.adoc
+++ b/asciidoc/ivyfile/extends.adoc
@@ -19,9 +19,9 @@
*Tag:* extends *Parent:* link:../ivyfile/info.html[info]
-*__since 2.2__* Identifies an optional parent descriptor for this module. For complicated projects composed of many modules that have common configurations or dependencies, inheritance allows modules to share this information. Which parts of the parent descriptor are inherited can be controlled with the __extendType__ attribute.
+*__since 2.2__* Identifies an optional parent descriptor for this module. For complicated projects composed of many modules that have common configurations or dependencies, inheritance allows modules to share this information. Which parts of the parent descriptor are inherited can be controlled with the `extendType` attribute.
-Supported __extendType__ values are:
+Supported `extendType` values are:
[options="header",cols="15%,50%"]
|=======
@@ -45,16 +45,10 @@ Supported __extendType__ values are:
|organisation|the organisation of the parent module|Yes
|module|the name of the parent module|Yes
|revision|the revision of the parent module. Can be fixed, a dynamic value, or range of revisions; see link:../ivyfile/dependency.html[dependency] for information on specifying revisions.|Yes
-|extendType|which part(s) of the parent descriptor are inherited. Valid values are __info__, __description__,
-__configurations__, __dependencies__, and __all__.|No, default is __all__
-|location|
+|extendType|which part(s) of the parent descriptor are inherited. Valid values are `info`, `description`, `configurations`, `dependencies`, and `all`.|No, default is `all`
+|location|A local filesystem path that should be searched for the parent descriptor. If the parent descriptor cannot be found at this location, it will be located using dependency resolvers like any normal dependency.
-A local filesystem path that should be searched for the parent descriptor. If the parent descriptor cannot be found at this location, it will be located using dependency resolvers like any normal dependency.
-
-
-
-This attribute is intended for development use. For example, child module descriptors appear in a source control directory with the parent module descriptor at a higher level. __location__ will then contain the relative path to the parent descriptor for use during development builds.
+This attribute is intended for development use. For example, child module descriptors appear in a source control directory with the parent module descriptor at a higher level. `location` will then contain the relative path to the parent descriptor for use during development builds.
|No, as long as the parent descriptor exists in an Ivy resolver
|=======
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/include.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/include.adoc b/asciidoc/ivyfile/include.adoc
index 3ed13a2..5582f8c 100644
--- a/asciidoc/ivyfile/include.adoc
+++ b/asciidoc/ivyfile/include.adoc
@@ -21,29 +21,24 @@
Include configurations specified in another file. *__since 1.3__*
-The included file should have a configurations tag as root tag, which follow the same specification as the link:../ivyfile/configurations.html[configurations] tag of the ivy file.
+The included file should have a `configurations` tag as root tag, which follow the same specification as the link:../ivyfile/configurations.html[configurations] tag of the ivy file.
-This means that it can contain conf declarations, other file inclusion, and also a defaultconfmapping.
+This means that it can contain conf declarations, other file inclusion, and also a `defaultconfmapping`.
When delivering an ivy file with such an inclusion, the included configuration file is inlined, i.e. ivy remove the dependency on the external file.
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|file|the file to include|Yes
|=======
-
== Examples
-
[source,xml]
----
-
<ivy-module version="1.0">
<info organisation="myorg"
module="mymodule"
@@ -57,19 +52,16 @@ When delivering an ivy file with such an inclusion, the included configuration f
<dependency name="mymodule2" rev="2.0" conf="conf2,conf3->*"/>
</dependencies>
</ivy-module>
-
----
-with included-configurations.xml like this:
+with `included-configurations.xml` like this:
[source,xml]
----
-
<configurations defaultconfmapping="*->@">
<conf name="conf1" visibility="public"/>
<conf name="conf2" visibility="private"/>
</configurations>
-
----
-Defines 3 configurations, conf1, conf2 and conf3. mymodule1 is required in each configuration, with for each the same configuration (conf1 is needed in conf1, conf2 in conf2, and conf3 in conf3) due to the defaultconfmapping defined in the included file.
+Defines 3 configurations, `conf1`, `conf2` and `conf3`. `mymodule1` is required in each configuration, with for each the same configuration (`conf1` is needed in `conf1`, `conf2` in `conf2`, and `conf3` in `conf3`) due to the `defaultconfmapping` defined in the included file.
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/info.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/info.adoc b/asciidoc/ivyfile/info.adoc
index 64ef652..7213d91 100644
--- a/asciidoc/ivyfile/info.adoc
+++ b/asciidoc/ivyfile/info.adoc
@@ -23,10 +23,8 @@ Gives identification and basic information about the module this ivy file descri
*__since 1.4__* This tag supports link:../concept.html#extra[extra attributes].
-
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
@@ -34,14 +32,12 @@ Gives identification and basic information about the module this ivy file descri
|module|the name of the module described by this ivy file.|Yes
|branch|the branch of this module. *__since 1.4__*|No, defaults to the default branch setting, or nothing if no default branch is configured
|revision|the revision of this module.|Yes in repository ivy files, no in ivy files to resolve
-|status|the status of this module. See link:../reference.html[terminology] section for details|No, default to 'integration'
-|publication|the date of publication of this module. It should be given in this format: yyyyMMddHHmmss|No, but it's a good practice to set it with delivered ivy files
+|status|the status of this module. See link:../reference.html[terminology] section for details|No, default to `integration`
+|publication|the date of publication of this module. It should be given in this format: `yyyyMMddHHmmss`|No, but it's a good practice to set it with delivered ivy files
|=======
-
== Child elements
-
[options="header",cols="20%,60%,20%"]
|=======
|Element|Description|Cardinality
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/ivyauthor.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/ivyauthor.adoc b/asciidoc/ivyfile/ivyauthor.adoc
index a54622b..5859711 100644
--- a/asciidoc/ivyfile/ivyauthor.adoc
+++ b/asciidoc/ivyfile/ivyauthor.adoc
@@ -19,19 +19,14 @@
*Tag:* ivyauthor *Parent:* link:../ivyfile/info.html[info]
-
-
Gives information about who has contributed to write this ivy file. It does NOT indicate who
is the author of the module itself.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
|name|the name of the author, as a person or a company.|Yes
|url|an url pointing to where the author can bea reached.|No, but it's a good practice to indicate it
|=======
-
-
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/0851fa77/asciidoc/ivyfile/license.adoc
----------------------------------------------------------------------
diff --git a/asciidoc/ivyfile/license.adoc b/asciidoc/ivyfile/license.adoc
index 04a80d7..fed2f8c 100644
--- a/asciidoc/ivyfile/license.adoc
+++ b/asciidoc/ivyfile/license.adoc
@@ -19,13 +19,10 @@
*Tag:* license *Parent:* link:../ivyfile/info.html[info]
-
-
Gives information about a license of the described module.
== Attributes
-
[options="header",cols="15%,50%,35%"]
|=======
|Attribute|Description|Required
@@ -33,4 +30,3 @@ Gives information about a license of the described module.
|url|an url pointing to the license text.|No, but it's a good practice to indicate it
|=======
-