You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by ma...@apache.org on 2010/12/24 00:04:18 UTC
svn commit: r1052406 [2/2] - in /ant/ivy/site/target/history/2.2.0/tutorial:
build-repository/advanced.html build-repository/basic.html conf.html
dependence.html dual.html multiple.html multiproject.html start.html
Modified: ant/ivy/site/target/history/2.2.0/tutorial/conf.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/tutorial/conf.html?rev=1052406&r1=1052405&r2=1052406&view=diff
==============================================================================
--- ant/ivy/site/target/history/2.2.0/tutorial/conf.html (original)
+++ ant/ivy/site/target/history/2.2.0/tutorial/conf.html Thu Dec 23 23:04:17 2010
@@ -109,6 +109,76 @@ The first project we'll look at in this
As you can see, we defined 4 configurations, with 3 being public and 1 private. (the junit dependency for testing).<br class="xooki-br"/>The 2 implementation configurations, <b>homemade-impl</b> and <b>cc-impl</b> extend the <b>api</b> configuration so that all artifacts defined in <b>api</b> will also be part of the extending configuration.<br class="xooki-br"/><br class="xooki-br"/>In the publications tag, we defined the artifacts we produce (jars in this case) and we assign them to a configuration. When others use our library they will have a flexible way to ask for what they need.<br class="xooki-br"/><br class="xooki-br"/><h2>See it in action</h2>
The filter-framework project is built using Ant. Open a shell in the root directory of the project and type <tt>ant</tt>.
<div class="shell"><pre>
+[ivy@apache:/ivy/configurations/multi-projects/filter-framework]$ ant
+Buildfile: /ivy/configurations/multi-projects/filter-framework/build.xml
+
+clean:
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: url = jar:file:///home/ivy/ivy.jar!/org/apache/ivy/core/settings/ivysettings.xml
+[ivy:retrieve] :: resolving dependencies :: org.apache#filter-framework;working@apache
+[ivy:retrieve] confs: [api, homemade-impl, cc-impl, test]
+[ivy:retrieve] found commons-collections#commons-collections;3.1 in public
+[ivy:retrieve] found junit#junit;3.8 in public
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-collections/commons-collections/3.1/commons-collections-3.1.jar ...
+[ivy:retrieve] ................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................
+[ivy:retrieve] ...................................................................................................................................................................................................................................................................................................................................................................................... (546kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-collections#commons-collections;3.1!commons-collections.jar (3432ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/junit/junit/3.8/junit-3.8.jar ...
+[ivy:retrieve] .......................................................................................................................................................................................................................................... (118kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] junit#junit;3.8!junit.jar (2013ms)
+[ivy:retrieve] :: resolution report :: resolve 7286ms :: artifacts dl 5460ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | api | 0 | 0 | 0 | 0 || 0 | 0 |
+ | homemade-impl | 0 | 0 | 0 | 0 || 0 | 0 |
+ | cc-impl | 1 | 1 | 1 | 0 || 1 | 1 |
+ | test | 2 | 2 | 2 | 0 || 2 | 2 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#filter-framework
+[ivy:retrieve] confs: [api, homemade-impl, cc-impl, test]
+[ivy:retrieve] 3 artifacts copied, 0 already retrieved (1211kB/63ms)
+
+build:
+ [mkdir] Created dir: /ivy/configurations/multi-projects/filter-framework/build
+ [mkdir] Created dir: /ivy/configurations/multi-projects/filter-framework/distrib
+ [javac] /ivy/configurations/multi-projects/filter-framework/build.xml:57: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 4 source files to /ivy/configurations/multi-projects/filter-framework/build
+ [javac] Note: Some input files use unchecked or unsafe operations.
+ [javac] Note: Recompile with -Xlint:unchecked for details.
+ [jar] Building jar: /ivy/configurations/multi-projects/filter-framework/distrib/filter-api.jar
+ [jar] Building jar: /ivy/configurations/multi-projects/filter-framework/distrib/filter-hmimpl.jar
+ [jar] Building jar: /ivy/configurations/multi-projects/filter-framework/distrib/filter-ccimpl.jar
+
+test:
+ [mkdir] Created dir: /ivy/configurations/multi-projects/filter-framework/build/test-report
+ [mkdir] Created dir: /ivy/configurations/multi-projects/filter-framework/build/test-classes
+ [javac] /ivy/configurations/multi-projects/filter-framework/build.xml:82: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 3 source files to /ivy/configurations/multi-projects/filter-framework/build/test-classes
+ [junit] Running filter.ccimpl.CCFilterTest
+ [junit] Tests run: 5, Failures: 0, Errors: 0, Time elapsed: 0,109 sec
+ [junit] Running filter.hmimpl.HMFilterTest
+ [junit] Tests run: 5, Failures: 0, Errors: 0, Time elapsed: 0,093 sec
+
+publish:
+[ivy:publish] :: delivering :: org.apache#filter-framework;working@apache :: 1.3 :: release :: Thu Sep 23 23:16:19 CEST 2010
+[ivy:publish] delivering ivy file to /ivy/configurations/multi-projects/filter-framework/distrib/ivy.xml
+[ivy:publish] :: publishing :: org.apache#filter-framework
+[ivy:publish] published filter-api to /home/ivy/.ivy2/local/org.apache/filter-framework/1.3.part/jars/filter-api.jar
+[ivy:publish] published filter-hmimpl to /home/ivy/.ivy2/local/org.apache/filter-framework/1.3.part/jars/filter-hmimpl.jar
+[ivy:publish] published filter-ccimpl to /home/ivy/.ivy2/local/org.apache/filter-framework/1.3.part/jars/filter-ccimpl.jar
+[ivy:publish] published ivy to /home/ivy/.ivy2/local/org.apache/filter-framework/1.3.part/ivys/ivy.xml
+[ivy:publish] publish commited: moved /home/ivy/.ivy2/local/org.apache/filter-framework/1.3.part
+[ivy:publish] to /home/ivy/.ivy2/local/org.apache/filter-framework/1.3
+ [echo] project filter-framework released with version 1.3
+
+BUILD SUCCESSFUL
+Total time: 18 seconds
</pre></div>
The Ant default target is publish. This target uses Ivy to publish our library binaries to a local repository. Since we do not specify any repository path, the default one is used. (<tt>${home.dir}/.ivy2/local/org.apache/filter-framework/</tt>) At this point, we are ready to use our library.<br class="xooki-br"/><br class="xooki-br"/><h1>The application project</h1>
@@ -138,11 +208,91 @@ When we call this target, Ivy will do a
As you can see, for each configuration we have now a set of jars.<br class="xooki-br"/><br class="xooki-br"/>Let's try to launch our app.<br class="xooki-br"/><br class="xooki-br"/><h2>See it in action</h2>
Use Ant to run the application. The default Ant target is <i>run-cc</i> and will launch the application using the Apache commons-collections implementation.
<div class="shell"><pre>
+[ivy@apache:/ivy/configurations/multi-projects/myapp]$ ant
+Buildfile: /ivy/configurations/multi-projects/myapp/build.xml
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: url = jar:file:///home/ivy/ivy.jar!/org/apache/ivy/core/settings/ivysettings.xml
+[ivy:retrieve] :: resolving dependencies :: org.apache#myapp;working@apache
+[ivy:retrieve] confs: [build, noexternaljar, withexternaljar]
+[ivy:retrieve] found org.apache#filter-framework;1.3 in local
+[ivy:retrieve] [1.3] org.apache#filter-framework;latest.integration
+[ivy:retrieve] found commons-collections#commons-collections;3.1 in public
+[ivy:retrieve] downloading /home/ivy/.ivy2/local/org.apache/filter-framework/1.3/jars/filter-ccimpl.jar ...
+[ivy:retrieve] .. (1kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] org.apache#filter-framework;1.3!filter-ccimpl.jar (16ms)
+[ivy:retrieve] downloading /home/ivy/.ivy2/local/org.apache/filter-framework/1.3/jars/filter-hmimpl.jar ...
+[ivy:retrieve] .. (1kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] org.apache#filter-framework;1.3!filter-hmimpl.jar (15ms)
+[ivy:retrieve] downloading /home/ivy/.ivy2/local/org.apache/filter-framework/1.3/jars/filter-api.jar ...
+[ivy:retrieve] .. (1kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] org.apache#filter-framework;1.3!filter-api.jar (31ms)
+[ivy:retrieve] :: resolution report :: resolve 156ms :: artifacts dl 62ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | build | 1 | 1 | 1 | 0 || 1 | 1 |
+ | noexternaljar | 1 | 1 | 1 | 0 || 2 | 2 |
+ | withexternaljar | 2 | 1 | 1 | 0 || 3 | 2 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#myapp
+[ivy:retrieve] confs: [build, noexternaljar, withexternaljar]
+[ivy:retrieve] 6 artifacts copied, 0 already retrieved (552kB/94ms)
+
+build:
+ [mkdir] Created dir: /ivy/configurations/multi-projects/myapp/build
+ [javac] /ivy/configurations/multi-projects/myapp/build.xml:56: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 1 source file to /ivy/configurations/multi-projects/myapp/build
+
+run-cc:
+ [java] Filtering with:class filter.ccimpl.CCFilter
+ [java] Result :[two, tree]
+
+BUILD SUCCESSFUL
+Total time: 3 seconds
</pre></div>
Launching the application using the homemade implementation is also straightforward.<br class="xooki-br"/>type <tt>ant run-hm</tt>
<div class="shell"><pre>
+[ivy@apache:/ivy/configurations/multi-projects/myapp]$ ant run-hm
+Buildfile: /ivy/configurations/multi-projects/myapp/build.xml
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: url = jar:file:///home/ivy/ivy.jar!/org/apache/ivy/core/settings/ivysettings.xml
+[ivy:retrieve] :: resolving dependencies :: org.apache#myapp;working@apache
+[ivy:retrieve] confs: [build, noexternaljar, withexternaljar]
+[ivy:retrieve] found org.apache#filter-framework;1.3 in local
+[ivy:retrieve] [1.3] org.apache#filter-framework;latest.integration
+[ivy:retrieve] found commons-collections#commons-collections;3.1 in public
+[ivy:retrieve] :: resolution report :: resolve 156ms :: artifacts dl 0ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | build | 1 | 0 | 0 | 0 || 1 | 0 |
+ | noexternaljar | 1 | 0 | 0 | 0 || 2 | 0 |
+ | withexternaljar | 2 | 0 | 0 | 0 || 3 | 0 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#myapp
+[ivy:retrieve] confs: [build, noexternaljar, withexternaljar]
+[ivy:retrieve] 0 artifacts copied, 6 already retrieved (0kB/31ms)
+
+build:
+ [javac] /ivy/configurations/multi-projects/myapp/build.xml:56: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+
+run-hm:
+ [java] Filtering with:class filter.hmimpl.HMFilter
+ [java] Result :[two, tree]
+
+BUILD SUCCESSFUL
+Total time: 2 seconds
</pre></div>
Nice! We got the same result, but we can see that the implementation classes are different.<br class="xooki-br"/><br class="xooki-br"/><h1>Conclusion</h1>
<b>You should use configurations as often as possible.</b> Configurations are a very important concept in Ivy. They allow you to group artifacts and give the group a meaning. When you write ivy files for projects that are intended for use by others, use configurations to allow people to get only what they need, without having to specify them one by one in their own dependency list. <br class="xooki-br"/>
Modified: ant/ivy/site/target/history/2.2.0/tutorial/dependence.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/tutorial/dependence.html?rev=1052406&r1=1052405&r2=1052406&view=diff
==============================================================================
--- ant/ivy/site/target/history/2.2.0/tutorial/dependence.html (original)
+++ ant/ivy/site/target/history/2.2.0/tutorial/dependence.html Thu Dec 23 23:04:17 2010
@@ -159,6 +159,51 @@ This will clean up the entire project di
<h2>step 3: publication of dependee project</h2>
Go to <tt>dependee</tt> directory and publish the project
<div class="shell"><pre>
+[ivy@apache:/ivy/dependence/dependee]$ ant publish
+Buildfile: /ivy/dependence/dependee/build.xml
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: file = /ivy/dependence/settings/ivysettings.xml
+[ivy:retrieve] DEPRECATED: 'defaultCache' is deprecated, use 'caches[@defaultCacheDir]' instead (file://ivy/dependence/settings/ivysettings.xml)
+[ivy:retrieve] :: resolving dependencies :: org.apache#dependee;working@apache
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] found commons-lang#commons-lang;2.0 in libraries
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-lang/commons-lang/2.0/commons-lang-2.0.jar ...
+[ivy:retrieve] ...................................................................................................................................................................................................................................................................................................................................
+[ivy:retrieve] (165kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-lang#commons-lang;2.0!commons-lang.jar (3260ms)
+[ivy:retrieve] :: resolution report :: resolve 530ms :: artifacts dl 3260ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | default | 1 | 1 | 0 | 0 || 1 | 1 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#dependee
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] 1 artifacts copied, 0 already retrieved (165kB/31ms)
+
+compile:
+ [mkdir] Created dir: /ivy/dependence/dependee/build/classes
+ [javac] /ivy/dependence/dependee/build.xml:60: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 1 source file to /ivy/dependence/dependee/build/classes
+
+jar:
+[propertyfile] Creating new property file: /ivy/dependence/dependee/build/classes/version.properties
+ [jar] Building jar: /ivy/dependence/dependee/build/dependee.jar
+
+publish:
+[ivy:publish] :: delivering :: org.apache#dependee;working@apache :: 1 :: release :: Thu Sep 23 23:15:49 CEST 2010
+[ivy:publish] delivering ivy file to /ivy/dependence/dependee/build/ivy.xml
+[ivy:publish] :: publishing :: org.apache#dependee
+[ivy:publish] published dependee to /ivy/dependence/settings/repository/dependee-1.jar
+[ivy:publish] published ivy to /ivy/dependence/settings/repository/dependee-1.xml
+ [echo] project dependee released with version 1
+
+BUILD SUCCESSFUL
+Total time: 6 seconds
</pre></div>
What we see here:
@@ -180,6 +225,48 @@ Both are just copies of the files found
<h2>step 4: running the depender project</h2>
Go to directory depender and run <tt>ant</tt>
<div class="shell"><pre>
+[ivy@apache:/ivy/dependence/depender]$ ant
+Buildfile: /ivy/dependence/depender/build.xml
+
+clean:
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: file = /ivy/dependence/settings/ivysettings.xml
+[ivy:retrieve] DEPRECATED: 'defaultCache' is deprecated, use 'caches[@defaultCacheDir]' instead (file://ivy/dependence/settings/ivysettings.xml)
+[ivy:retrieve] :: resolving dependencies :: org.apache#depender;working@apache
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] found org.apache#dependee;1 in projects
+[ivy:retrieve] [1] org.apache#dependee;latest.integration
+[ivy:retrieve] found commons-lang#commons-lang;2.0 in libraries
+[ivy:retrieve] downloading /ivy/dependence/settings/repository/dependee-1.jar ...
+[ivy:retrieve] .. (1kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] org.apache#dependee;1!dependee.jar (16ms)
+[ivy:retrieve] :: resolution report :: resolve 343ms :: artifacts dl 47ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | default | 2 | 1 | 1 | 0 || 2 | 1 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#depender
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] 2 artifacts copied, 0 already retrieved (167kB/47ms)
+
+compile:
+ [mkdir] Created dir: /ivy/dependence/depender/build/classes
+ [javac] /ivy/dependence/depender/build.xml:71: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 1 source file to /ivy/dependence/depender/build/classes
+
+run:
+ [java] you are using version 1 of class standalone.Main
+ [java] standard message : i am depending.Main and standalone.Main will do the job for me
+ [java] [standalone.Main] capitalizing string "i am depending.Main and standalone.Main will do the job for me" using org.apache.commons.lang.WordUtils
+ [java] capitalized message : I Am Depending.main And Standalone.main Will Do The Job For Me
+
+BUILD SUCCESSFUL
+Total time: 3 seconds
</pre></div>
What we see here:
@@ -194,6 +281,45 @@ What we see here:
<h2>step 5: new version of dependee project</h2>
Like we did before in step 3, publish the dependee project again. This will result in a new version of the project being published.
<div class="shell"><pre>
+[ivy@apache:/ivy/dependence/dependee]$ ant publish
+Buildfile: /ivy/dependence/dependee/build.xml
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: file = /ivy/dependence/settings/ivysettings.xml
+[ivy:retrieve] DEPRECATED: 'defaultCache' is deprecated, use 'caches[@defaultCacheDir]' instead (file://ivy/dependence/settings/ivysettings.xml)
+[ivy:retrieve] :: resolving dependencies :: org.apache#dependee;working@apache
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] found commons-lang#commons-lang;2.0 in libraries
+[ivy:retrieve] :: resolution report :: resolve 109ms :: artifacts dl 0ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | default | 1 | 0 | 0 | 0 || 1 | 0 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#dependee
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] 0 artifacts copied, 1 already retrieved (0kB/0ms)
+
+compile:
+ [javac] /ivy/dependence/dependee/build.xml:60: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+
+jar:
+[propertyfile] Updating property file: /ivy/dependence/dependee/build/classes/version.properties
+ [jar] Building jar: /ivy/dependence/dependee/build/dependee.jar
+
+publish:
+ [delete] Deleting: /ivy/dependence/dependee/build/ivy.xml
+[ivy:publish] :: delivering :: org.apache#dependee;working@apache :: 2 :: release :: Thu Sep 23 23:15:56 CEST 2010
+[ivy:publish] delivering ivy file to /ivy/dependence/dependee/build/ivy.xml
+[ivy:publish] :: publishing :: org.apache#dependee
+[ivy:publish] published dependee to /ivy/dependence/settings/repository/dependee-2.jar
+[ivy:publish] published ivy to /ivy/dependence/settings/repository/dependee-2.xml
+ [echo] project dependee released with version 2
+
+BUILD SUCCESSFUL
+Total time: 1 second
</pre></div>
Now if you look in your repository folder, you will find 2 versions of the dependee project.<br class="xooki-br"/>Let's look at it:
@@ -209,6 +335,44 @@ What should we expect if we run the depe
</ul>
Let's try it!!
<div class="shell"><pre>
+[ivy@apache:/ivy/dependence/depender]$ ant
+Buildfile: /ivy/dependence/depender/build.xml
+
+clean:
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: file = /ivy/dependence/settings/ivysettings.xml
+[ivy:retrieve] DEPRECATED: 'defaultCache' is deprecated, use 'caches[@defaultCacheDir]' instead (file://ivy/dependence/settings/ivysettings.xml)
+[ivy:retrieve] :: resolving dependencies :: org.apache#depender;working@apache
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] found org.apache#dependee;1 in projects
+[ivy:retrieve] [1] org.apache#dependee;latest.integration
+[ivy:retrieve] found commons-lang#commons-lang;2.0 in libraries
+[ivy:retrieve] :: resolution report :: resolve 94ms :: artifacts dl 15ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | default | 2 | 0 | 0 | 0 || 2 | 0 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#depender
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] 2 artifacts copied, 0 already retrieved (167kB/31ms)
+
+compile:
+ [mkdir] Created dir: /ivy/dependence/depender/build/classes
+ [javac] /ivy/dependence/depender/build.xml:71: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 1 source file to /ivy/dependence/depender/build/classes
+
+run:
+ [java] you are using version 1 of class standalone.Main
+ [java] standard message : i am depending.Main and standalone.Main will do the job for me
+ [java] [standalone.Main] capitalizing string "i am depending.Main and standalone.Main will do the job for me" using org.apache.commons.lang.WordUtils
+ [java] capitalized message : I Am Depending.main And Standalone.main Will Do The Job For Me
+
+BUILD SUCCESSFUL
+Total time: 2 seconds
</pre></div>
OK, we got what we expected as the <tt>run</tt> target shows that we are using version 2 of the main class of the dependee project. If we take a look at the resolve target results, we see that one artifact has been downloaded to the ivy cache. In fact, this file is the same version 2 of the dependee project that is in the repository, but now all future retrievals will pull it from your ivy-cache directory.
Modified: ant/ivy/site/target/history/2.2.0/tutorial/dual.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/tutorial/dual.html?rev=1052406&r1=1052405&r2=1052406&view=diff
==============================================================================
--- ant/ivy/site/target/history/2.2.0/tutorial/dual.html (original)
+++ ant/ivy/site/target/history/2.2.0/tutorial/dual.html Thu Dec 23 23:04:17 2010
@@ -138,6 +138,52 @@ This will clean up the entire project di
<h2>step 3 : run the project</h2>
Go to the project directory. And simply run <tt>ant</tt>.
<div class="shell"><pre>
+[ivy@apache:/ivy/dual/project]$ ant
+Buildfile: /ivy/dual/project/build.xml
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: file = /ivy/dual/settings/ivysettings.xml
+[ivy:retrieve] :: resolving dependencies :: org.apache#hello-ivy;working@apache
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] found commons-httpclient#commons-httpclient;2.0.2 in ivys
+[ivy:retrieve] found commons-logging#commons-logging;1.0.4 in ibiblio
+[ivy:retrieve] found commons-lang#commons-lang;2.0 in ibiblio
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-httpclient/commons-httpclient/2.0.2/commons-httpclient-2.0.2.jar ...
+[ivy:retrieve] .................................................................................................................................................................................................................................................................................................................................................................................................................................................... (220kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-httpclient#commons-httpclient;2.0.2!commons-httpclient.jar (3853ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-lang/commons-lang/2.0/commons-lang-2.0.jar ...
+[ivy:retrieve] ................................................................................................................................................................................................................................................................................................................................................ (165kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-lang#commons-lang;2.0!commons-lang.jar (1826ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-logging/commons-logging/1.0.4/commons-logging-1.0.4.jar ...
+[ivy:retrieve] .......................................................................... (37kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-logging#commons-logging;1.0.4!commons-logging.jar (1341ms)
+[ivy:retrieve] :: resolution report :: resolve 1076ms :: artifacts dl 7036ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | default | 3 | 3 | 1 | 0 || 3 | 3 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#hello-ivy
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] 3 artifacts copied, 0 already retrieved (423kB/47ms)
+
+run:
+ [mkdir] Created dir: /ivy/dual/project/build
+ [javac] /ivy/dual/project/build.xml:58: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 1 source file to /ivy/dual/project/build
+ [java] standard message : hello ivy !
+ [java] capitalized by org.apache.commons.lang.WordUtils : Hello Ivy !
+ [java] head status code with httpclient: 200
+ [java] now check if httpclient dependency on commons-logging has been realized
+ [java] found logging class in classpath: interface org.apache.commons.logging.Log
+
+BUILD SUCCESSFUL
+Total time: 10 seconds
</pre></div></div>
<br/>
Modified: ant/ivy/site/target/history/2.2.0/tutorial/multiple.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/tutorial/multiple.html?rev=1052406&r1=1052405&r2=1052406&view=diff
==============================================================================
--- ant/ivy/site/target/history/2.2.0/tutorial/multiple.html (original)
+++ ant/ivy/site/target/history/2.2.0/tutorial/multiple.html Thu Dec 23 23:04:17 2010
@@ -146,6 +146,44 @@ In almost all examples, we provide a cle
<h2>step 3: run the project</h2>
Go to <tt>chained-resolvers</tt> project directory. And simply run <tt>ant</tt>.<br class="xooki-br"/>
<div class="shell"><pre>
+[ivy@apache:/ivy/chained-resolvers/chainedresolvers-project]$ ant
+Buildfile: /ivy/chained-resolvers/chainedresolvers-project/build.xml
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: file = /ivy/chained-resolvers/settings/ivysettings.xml
+[ivy:retrieve] :: resolving dependencies :: org.apache#chained-resolvers;working@apache
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] found commons-lang#commons-lang;2.0 in ibiblio
+[ivy:retrieve] found org.apache#test;1.0 in libraries
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-lang/commons-lang/2.0/commons-lang-2.0.jar ...
+[ivy:retrieve] ........................................................................................................................................................................................................................................................................................................................................... (165kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-lang#commons-lang;2.0!commons-lang.jar (2745ms)
+[ivy:retrieve] downloading /ivy/chained-resolvers/settings/repository/test-1.0.jar ...
+[ivy:retrieve] .. (1kB)
+[ivy:retrieve] [SUCCESSFUL ] org.apache#test;1.0!test.jar (16ms)
+[ivy:retrieve] :: resolution report :: resolve 4836ms :: artifacts dl 2761ms
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | default | 2 | 2 | 1 | 0 || 2 | 2 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#chained-resolvers
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] 2 artifacts copied, 0 already retrieved (166kB/62ms)
+
+run:
+ [mkdir] Created dir: /ivy/chained-resolvers/chainedresolvers-project/build
+ [javac] /ivy/chained-resolvers/chainedresolvers-project/build.xml:58: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 1 source file to /ivy/chained-resolvers/chainedresolvers-project/build
+ [java] standard message :example world !
+ [java] capitalized by org.apache.commons.lang.WordUtils : Example World !
+ [java] upperCased by test.StringUtils : EXAMPLE WORLD !
+
+BUILD SUCCESSFUL
+Total time: 10 seconds
</pre></div></div>
Modified: ant/ivy/site/target/history/2.2.0/tutorial/multiproject.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/tutorial/multiproject.html?rev=1052406&r1=1052405&r2=1052406&view=diff
==============================================================================
--- ant/ivy/site/target/history/2.2.0/tutorial/multiproject.html (original)
+++ ant/ivy/site/target/history/2.2.0/tutorial/multiproject.html Thu Dec 23 23:04:17 2010
@@ -169,11 +169,36 @@ This target is used when you don't want
Generates both an html report and a graphml report.<br class="xooki-br"/><br class="xooki-br"/>For example, to generate a graph like the one shown at the beginning of this tutorial, you just have to follow the instructions given <a href="../yed.html">here</a> with the graphml file you will find in <pre>projects/console/build/</pre> after having called report in the console project, and that's it, you have a clear overview of all your app dependencies!<br class="xooki-br"/><br class="xooki-br"/><h1>Playing with the projects</h1>
You can play with this tutorial by using regular Ant commands. Begin in the base directory of the tutorial (src/example/multi-project), and run ant -p:
<div class="shell"><pre>
+[ivy@apache:/ivy/multi-project]$ ant -p
+Buildfile: /ivy/multi-project/build.xml
+
+Main targets:
+
+ clean clean tutorial: delete repository, ivy cache, and all projects
+ clean-all clean all projects
+ publish-all compile, jar and publish all projects in the right order
</pre></div>
This gives you an idea of what you can do here. To make sure you have at least one version of all your modules published in your repository (required to build modules having dependencies on the others), you can run <tt>ant publish-all</tt> (example log <a href="log/multi-project-general-publishall.txt">here</a>).<br class="xooki-br"/><br class="xooki-br"/>You will see that Ivy calls the publish target on all the modules, following the order of the dependencies, so that a dependee is always built and published before its depender. Feel free to make changes in the source code of a module (changing a method name for instance) and in the module using the method, then call publish-all to see how the change in the dependee is compiled first, published, and then available to the depender which can compile successfully.<br class="xooki-br"/><br class="xooki-br"/>Then you can go in one of the example project directories (like projects/find for instance), and run <tt>ant -p</tt>:
<div class="shell"><pre>
+[ivy@apache:/ivy/multi-project/projects/find]$ ant -p
+Buildfile: /ivy/multi-project/projects/find/build.xml
+
+Main targets:
+
+ clean --> clean the project
+ clean-build --> clean the project built files
+ clean-lib --> clean the project libraries directory (dependencies)
+ clean-local --> cleans the local repository for the current module
+ compile --> compile the project
+ jar --> make a jar file for this project
+ publish --> publish this project in the ivy repository
+ publish-local --> publish this project in the local ivy repository
+ report --> generates a report of dependencies
+ resolve --> resolve and retrieve dependencies with ivy
+ run --> compile and run the project
+Default target: compile
</pre></div>
Modified: ant/ivy/site/target/history/2.2.0/tutorial/start.html
URL: http://svn.apache.org/viewvc/ant/ivy/site/target/history/2.2.0/tutorial/start.html?rev=1052406&r1=1052405&r2=1052406&view=diff
==============================================================================
--- ant/ivy/site/target/history/2.2.0/tutorial/start.html (original)
+++ ant/ivy/site/target/history/2.2.0/tutorial/start.html Thu Dec 23 23:04:17 2010
@@ -114,11 +114,104 @@ The corresponding build file contains a
As you can see, it's very easy to call Ivy to resolve and retrieve dependencies: all you need if Ivy is properly <a href="../install.html">installed</a> is to define an XML namespace in your Ant file (xmlns:ivy="antlib:org.apache.ivy.ant"). Then all the <a href="../ant.html">Ivy ant tasks</a> will be available in this namespace.<br class="xooki-br"/><br class="xooki-br"/>Here we use only one task: the <a href="../use/retrieve.html">retrieve</a> task. With no attributes, it will use default settings and look for a file named <tt>ivy.xml</tt> for the dependency definitions. That's exactly what we want, so we need nothing more than that.<br class="xooki-br"/><br class="xooki-br"/>Note that in this case we define a <tt>resolve</tt> target and call the <tt><a href="../use/retrieve.html">retrieve</a></tt> task. This may sound confusing, actually the retrieve task performs a <a href="../use/resolve.html">resolve</a> (which resolves dependencies and downloads them to a cache) follow
ed by a retrieve (a copy of those file to a local project directory). Check the <a href="../principle.html">How does it work ?</a> page for details about that.<br class="xooki-br"/><h1>Running the project</h1>
OK, now that we have seen the files involved, let's run the sample to see what happens. Open a shell (or command line) window, and enter the <tt>hello-ivy</tt> example directory.<br class="xooki-br"/>Then, at the command prompt, run <tt>ant</tt>:
<div class="shell"><pre>
+[ivy@apache:/ivy/hello-ivy]$ ant
+Buildfile: /ivy/hello-ivy/build.xml
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: url = jar:file:///home/ivy/ivy.jar!/org/apache/ivy/core/settings/ivysettings.xml
+[ivy:retrieve] :: resolving dependencies :: org.apache#hello-ivy;working@apache
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] found commons-lang#commons-lang;2.0 in public
+[ivy:retrieve] found commons-cli#commons-cli;1.0 in public
+[ivy:retrieve] found commons-logging#commons-logging;1.0 in public
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-lang/commons-lang/2.0/commons-lang-2.0-javadoc.jar ...
+[ivy:retrieve] ...................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................
+[ivy:retrieve] ............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................. (467kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-lang#commons-lang;2.0!commons-lang.jar(javadoc) (3697ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-lang/commons-lang/2.0/commons-lang-2.0.jar ...
+[ivy:retrieve] ............................................................................................................................................................................................................................................................................................................................................... (165kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-lang#commons-lang;2.0!commons-lang.jar (1997ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-lang/commons-lang/2.0/commons-lang-2.0-sources.jar ...
+[ivy:retrieve] ............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................ (245kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-lang#commons-lang;2.0!commons-lang.jar(source) (3495ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-cli/commons-cli/1.0/commons-cli-1.0-javadoc.jar ...
+[ivy:retrieve] ........................................................................................................................................................................................... (92kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-cli#commons-cli;1.0!commons-cli.jar(javadoc) (2137ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-cli/commons-cli/1.0/commons-cli-1.0.jar ...
+[ivy:retrieve] ......................................................... (29kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-cli#commons-cli;1.0!commons-cli.jar (1404ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-cli/commons-cli/1.0/commons-cli-1.0-sources.jar ...
+[ivy:retrieve] ...................................................................................................... (48kB)
+[ivy:retrieve] .. (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-cli#commons-cli;1.0!commons-cli.jar(source) (1529ms)
+[ivy:retrieve] downloading http://repo1.maven.org/maven2/commons-logging/commons-logging/1.0/commons-logging-1.0.jar ...
+[ivy:retrieve] ........................................... (21kB)
+[ivy:retrieve] ... (0kB)
+[ivy:retrieve] [SUCCESSFUL ] commons-logging#commons-logging;1.0!commons-logging.jar (2199ms)
+[ivy:retrieve] :: resolution report :: resolve 9095ms :: artifacts dl 16520ms
+[ivy:retrieve] :: evicted modules:
+[ivy:retrieve] commons-lang#commons-lang;1.0 by [commons-lang#commons-lang;2.0] in [default]
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | default | 4 | 3 | 3 | 1 || 7 | 7 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#hello-ivy
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] 7 artifacts copied, 0 already retrieved (1069kB/78ms)
+
+run:
+ [mkdir] Created dir: /ivy/hello-ivy/build
+ [javac] /ivy/hello-ivy/build.xml:53: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [javac] Compiling 1 source file to /ivy/hello-ivy/build
+ [java] standard message : hello ivy !
+ [java] capitalized by org.apache.commons.lang.WordUtils : Hello Ivy !
+
+BUILD SUCCESSFUL
+Total time: 28 seconds
</pre></div>
<h1>What happened ?</h1>
Without any settings, Ivy retrieves files from the maven 2 repository. That's what happened here. <br class="xooki-br"/>The resolve task has found the commons-lang and commons-cli modules in the maven 2 repository, identified that commons-cli depends on commons-logging and so resolved it as a transitive dependency. Then Ivy has downloaded all corresponding artifacts in its cache (by default in your user home, in a .ivy2/cache directory). Finally, the retrieve task copies the resolved jars from the ivy cache to the default library directory of the project: the lib dir (you can change this easily by setting the pattern attribute on the <a href="../use/retrieve.html">retrieve</a> task).<br class="xooki-br"/><br class="xooki-br"/>You might say that the task took a long time just to write out a "Hello Ivy!" message. But remember that a lot of time was spent downloading the required files from the web. Let's try to run it again:
<div class="shell"><pre>
+[ivy@apache:/ivy/hello-ivy]$ ant
+Buildfile: /ivy/hello-ivy/build.xml
+
+resolve:
+[ivy:retrieve] :: Ivy 2.2.0 - 20100923230623 :: http://ant.apache.org/ivy/ ::
+[ivy:retrieve] :: loading settings :: url = jar:file:///home/ivy/ivy.jar!/org/apache/ivy/core/settings/ivysettings.xml
+[ivy:retrieve] :: resolving dependencies :: org.apache#hello-ivy;working@apache
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] found commons-lang#commons-lang;2.0 in public
+[ivy:retrieve] found commons-cli#commons-cli;1.0 in public
+[ivy:retrieve] found commons-logging#commons-logging;1.0 in public
+[ivy:retrieve] :: resolution report :: resolve 343ms :: artifacts dl 16ms
+[ivy:retrieve] :: evicted modules:
+[ivy:retrieve] commons-lang#commons-lang;1.0 by [commons-lang#commons-lang;2.0] in [default]
+ ---------------------------------------------------------------------
+ | | modules || artifacts |
+ | conf | number| search|dwnlded|evicted|| number|dwnlded|
+ ---------------------------------------------------------------------
+ | default | 4 | 0 | 0 | 1 || 7 | 0 |
+ ---------------------------------------------------------------------
+[ivy:retrieve] :: retrieving :: org.apache#hello-ivy
+[ivy:retrieve] confs: [default]
+[ivy:retrieve] 0 artifacts copied, 7 already retrieved (0kB/15ms)
+
+run:
+ [javac] /ivy/hello-ivy/build.xml:53: warning: 'includeantruntime' was not set, defaulting to build.sysclasspath=last; set to false for repeatable builds
+ [java] standard message : hello ivy !
+ [java] capitalized by org.apache.commons.lang.WordUtils : Hello Ivy !
+
+BUILD SUCCESSFUL
+Total time: 1 second
</pre></div>
Great! The cache was used, so no download was needed and the build was instantaneous.<br class="xooki-br"/><br class="xooki-br"/>And now, if you want to generate a report detailing all the dependencies of your module, you can call the report target, and check the generated file in the build directory. You should obtain something looking like <a href="../samples/apache-hello-ivy-default.html">this</a>.<br class="xooki-br"/><br class="xooki-br"/>As you can see, using Ivy to resolve dependencies stored in the maven 2 repository is extremely easy. Now you can go on with the next tutorials to learn more about <a href="../tutorial/conf.html">how to use module configurations</a> which is a very powerful Ivy specific feature. Other tutorials are also available where you will learn how to use Ivy settings to leverage a possibly complex enterprise repository. It may also be a good time to start reading the <a href="../reference.html">reference documentation</a>, and especially the int
roduction material which gives a good overview of Ivy. The <a href="../bestpractices.html">best practices</a> page is also a must read to start thinking about how to use Ant+Ivy to build a clean and robust build system.