Repository: ant-ivy Updated Branches: refs/heads/master 87cd5df6f -> ff49f0dd3
http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b02336b7/asciidoc/use/retrieve.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/retrieve.adoc b/asciidoc/use/retrieve.adoc index 024c7fe..8aaf9ee 100644 --- a/asciidoc/use/retrieve.adoc +++ b/asciidoc/use/retrieve.adoc @@ -73,7 +73,7 @@ Available options are the same as for link:../use/resolve.html[resolve] when use [source,xml] ---- -<ivy:retrieve /> +<ivy:retrieve/> ---- Retrieves dependencies using default parameters. This usually retrieves all the dependencies of the last resolve call to a lib directory. @@ -104,7 +104,7 @@ Note that if a dependency is required in the two configurations, it will be copi [source,xml] ---- -<ivy:retrieve pattern="${lib.dir}/[conf]/[artifact].[ext]" sync="true" /> +<ivy:retrieve pattern="${lib.dir}/[conf]/[artifact].[ext]" sync="true"/> ---- Same as before, but with synchronisation enabled. @@ -159,7 +159,7 @@ lib [source,xml] ---- -<ivy:retrieve pattern="${lib.dir}/[organisation]/[artifact]-[revision].[ext]" /> +<ivy:retrieve pattern="${lib.dir}/[organisation]/[artifact]-[revision].[ext]"/> ---- Retrieves all dependencies of the last resolve call to a lib directory. The `[organisation]` token will get the unmodified organisation value. The resulting lib dir could look like this: @@ -176,7 +176,7 @@ lib [source,xml] ---- -<ivy:retrieve pattern="${lib.dir}/[orgPath]/[artifact]-[revision].[ext]" /> +<ivy:retrieve pattern="${lib.dir}/[orgPath]/[artifact]-[revision].[ext]"/> ---- Retrieves all dependencies of the last resolve call to a lib directory. The `[orgPath]` token will get a tree structure. The resulting lib dir could look like this: @@ -207,7 +207,7 @@ Resolves and retrieve the latest version of the module bar and its dependencies ---- <ivy:retrieve pattern="lib/[artifact]-[revision].[ext]"> <firstmatchmapper> - <globmapper from="lib/*-SNAPSHOT.jar" to="lib/snapshots/*-SNAPSHOT.jar" /> + <globmapper from="lib/*-SNAPSHOT.jar" to="lib/snapshots/*-SNAPSHOT.jar"/> <globmapper from="lib/*" to="lib/releases/*"/> </firstmatchmapper> </ivy:retrieve> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b02336b7/asciidoc/use/settings.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/settings.adoc b/asciidoc/use/settings.adoc index b358d4c..4c98e07 100644 --- a/asciidoc/use/settings.adoc +++ b/asciidoc/use/settings.adoc @@ -27,7 +27,7 @@ Multiple settings can be defined in a build script. Every task can reference its All Ivy variables set during the settings are available in the Ant project as long as they were not set in Ant before (Ant properties are immutable). -Moreover, the variables are exposed under two names: the variable name, and the variable name suffixed by dot + the settings id. +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,properties] @@ -42,7 +42,7 @@ my.variable.yourid=your.value [options="header",cols="15%,50%,35%"] |======= |Attribute|Description|Required -|id|The settings id useable in the `settingsRef` attributes of the ivy task that needs a setting.|No, defaults to `ivy.instance` +|id|The settings id usable in the `settingsRef` attributes of the ivy task that needs a setting.|No, defaults to `ivy.instance` |file|path to the settings file to use .2+.^|No. If a file is provided, url is ignored. If none are provided, then it attempts to find a file at `${ivy.settings.file}`, and if this file does not exist, it uses a link:../tutorial/defaultconf.html[default settings file] |url|url of the settings file to use @@ -69,7 +69,7 @@ A special attention should be applied when you have a multi-project build with ` [source,xml] ---- -<ivy:settings /> +<ivy:settings/> ---- Use either `${ivy.settings.file}` if it exists, or the link:../samples/ivysettings-default.xml[default settings file] @@ -80,23 +80,23 @@ This simplest setting is implicit. [source,xml] ---- -<ivy:settings file="mysettings.xml" /> +<ivy:settings file="mysettings.xml"/> ---- === Configure with an url [source,xml] ---- -<ivy:settings url="http://mysite.com/mysettings.xml"; /> +<ivy:settings url="http://mysite.com/mysettings.xml"/> ---- -=== Configure multiple realms which require autentication +=== Configure multiple realms which require authentication [source,xml] ---- <ivy:settings file="path/to/my/ivysettings.xml"> - <credentials host="myhost.com" realm="My Realm" username="myuser" passwd="mypasswd" /> - <credentials host="yourhost.com" realm="Your Realm" username="myuser" passwd="myotherpasswd" /> + <credentials host="myhost.com" realm="My Realm" username="myuser" passwd="mypasswd"/> + <credentials host="yourhost.com" realm="Your Realm" username="myuser" passwd="myotherpasswd"/> </ivy:settings> ---- @@ -106,9 +106,9 @@ You can use multiple ivy settings during a build. Then every ivy task should spe [source,xml] ---- - <ivy:settings id="ivy.normal.settings" file="normal_settings.xml" /> - <ivy:settings id="ivy.release.settings" file="release_settings.xml" /> + <ivy:settings id="ivy.normal.settings" file="normal_settings.xml"/> + <ivy:settings id="ivy.release.settings" file="release_settings.xml"/> - <ivy:resolve settingsRef="ivy.normal.settings" /> - <ivy:resolve settingsRef="ivy.release.settings" /> + <ivy:resolve settingsRef="ivy.normal.settings"/> + <ivy:resolve settingsRef="ivy.release.settings"/> ---- http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b02336b7/asciidoc/use/var.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/use/var.adoc b/asciidoc/use/var.adoc index 61d20a3..7fc4e96 100644 --- a/asciidoc/use/var.adoc +++ b/asciidoc/use/var.adoc @@ -21,7 +21,7 @@ Sets a variable (by name and value), or set of variables (from file or url) in I Variables are case sensitive. -Contrary to ant properties, ivy variables are mutable. But a problem with this is that you do not control when +Contrary to ant properties, ivy variables are mutable. But a problem with this is that you do not control when variables are substituted, and usually it is done as soon as possible. So changing the value of a variable will have no effect if it has already been substituted. Consequently, *using this task is NOT recommended*. http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b02336b7/asciidoc/yed.adoc ---------------------------------------------------------------------- diff --git a/asciidoc/yed.adoc b/asciidoc/yed.adoc index 095c7de..8c7c4e1 100644 --- a/asciidoc/yed.adoc +++ b/asciidoc/yed.adoc @@ -20,7 +20,7 @@ link:http://www.yworks.com/en/products_yed_about.htm[yEd] is a free graph editor, benefiting from all the automatic layouts of yFiles. Ivy is able to generate graphs which are readable by yEd. -The graphs generated by Ivy are not layed out (in fact it's why we use yEd), so you have to follow a simple sequence of steps to layout the generated graphs. +The graphs generated by Ivy are not laid out (in fact it's why we use yEd), so you have to follow a simple sequence of steps to layout the generated graphs. == Preparation @@ -53,4 +53,4 @@ That's all, you should have obtained something like this: image::images/yed-step7.jpg[] Note that this is only one possibility, test the available layouts yourself, you could find one better in your case. -Once you have layed out the graph, you can either save it with in the same file (but be warned that it will be overwritten at next ivy report call), or another file, export it to jpg, gif, svg, etc. (see link:http://www.yworks.com/en/products_yed_about.htm[yEd] site for details). +Once you have laid out the graph, you can either save it with in the same file (but be warned that it will be overwritten at next ivy report call), or another file, export it to jpg, gif, svg, etc. (see link:http://www.yworks.com/en/products_yed_about.htm[yEd] site for details). http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b02336b7/build-release.xml ---------------------------------------------------------------------- diff --git a/build-release.xml b/build-release.xml index 84bd0e2..e01b122 100644 --- a/build-release.xml +++ b/build-release.xml @@ -17,10 +17,11 @@ under the License. --> <project name="IvyRelease" default="snapshot" - xmlns:ivy="antlib:org.apache.ivy.ant" - xmlns:ivy2="antlib:org.apache.ivy.ant_2" - xmlns:asciidoctor="antlib:org.asciidoctor.ant" - xmlns:openpgp="antlib:org.apache.commons.openpgp.ant"> + xmlns:ivy="antlib:org.apache.ivy.ant" + xmlns:ivy2="antlib:org.apache.ivy.ant_2" + xmlns:asciidoctor="antlib:org.asciidoctor.ant" + xmlns:openpgp="antlib:org.apache.commons.openpgp.ant"> + <import file="build.xml"/> <macrodef name="run-tutorial"> @@ -314,7 +315,7 @@ <zipfileset dir="${build.dir}/lib" prefix="${snapshot.full.name}/lib" excludes="ant-*.jar,bcpg-*.jar,bcprov*.jar"/> </zip> <tar destfile="${distrib.dir}/dist/${build.version}/${snapshot.full.name}-bin-with-deps.tar.gz" - compression="gzip" longfile="gnu"> + compression="gzip" longfile="gnu"> <zipfileset src="${distrib.dir}/dist/${build.version}/${snapshot.full.name}-bin-with-deps.zip"/> </tar> </target> @@ -336,14 +337,14 @@ <mapping conf="test" scope="test"/> </ivy:makepom> <copy file="${artifacts.build.dir}/jars/${final.name}" - tofile="${m2.distrib.dir}/ivy-${build.version}.jar"/> + tofile="${m2.distrib.dir}/ivy-${build.version}.jar"/> <!-- jar javadocs --> <jar destfile="${m2.distrib.dir}/ivy-${build.version}-javadoc.jar"> <fileset dir="${javadoc.build.dir}"/> </jar> <!-- copy sources jar --> <copy file="${artifacts.build.dir}/sources/${final.name}" - tofile="${m2.distrib.dir}/ivy-${build.version}-sources.jar"/> + tofile="${m2.distrib.dir}/ivy-${build.version}-sources.jar"/> <checksum algorithm="md5"> <fileset dir="${m2.distrib.dir}"> @@ -412,18 +413,18 @@ <ivy2:settings id="sign.settingsId" file="ivysettings-release.xml"/> <ivy2:cachepath organisation="org.apache.commons" settingsRef="sign.settingsId" transitive="false" log="download-only" - module="commons-openpgp" revision="1.0-SNAPSHOT" inline="true" pathid="openpgp.classpath"/> + module="commons-openpgp" revision="1.0-SNAPSHOT" inline="true" pathid="openpgp.classpath"/> <ivy2:cachepath organisation="org.bouncycastle" settingsRef="sign.settingsId" log="download-only" - module="bcprov-jdk16" revision="1.45" inline="true" pathid="bouncycastle.bcprov.classpath"/> + module="bcprov-jdk16" revision="1.45" inline="true" pathid="bouncycastle.bcprov.classpath"/> <ivy2:cachepath organisation="org.bouncycastle" settingsRef="sign.settingsId" transitive="false" log="download-only" - module="bcpg-jdk16" revision="1.45" inline="true" pathid="bouncycastle.bcpg.classpath"/> + module="bcpg-jdk16" revision="1.45" inline="true" pathid="bouncycastle.bcpg.classpath"/> <!-- For some reason, if we use the openpgp:signer task here directly, the bouncycastle security provider cannot be loaded. If we launch it as a forked process everything works fine !?! --> <java classname="org.apache.tools.ant.launch.Launcher" - fork="true"> + fork="true"> <classpath> <fileset dir="${ant.home}" includes="**/*.jar"/> <path refid="bouncycastle.bcprov.classpath"/> @@ -535,10 +536,14 @@ </target> <target name="prepare-snapshot" - depends="/localivy, clean-ivy-home, clean, clean-lib, snapshot-version, install, clean-examples, test-report" /> + depends="/localivy,clean-ivy-home,clean,clean-lib,snapshot-version,install,clean-examples,test-report"/> + <target name="snapshot" depends="prepare-snapshot,snapshot-src,snapshot-bin,snapshot-maven2,snapshot-checksums" description="used for nightly and integration builds"/> - <target name="release" depends="release-version,/localivy,clean-ivy-home,clean,clean-lib,rat,snapshot" description="make a new release of Ivy"/> + + <target name="release" + depends="release-version,/localivy,clean-ivy-home,clean,clean-lib,rat,snapshot" + description="make a new release of Ivy"/> </project> http://git-wip-us.apache.org/repos/asf/ant-ivy/blob/b02336b7/build.xml ---------------------------------------------------------------------- diff --git a/build.xml b/build.xml index 5f35c06..834123f 100644 --- a/build.xml +++ b/build.xml @@ -39,7 +39,7 @@ <target name="init-ivy" depends="compile-bootstrap,init-ivy-home"> <taskdef resource="org/apache/ivy/ant/antlib.xml" - uri="antlib:org.apache.ivy.ant"> + uri="antlib:org.apache.ivy.ant"> <classpath> <pathelement location="${core.classes.build.dir}"/> <pathelement location="${bootstrap.classes.build.dir}"/> @@ -50,7 +50,7 @@ </target> <target name="install" depends="jar" - description="build Ivy and install it in Ivy user home for builds using Ivy user home to load Ivy jar"> + description="build Ivy and install it in Ivy user home for builds using Ivy user home to load Ivy jar"> <property name="ivy.jar.file" value="${ivy.home}/jars/ivy.jar"/> <copy file="${artifacts.build.dir}/jars/${final.name}" tofile="${ivy.jar.file}"/> </target> @@ -95,8 +95,6 @@ <include name="*.jar"/> <exclude name="ant.jar"/> <exclude name="ant-launcher.jar"/> - <exclude name="ant-nodeps.jar"/> - <exclude name="ant-trax.jar"/> </fileset> <pathelement location="${core.classes.build.dir}"/> <pathelement location="${ant.classes.build.dir}"/> @@ -185,13 +183,13 @@ </target> <target name="compile-core" depends="prepare"> - <javac srcdir="${src.dir}" - destdir="${core.classes.build.dir}" - sourcepath="" - source="${ivy.minimum.javaversion}" - target="${ivy.minimum.javaversion}" - debug="${debug.mode}" - includeantruntime="no"> + <javac srcdir="${src.dir}" + destdir="${core.classes.build.dir}" + sourcepath="" + source="${ivy.minimum.javaversion}" + target="${ivy.minimum.javaversion}" + debug="${debug.mode}" + includeantruntime="no"> <excludesfile name="ant.patterns"/> <excludesfile name="optional.patterns"/> </javac> @@ -220,14 +218,14 @@ <!-- Build the Ant tasks with the current Ant runtime --> <target name="compile-bootstrap" depends="compile-core"> - <javac srcdir="${src.dir}" - destdir="${bootstrap.classes.build.dir}" - sourcepath="" - classpathref="build.bootstrap.classpath" - source="${ivy.minimum.javaversion}" - target="${ivy.minimum.javaversion}" - debug="${debug.mode}" - includeantruntime="yes"> + <javac srcdir="${src.dir}" + destdir="${bootstrap.classes.build.dir}" + sourcepath="" + classpathref="build.bootstrap.classpath" + source="${ivy.minimum.javaversion}" + target="${ivy.minimum.javaversion}" + debug="${debug.mode}" + includeantruntime="yes"> <includesfile name="ant.patterns"/> </javac> <copy todir="${bootstrap.classes.build.dir}" includeEmptyDirs="false"> @@ -240,14 +238,14 @@ <!-- Build the Ant tasks with the minimal Ant runtime --> <target name="compile-ant" depends="compile-core,resolve"> - <javac srcdir="${src.dir}" - destdir="${ant.classes.build.dir}" - sourcepath="" - classpathref="build.ant.classpath" - source="${ivy.minimum.javaversion}" - target="${ivy.minimum.javaversion}" - debug="${debug.mode}" - includeantruntime="no"> + <javac srcdir="${src.dir}" + destdir="${ant.classes.build.dir}" + sourcepath="" + classpathref="build.ant.classpath" + source="${ivy.minimum.javaversion}" + target="${ivy.minimum.javaversion}" + debug="${debug.mode}" + includeantruntime="no"> <includesfile name="ant.patterns"/> </javac> <copy todir="${ant.classes.build.dir}" includeEmptyDirs="false"> @@ -263,14 +261,14 @@ </target> <target name="compile-optional" depends="compile-ant"> - <javac srcdir="${src.dir}" - destdir="${optional.classes.build.dir}" - sourcepath="" - classpathref="build.optional.classpath" - source="${ivy.minimum.javaversion}" - target="${ivy.minimum.javaversion}" - debug="${debug.mode}" - includeantruntime="no"> + <javac srcdir="${src.dir}" + destdir="${optional.classes.build.dir}" + sourcepath="" + classpathref="build.optional.classpath" + source="${ivy.minimum.javaversion}" + target="${ivy.minimum.javaversion}" + debug="${debug.mode}" + includeantruntime="no"> <includesfile name="optional.patterns"/> <includesfile name="ant.patterns"/> </javac> @@ -310,7 +308,7 @@ </copy> <jar destfile="${artifacts.build.dir}/jars/${final.name}" - manifest="${artifacts.build.dir}/MANIFEST.MF"> + manifest="${artifacts.build.dir}/MANIFEST.MF"> <metainf dir="${basedir}" includes="LICENSE,NOTICE"/> <manifest> <attribute name="Specification-Title" value="Apache Ivy with Ant tasks"/> @@ -346,14 +344,14 @@ TESTS ================================================================= --> <target name="build-test" depends="jar"> - <javac srcdir="${test.dir}" - destdir="${test.build.dir}" - classpathref="run.classpath" - source="${ivy.minimum.javaversion}" - target="${ivy.minimum.javaversion}" - debug="${debug.mode}" - encoding="UTF-8" - includeantruntime="no"/> + <javac srcdir="${test.dir}" + destdir="${test.build.dir}" + classpathref="run.classpath" + source="${ivy.minimum.javaversion}" + target="${ivy.minimum.javaversion}" + debug="${debug.mode}" + encoding="UTF-8" + includeantruntime="no"/> <copy todir="${test.build.dir}"> <fileset dir="${test.dir}"> <exclude name="**/*.java"/> @@ -363,15 +361,15 @@ <target name="build-custom-resolver-jar" depends="jar"> <mkdir dir="${build.dir}/custom-classpath"/> - <javac srcdir="${basedir}/test/custom-classpath" - destdir="${build.dir}/custom-classpath" - classpathref="run.classpath" - source="${ivy.minimum.javaversion}" - target="${ivy.minimum.javaversion}" - debug="${debug.mode}" - includeantruntime="no"/> - <jar destfile="${test.dir}/org/apache/ivy/core/settings/custom-resolver.jar" - basedir="${build.dir}/custom-classpath"/> + <javac srcdir="${basedir}/test/custom-classpath" + destdir="${build.dir}/custom-classpath" + classpathref="run.classpath" + source="${ivy.minimum.javaversion}" + target="${ivy.minimum.javaversion}" + debug="${debug.mode}" + includeantruntime="no"/> + <jar destfile="${test.dir}/org/apache/ivy/core/settings/custom-resolver.jar" + basedir="${build.dir}/custom-classpath"/> </target> <target name="init-tests-offline" if="offline"> @@ -551,7 +549,7 @@ <target name="init-checkstyle" depends="jar"> <ivy:cachepath organisation="com.puppycrawl.tools" module="checkstyle" revision="7.8.1" - inline="true" conf="default" pathid="checkstyle.classpath" log="download-only"/> + inline="true" conf="default" pathid="checkstyle.classpath" log="download-only"/> <taskdef uri="antlib:com.puppycrawl.tools.checkstyle.ant" resource="com/puppycrawl/tools/checkstyle/ant/antlib.xml" classpathref="checkstyle.classpath"/> </target> @@ -560,8 +558,8 @@ <target name="checkstyle-internal" depends="init-checkstyle"> <mkdir dir="${checkstyle.report.dir}"/> <cs:checkstyle xmlns:cs="antlib:com.puppycrawl.tools.checkstyle.ant" - config="${checkstyle.src.dir}/checkstyle-config" - failOnViolation="false" failureProperty="checkstyle.failed"> + config="${checkstyle.src.dir}/checkstyle-config" + failOnViolation="false" failureProperty="checkstyle.failed"> <classpath> <path refid="run.classpath"/> </classpath> @@ -576,7 +574,7 @@ </target> <target name="checkstyle" depends="checkstyle-internal" - description="checks Ivy codebase according to ${checkstyle.src.dir}/checkstyle-config"> + description="checks Ivy codebase according to ${checkstyle.src.dir}/checkstyle-config"> <fail if="checkstyle.failed" message="Checkstyle has errors. See report in ${checkstyle.report.dir}"/> </target> @@ -584,8 +582,8 @@ <target name="checkstyle-report" depends="checkstyle-internal"> <property name="checkstyle.basedir" location="${src.dir}"/> <xslt in="${checkstyle.report.dir}/checkstyle.xml" - style="${checkstyle.src.dir}/checkstyle-frames.xsl" - out="${checkstyle.report.dir}/output.txt"> + style="${checkstyle.src.dir}/checkstyle-frames.xsl" + out="${checkstyle.report.dir}/output.txt"> <param name="basedir" expression="${checkstyle.basedir}"/> <param name="output.dir" expression="${checkstyle.report.dir}"/> </xslt>
