natas_hw
/
ant-ivy
mirror of https://github.com/apache/ant-ivy
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix remaining < and > coming from not translated xooki markup

This commit is contained in:
Nicolas Lalevée 2017-06-19 23:37:26 +02:00
parent 77f7a62702
commit 341ea670ba
15 changed files with 35 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
asciidoc/ivyfile/dependencies.adoc
View File

@ -31,8 +31,8 @@ In Ivy 2.1.0 and earlier, if both defaultconf and defaultconfmapping are defined
[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__*</em>|No, defaults to *->*
|defaultconfmapping|the default configuration mapping to use in this ivy file. *__since 1.3__*</em>|No, defaults to no default conf mapping
|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
|=======

10
asciidoc/osgi/eclipse-plugin.adoc
View File

@ -3,13 +3,9 @@
[NOTE]
====
Note that this feature is considered as *experimental*.
<table class="notice">
<tr>
<td style="vertical-align: top"><svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="1em" version="1.1" y="0px" x="0px" viewBox="0 0 980.02045 886.1"><g fill="red"><path d="m972.9158,794.5l-426.1,-761.1c-10.5,-20 -31.1,-32.7 -53.7,-33.4l-1.7,0c-22,0 -42.4,11.5 -53.7,30.5l-428.9,761c-11.5,19.4 -11.8,43.3 -0.6,62.9c11.1,19.6 31.9,31.7 54.4,31.7l854.9,0c21.9,0 42.2,-11.5 53.5,-30.2s12,-42 1.9,-61.4zm-910.4,29.2l428.9,-761.1l426,761.1l-854.9,0z"/><path d="m490.3158,626.7c-36.5,0 -62.1,25.6 -62.1,62.8c0,35.8 24.9,62.8 60.7,62.8l1.4,0c37.3,0 61.5,-27 61.5,-62.8c-0.7,-37.3 -24.9,-62.8 -61.5,-62.8z"/><path d="m451.0158,592.1l78.7,0l15.2,-312.6l-109,0l15.1,312.6z"/></g></svg></td>
<td>
Note that this feature is considered as *experimental*. It should work with simple configuration but may not in complex ones. If you have any issue with that feature, you are welcomed to come discussed your use case on the link:http://ant.apache.org/ivy/mailing-lists.html[ivy-user] mailing list, or discuss about implementation issues or improvement you may have found on link:http://ant.apache.org/ivy/mailing-lists.html[ant-dev].
It should work with simple configuration but may not in complex ones. If you have any issue with that feature, you are welcomed to come discussed your use case on the link:http://ant.apache.org/ivy/mailing-lists.html[ivy-user] mailing list, or discuss about implementation issues or improvement you may have found on link:http://ant.apache.org/ivy/mailing-lists.html[ant-dev].
====
@ -23,7 +19,7 @@ In few steps, we will setup a build to compile and package an Eclipse plugin.
. download this <a href="../samples/eclipse-plugin/ivy.xml">ivy.xml<a>, this <a href="../samples/eclipse-plugin/ivysettings.xml">ivysettings.xml</a>, this <a href="../samples/eclipse-plugin/ivysettings.properties">ivysettings.properties</a>, this <a href="../samples/eclipse-plugin/build.xml">build.xml</a>, and put them into your plugin folder; +
. download this link:../samples/eclipse-plugin/ivy.xml[ivy.xml], this link:../samples/eclipse-plugin/ivysettings.xml[ivysettings.xml], this link:../samples/eclipse-plugin/ivysettings.properties[ivysettings.properties], this link:../samples/eclipse-plugin/build.xml[build.xml], and put them into your plugin folder; +
. in the ivysettings.properties, specify the location of the plugins folder of your Eclipse target; +

18
asciidoc/osgi/standard-osgi.adoc
View File

@ -3,13 +3,9 @@
[NOTE]
====
Note that this feature is considered as *experimental*.
<table class="notice">
<tr>
<td style="vertical-align: top"><svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="1em" version="1.1" y="0px" x="0px" viewBox="0 0 980.02045 886.1"><g fill="red"><path d="m972.9158,794.5l-426.1,-761.1c-10.5,-20 -31.1,-32.7 -53.7,-33.4l-1.7,0c-22,0 -42.4,11.5 -53.7,30.5l-428.9,761c-11.5,19.4 -11.8,43.3 -0.6,62.9c11.1,19.6 31.9,31.7 54.4,31.7l854.9,0c21.9,0 42.2,-11.5 53.5,-30.2s12,-42 1.9,-61.4zm-910.4,29.2l428.9,-761.1l426,761.1l-854.9,0z"/><path d="m490.3158,626.7c-36.5,0 -62.1,25.6 -62.1,62.8c0,35.8 24.9,62.8 60.7,62.8l1.4,0c37.3,0 61.5,-27 61.5,-62.8c-0.7,-37.3 -24.9,-62.8 -61.5,-62.8z"/><path d="m451.0158,592.1l78.7,0l15.2,-312.6l-109,0l15.1,312.6z"/></g></svg></td>
<td>
Note that this feature is considered as *experimental*. It should work with simple configuration but may not in complex ones. If you have any issue with that feature, you are welcomed to come discussed your use case on the link:http://ant.apache.org/ivy/mailing-lists.html[ivy-user] mailing list, or discuss about implementation issues or improvement you may have found on link:http://ant.apache.org/ivy/mailing-lists.html[ant-dev].
It should work with simple configuration but may not in complex ones. If you have any issue with that feature, you are welcomed to come discussed your use case on the link:http://ant.apache.org/ivy/mailing-lists.html[ivy-user] mailing list, or discuss about implementation issues or improvement you may have found on link:http://ant.apache.org/ivy/mailing-lists.html[ant-dev].
====
@ -29,18 +25,12 @@ In oder to produce OSGi metadata of suffient quality and to avoid maintaining th
== Quick setup
In few steps, we will setup a build to compile and publish an OSGi bundle.
. download this <a href="../samples/standard-osgi/ivy.xml">ivy.xml<a>, this <a href="../samples/standard-osgi/ivysettings.xml">ivysettings.xml</a>, this <a href="../samples/standard-osgi/build.xml">build.xml</a>, this <a href="../samples/standard-osgi/org.apache.ivy.sample.standard-osgi.bnd">bnd file</a>, and put them into your project folder; +
. download this link:../samples/standard-osgi/ivy.xml[ivy.xml], this link:../samples/standard-osgi/ivysettings.xml[ivysettings.xml], this link:../samples/standard-osgi/build.xml[build.xml], this link:../samples/standard-osgi/org.apache.ivy.sample.standard-osgi.bnd[bnd file], and put them into your project folder; +
. in the ivysettings.properties, specify the location of the plugins folder of your Eclipse target; +
. __(optional)__ by default the build.xml is expecting the sources to be in the `src` folder. You may want to edit it if it is not the case +
. __(optional)__ if Ivy is not in Ant's classpath, get the jar of <a href="../download.html">Apache Ivy</a> and edit the build.xml accordingly (see the comments at the begining of the file) +
. __(optional)__ if Ivy is not in Ant's classpath, get the jar of link:../download.html[Apache Ivy] and edit the build.xml accordingly (see the comments at the begining of the file) +

8
asciidoc/osgi/target-platform.adoc
View File

@ -3,13 +3,9 @@
[NOTE]
====
Note that this feature is considered as *experimental*.
<table class="notice">
<tr>
<td style="vertical-align: top"><svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="1em" version="1.1" y="0px" x="0px" viewBox="0 0 980.02045 886.1"><g fill="red"><path d="m972.9158,794.5l-426.1,-761.1c-10.5,-20 -31.1,-32.7 -53.7,-33.4l-1.7,0c-22,0 -42.4,11.5 -53.7,30.5l-428.9,761c-11.5,19.4 -11.8,43.3 -0.6,62.9c11.1,19.6 31.9,31.7 54.4,31.7l854.9,0c21.9,0 42.2,-11.5 53.5,-30.2s12,-42 1.9,-61.4zm-910.4,29.2l428.9,-761.1l426,761.1l-854.9,0z"/><path d="m490.3158,626.7c-36.5,0 -62.1,25.6 -62.1,62.8c0,35.8 24.9,62.8 60.7,62.8l1.4,0c37.3,0 61.5,-27 61.5,-62.8c-0.7,-37.3 -24.9,-62.8 -61.5,-62.8z"/><path d="m451.0158,592.1l78.7,0l15.2,-312.6l-109,0l15.1,312.6z"/></g></svg></td>
<td>
Note that this feature is considered as *experimental*. It should work with simple configuration but may not in complex ones. If you have any issue with that feature, you are welcomed to come discussed your use case on the link:http://ant.apache.org/ivy/mailing-lists.html[ivy-user] mailing list, or discuss about implementation issues or improvement you may have found on link:http://ant.apache.org/ivy/mailing-lists.html[ant-dev].
It should work with simple configuration but may not in complex ones. If you have any issue with that feature, you are welcomed to come discussed your use case on the link:http://ant.apache.org/ivy/mailing-lists.html[ivy-user] mailing list, or discuss about implementation issues or improvement you may have found on link:http://ant.apache.org/ivy/mailing-lists.html[ant-dev].
====

4
asciidoc/resolver/mirrored.adoc
View File

@ -10,9 +10,7 @@
*__since 2.3__*
<span class="tagdoc" id="ivysettings.resolvers.mirroredurl">This resolver can resolve dependencies against several mirrors of the same repository. From a list of mirror urls, it will iteratively try to resolve the dependencies against each one.
This resolver can resolve dependencies against several mirrors of the same repository. From a list of mirror urls, it will iteratively try to resolve the dependencies against each one.
== Attributes

2
asciidoc/resolver/obr.adoc
View File

@ -10,7 +10,7 @@
*__since 2.3__*
<span class="tagdoc" id="ivysettings.resolvers.obr">This resolver is one of the resolver which supports link:../osgi.html[OSGi&#153;] dependencies. As part of the OSGi specification resides the OBR (OSGi Bundle Repository). The OBR defines the aggregation of the OSGi metadata of every bundle included in an repository. So contrary to the other resolvers, this resolver needs to get the descriptor of the repository (an obr.xml) before starting to resolve modules.
This resolver is one of the resolver which supports link:../osgi.html[OSGi&#153;] dependencies. As part of the OSGi specification resides the OBR (OSGi Bundle Repository). The OBR defines the aggregation of the OSGi metadata of every bundle included in an repository. So contrary to the other resolvers, this resolver needs to get the descriptor of the repository (an obr.xml) before starting to resolve modules.
== Attributes

2
asciidoc/resolver/osgiagg.adoc
View File

@ -10,7 +10,7 @@
*__since 2.4__*
<span class="tagdoc" id="ivysettings.resolvers.osgi-agg">This resolver is one of the resolver which supports link:../osgi.html[OSGi&#153;] dependencies.
This resolver is one of the resolver which supports link:../osgi.html[OSGi&#153;] dependencies.
This resolvers is like a classic link:[chain] resolver, but which better support OSGi metadata.

12
asciidoc/resolver/packager.adoc
View File

@ -37,7 +37,7 @@ Packager repositories allow the creation of Ivy repositories that require neithe
The Packager resolver supports a "resource cache", where downloaded archives can be stored to avoid duplicate downloads. This cache is entirely separate from the link:../concept.html#cache[normal Ivy cache]: it is "private" to the Packager resolver, and it stores unmodified original software archives, not Ivy artifacts. See the <span class="ivy-att">resourceCache</span> attribute below for details.
The Packager resolver supports a "resource cache", where downloaded archives can be stored to avoid duplicate downloads. This cache is entirely separate from the link:../concept.html#cache[normal Ivy cache]: it is "private" to the Packager resolver, and it stores unmodified original software archives, not Ivy artifacts. See the `resourceCache` attribute below for details.
@ -85,7 +85,7 @@ This resolver shares the link:../settings/resolvers.html#common[common attribute
|buildRoot|Defines the root of the temporary build directory hierarchy|Yes
|resourceCache|Directory where downloaded resources should be cached|No; defaults to none
|resourceURL|Ivy pattern that specifies a base URL to use for downloading __all__ resources; overrides the URLs in the packaging instructions|No; defaults to none
|restricted|True if this resolver should only allow "safe" ant tasks in the packaging instructions. *Warning:* setting <span class="ivy-att">restricted</span> to false creates a security problem due to ant tasks like delete, exec, etc. Do not use this setting when your configuration points to an untrusted repository.|No; defaults to true
|restricted|True if this resolver should only allow "safe" ant tasks in the packaging instructions. *Warning:* setting `restricted` to false creates a security problem due to ant tasks like delete, exec, etc. Do not use this setting when your configuration points to an untrusted repository.|No; defaults to true
|verbose|True to run ant with the -verbose flag|No; defaults to false
|quiet|True to run ant with the -quiet flag|No; defaults to false
|validate|True if this resolver should validate (via XSD) the downloaded XML packaging instructions|No; defaults to true
@ -242,8 +242,8 @@ This resolver ensures following ant properties are defined when it executes the
|ivy.packager.module|Module of the ivy module whose artifacts are being built
|ivy.packager.revision|Revision of the ivy module whose artifacts are being built
|ivy.packager.branch|Branch of the ivy module whose artifacts are being built
|ivy.packager.resourceCache|The configured <span class="ivy-att">resourceCache</span> if any; otherwise not defined
|ivy.packager.resourceURL|The resolved <span class="ivy-att">resourceURL</span> pattern if any; otherwise not defined
|ivy.packager.resourceCache|The configured `resourceCache` if any; otherwise not defined
|ivy.packager.resourceURL|The resolved `resourceURL` pattern if any; otherwise not defined
|=======
@ -263,12 +263,12 @@ The packager.xml document element can contain the following child tags.
Which ant tasks are allowed within the build tag is controlled by the <span class="ivy-att">restricted</span> configuration attribute. When true (the default), only the following ant tasks are allowed: copy, jar, mkdir, move, tar, unjar, untar, unwar, unzip, war, and zip. When false, all ant tasks are allowed.
Which ant tasks are allowed within the build tag is controlled by the `restricted` configuration attribute. When true (the default), only the following ant tasks are allowed: copy, jar, mkdir, move, tar, unjar, untar, unwar, unzip, war, and zip. When false, all ant tasks are allowed.
*Warning:* setting <span class="ivy-att">restricted</span> to false creates a security problem due to ant tasks like delete, exec, etc. Do not use this setting when your configuration points to an untrusted repository.
*Warning:* setting `restricted` to false creates a security problem due to ant tasks like delete, exec, etc. Do not use this setting when your configuration points to an untrusted repository.

2
asciidoc/resolver/updatesite.adoc
View File

@ -10,7 +10,7 @@
*__since 2.3__*
<span class="tagdoc" id="ivysettings.resolvers.updatesite">This resolver is one of the resolver which supports link:../osgi.html[OSGi&#153;] dependencies.
This resolver is one of the resolver which supports link:../osgi.html[OSGi&#153;] dependencies.
It resolves modules (OSGi bundles) which are hosted in an Eclipse&#153; update site.
This resolver supports old style Eclipse updatesite, based on simply a site.xml. It also supports Eclipse P2 repositories.

2
asciidoc/settings/caches.adoc
View File

@ -28,7 +28,7 @@ cache to another place in your filesystem). Usually it is a good thing to check
|repositoryCacheDir|the path of the default directory to use for repository cache data. *This should not point to a directory used as a repository!*|No, defaults to defaultCacheDir
|ivyPattern|default pattern used to indicate where ivy files should be put in the repository cache(s)|No, defaults to [organisation]/[module]/ivy-[revision].xml
|artifactPattern|default pattern used to indicate where artifact files should be put in the repository cache(s)|No, defaults to [organisation]/[module]/[type]s/[artifact]-[revision].[ext]
|<s>checkUpToDate</s>|Indicates if date should be checked before retrieving artifacts from cache.
|[line-through]#checkUpToDate#|Indicates if date should be checked before retrieving artifacts from cache.
__Deprecated, we recommend using overwriteMode on the link:../use/retrieve.html[retrieve] task instead__|No, defaults to true
|useOrigin|the default value to use for useOrigin for caches in which it isn't specifically defined.
Use true to avoid the copy of local artifacts to the cache and use directly their original location.|No, defaults to false

6
asciidoc/settings/namespaces.adoc
View File

@ -6,11 +6,11 @@ Namespaces are an advanced feature of Ivy which let you use resolvers in which m
For instance, if you want to use both a maven2 repository and an ivyrep, you will face some naming issues. For example, all apache commons projects are declared to be part of the organisation __apache__ in ivyrep whereas in maven2 ibiblio repository, their organisation is same as the module.
So if you try to use both maven2 and ivyrep repositories, you will face some issues like:
<quote>
[quote]
_______
How do I declare a dependency on commons-lang?
I have an error while trying to resolve module xxx. It says that it depends on [commons-httpclient commons-httpclient] and that it isn't available.
...
</quote>
_______
Ivy's answer to this issue is called namespaces. In short, you can attach a namespace to each dependency resolver in Ivy, and each namespace defines rules to convert names from the system namespace to the defined namespace itself, and vice versa.

4
asciidoc/settings/resolvers.adoc
View File

@ -90,8 +90,8 @@ By using such a resolver at the beginning of a chain, you can be sure that Ivy w
Any resolver which is able to parse a Maven pom.xml file has to detect the related sources or javadocs artifacts. This often involves sevrals network connection even if neither the sources nor the javadoc are requested to be downloaded.
*__since 2.5__* Setting the property `ivy.maven.lookup.sources<tt> to <tt>false` disable the lookup of the sources artifact.
And setting the property `ivy.maven.lookup.javadoc<tt> to <tt>false` disable the lookup of the javadoc artifact.
*__since 2.5__* Setting the property `ivy.maven.lookup.sources` to `false` disable the lookup of the sources artifact.
And setting the property `ivy.maven.lookup.javadoc` to `false` disable the lookup of the javadoc artifact.
=== Attributes

8
asciidoc/settings/settings.adoc
View File

@ -28,13 +28,13 @@ So if there is a setting in the resolver, it always wins against all other setti
|validate|Indicates if ivy files should be validated against ivy.xsd or not.|No, defaults to true
|useRemoteConfig|true to configure ivyrep and ibiblio resolver from a remote configuration file (updated with changes in those repository structure if any) (*__since 1.2__*)|No, defaults to false
|httpRequestMethod|specifies the HTTP method to use to retrieve information about an URL. Possible values are 'GET' and 'HEAD'. This setting can be used to solve problems with firewalls and proxies. (*__since 2.0__*)|No, defaults to 'HEAD'
|<s>defaultCache</s>|a path to a directory to use as default basedir for both resolution and repository cache(s).
|[line-through]#defaultCache#|a path to a directory to use as default basedir for both resolution and repository cache(s).
__Deprecated, we recommend using defaultCacheDir on the link:../settings/caches.html[caches] tag instead__|No, defaults to .ivy2/cache in user home
|<s>checkUpToDate</s>|Indicates if date should be checked before retrieving artifacts from cache.
|[line-through]#checkUpToDate#|Indicates if date should be checked before retrieving artifacts from cache.
__Deprecated, we recommend using overwriteMode on the link:../use/retrieve.html[retrieve] task instead__|No, defaults to true
|<s>cacheIvyPattern</s>|a pattern to indicate where ivy files should be put in cache.
|[line-through]#cacheIvyPattern#|a pattern to indicate where ivy files should be put in cache.
__Deprecated, we recommend using ivyPattern on the link:../settings/caches.html[caches] tag instead__|No, defaults to [organisation]/[module]/ivy-[revision].xml
|<s>cacheArtifactPattern</s>|a pattern to indicate where artifact files should be put in cache.
|[line-through]#cacheArtifactPattern#|a pattern to indicate where artifact files should be put in cache.
__Deprecated, we recommend using artifactPattern on the link:../settings/caches.html[caches] tag instead__|No, defaults to [organisation]/[module]/[type]s/[artifact]-[revision].[ext]
|=======

4
asciidoc/tutorial/build-repository/advanced.adoc
View File

@ -39,7 +39,7 @@ include::asciidoc/tutorial/log/myrepository-content-namespace.txt[]
We can even have a look at the commons-lang ivy file in our repository:
<div>
[source]
----
@ -57,7 +57,7 @@ We can even have a look at the commons-lang ivy file in our repository:
----
</div>
Alright, we see that the organisation is now 'apache'. But where did Ivy pick this up?
=== How does this work ?

3
asciidoc/use/makepom.adoc
View File

@ -13,7 +13,8 @@ It is possible to specify a template file defining the structure of the generate
* properties like __${property.name}__ are replaced if they are defined in Ant or by the ivy:makepom task (see below for the standard properties) +
* lines containg the string __SKIP_LINE__ are skipped. +
<li>the defined dependencies will be added to the first <dependencies> element encountered in the pom template. If the template doesn't contain a <dependencies> element, it is generated a the end of the pom.
* the defined dependencies will be added to the first <dependencies> element encountered in the pom template. If the template doesn't contain a <dependencies> element, it is generated a the end of the pom.
The ivy:makepom task defines following properties that can be used in the template.