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:41 UTC
[2/3] ant-ivy git commit: review the ivy file part of the doc about
the use of code formatting
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`.
|=======
-
-