You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2020/04/12 14:24:43 UTC
[maven-antrun-plugin] 01/01: Improve code snippets formatting,
links update to reports
This is an automated email from the ASF dual-hosted git repository.
slachiewicz pushed a commit to branch docfixes
in repository https://gitbox.apache.org/repos/asf/maven-antrun-plugin.git
commit 7ecfe75f78a91253e57d089ec793fb17d9401b89
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Sun Apr 12 15:05:23 2020 +0200
Improve code snippets formatting, links update to reports
---
src/site/apt/examples/classpaths.apt.vm | 25 ++++++++++++-------------
src/site/apt/examples/customTasks.apt.vm | 15 +++++++--------
src/site/apt/examples/tasksAttributes.apt.vm | 6 +++---
src/site/apt/index.apt.vm | 4 ++--
src/site/apt/tasks/attachArtifact.apt.vm | 10 ++++------
src/site/apt/tasks/dependencyFilesets.apt.vm | 14 +++++++-------
src/site/apt/tasks/tasks.apt.vm | 2 +-
src/site/apt/tasks/versionMapper.apt.vm | 10 +++++-----
src/site/apt/usage.apt.vm | 16 ++++++++--------
src/site/site.xml | 4 ++--
src/site/xdoc/download.xml.vm | 9 ++++-----
11 files changed, 55 insertions(+), 60 deletions(-)
diff --git a/src/site/apt/examples/classpaths.apt.vm b/src/site/apt/examples/classpaths.apt.vm
index 16f3e24..0d1c6e5 100644
--- a/src/site/apt/examples/classpaths.apt.vm
+++ b/src/site/apt/examples/classpaths.apt.vm
@@ -24,7 +24,7 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+ ~~ https://maven.apache.org/doxia/references/apt-format.html
Referencing the Maven Classpaths
@@ -32,18 +32,18 @@ Referencing the Maven Classpaths
<<groupId:artifactId:type[:classifier]>>. For example, to show the path to a
jar dependency with groupId "org.apache" and artifactId "common-util", the following could be used.
-------
++---+
#set( $D = '$' )
<echo message="${D}{org.apache:common-util:jar}"/>
-------
-
++---+
+
If the dependency includes a classifier, the classifier is appended to the property name.
For example, groupId "org.apache", artifactId "common-util", type "jar", and classifier "jdk14".
-------
++---+
#set( $D = '$' )
<echo message="${D}{org.apache:common-util:jar:jdk14}"/>
-------
++---+
<<Note:>> the old format "maven.dependency.groupId.artifactId[.classifier].type.path" is not supported as of version
3.0.0 of the plugin.
@@ -61,7 +61,7 @@ Referencing the Maven Classpaths
For example, to display Maven's classpaths using antrun, we can do this
-------
++---+
<project>
<modelVersion>4.0.0</modelVersion>
<artifactId>my-test-app</artifactId>
@@ -102,11 +102,11 @@ Referencing the Maven Classpaths
</build>
</project>
-------
++---+
or alternatively, we can use an external <<<build.xml>>>.
-------
++---+
<project>
<modelVersion>4.0.0</modelVersion>
<artifactId>my-test-app</artifactId>
@@ -145,11 +145,11 @@ Referencing the Maven Classpaths
</plugins>
</build>
</project>
-------
++---+
The <<<build.xml>>>:
-------
++---+
<?xml version="1.0"?>
<project name="test6">
@@ -163,5 +163,4 @@ Referencing the Maven Classpaths
</target>
</project>
-------
-
++---+
\ No newline at end of file
diff --git a/src/site/apt/examples/customTasks.apt.vm b/src/site/apt/examples/customTasks.apt.vm
index 62048b4..ca07ff9 100644
--- a/src/site/apt/examples/customTasks.apt.vm
+++ b/src/site/apt/examples/customTasks.apt.vm
@@ -24,14 +24,14 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+ ~~ https://maven.apache.org/doxia/references/apt-format.html
Using tasks not included in Ant's default jar
To use Ant tasks not included in the Ant jar, like Ant optional or custom tasks you need to add the dependencies needed for the task
to run to the plugin classpath and use the <<<maven.plugin.classpath>>> reference if needed.
-------
++---+
<project>
<modelVersion>4.0.0</modelVersion>
<artifactId>my-test-app</artifactId>
@@ -71,24 +71,23 @@ Using tasks not included in Ant's default jar
<dependency>
<groupId>commons-net</groupId>
<artifactId>commons-net</artifactId>
- <version>1.4.1</version>
+ <version>2.2</version>
</dependency>
<dependency>
<groupId>org.apache.ant</groupId>
<artifactId>ant-commons-net</artifactId>
- <version>1.8.1</version>
+ <version>1.9.14</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
-
-------
++---+
Another example of this is the use of {{{http://ant-contrib.sourceforge.net/}Ant-Contrib}} tasks:
-------
++---+
<project>
[...]
<build>
@@ -130,4 +129,4 @@ Using tasks not included in Ant's default jar
</plugins>
</build>
</project>
-------
\ No newline at end of file
++---+
\ No newline at end of file
diff --git a/src/site/apt/examples/tasksAttributes.apt.vm b/src/site/apt/examples/tasksAttributes.apt.vm
index 989c4c3..12241ab 100644
--- a/src/site/apt/examples/tasksAttributes.apt.vm
+++ b/src/site/apt/examples/tasksAttributes.apt.vm
@@ -24,14 +24,14 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+ ~~ https://maven.apache.org/doxia/references/apt-format.html
Using <<<\<target/\>>>> Attributes
You can specify attributes in the <<<\<target/\>>>> configuration to execute or not Ant tasks
depending some conditions. For example, to skip Ant call, you could add the following:
-------
++---+
<project>
...
<build>
@@ -62,4 +62,4 @@ Using <<<\<target/\>>>> Attributes
</build>
...
</project>
-------
++---+
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index 4468cd3..1e2a85a 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -52,8 +52,8 @@ ${project.name}
* <<<tasks>>>: use <<<target>>> instead;
* <<<sourceRoot>>> and <<<testSourceRoot>>>: you can use the
- {{{https://www.mojohaus.org/build-helper-maven-plugin/}build-helper-maven-plugin}} instead, with its
- {{{https://www.mojohaus.org/build-helper-maven-plugin/add-source-mojo.html}add-source}} and
+ {{{https://www.mojohaus.org/build-helper-maven-plugin/}build-helper-maven-plugin}} instead, with its
+ {{{https://www.mojohaus.org/build-helper-maven-plugin/add-source-mojo.html}add-source}} and
{{{https://www.mojohaus.org/build-helper-maven-plugin/add-test-source-mojo.html}add-test-source}} goals.
The format <<<maven.dependency.groupId.artifactId[.classifier].type.path>>> to reference the path of a project
diff --git a/src/site/apt/tasks/attachArtifact.apt.vm b/src/site/apt/tasks/attachArtifact.apt.vm
index b7ac8a5..29a08da 100644
--- a/src/site/apt/tasks/attachArtifact.apt.vm
+++ b/src/site/apt/tasks/attachArtifact.apt.vm
@@ -24,7 +24,7 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+ ~~ https://maven.apache.org/doxia/references/apt-format.html
AttachArtifact Task
@@ -47,8 +47,8 @@ AttachArtifact Task
* Example
This example shows how to use the <<<attachartifact>>> task.
-
-------
+
++---+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
@@ -72,6 +72,4 @@ AttachArtifact Task
</execution>
</executions>
</plugin>
-
-------
-
++---+
\ No newline at end of file
diff --git a/src/site/apt/tasks/dependencyFilesets.apt.vm b/src/site/apt/tasks/dependencyFilesets.apt.vm
index 9904562..14cec67 100644
--- a/src/site/apt/tasks/dependencyFilesets.apt.vm
+++ b/src/site/apt/tasks/dependencyFilesets.apt.vm
@@ -24,7 +24,7 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+ ~~ https://maven.apache.org/doxia/references/apt-format.html
DependencyFilesets Task
@@ -54,8 +54,8 @@ DependencyFilesets Task
* Example
This example shows how to access individual dependencies and the combined dependency fileset.
-
-------
+
++---+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
@@ -69,23 +69,23 @@ DependencyFilesets Task
</goals>
<configuration>
<target>
-
+
<dependencyfilesets prefix="mydeps."/>
<mkdir dir="target/dependencies"/>
<copy todir="target/dependencies">
<fileset refid="mydeps.junit:junit:jar"/>
<fileset refid="mydeps.org.apache.ant:ant:jar"/>
</copy>
-
+
<mkdir dir="target/dependencies2"/>
<copy todir="target/dependencies2" flatten="true">
<fileset refid="mydeps.maven.project.dependencies"/>
</copy>
-
+
</target>
</configuration>
</execution>
</executions>
</plugin>
-------
++---+
diff --git a/src/site/apt/tasks/tasks.apt.vm b/src/site/apt/tasks/tasks.apt.vm
index de042c3..8f8bf6c 100644
--- a/src/site/apt/tasks/tasks.apt.vm
+++ b/src/site/apt/tasks/tasks.apt.vm
@@ -24,7 +24,7 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+ ~~ https://maven.apache.org/doxia/references/apt-format.html
Ant Tasks
diff --git a/src/site/apt/tasks/versionMapper.apt.vm b/src/site/apt/tasks/versionMapper.apt.vm
index 835d16c..da573cc 100644
--- a/src/site/apt/tasks/versionMapper.apt.vm
+++ b/src/site/apt/tasks/versionMapper.apt.vm
@@ -24,7 +24,7 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+ ~~ https://maven.apache.org/doxia/references/apt-format.html
VersionMapper
@@ -34,8 +34,8 @@ VersionMapper
* Example
This example shows how to use the version mapper.
-
-------
+
++---+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
@@ -51,7 +51,7 @@ VersionMapper
<target>
<mapper id="remove-versions"
classname="org.apache.maven.ant.tasks.support.VersionMapper"
- from="${maven.project.dependencies.versions}"
+ from="${maven.project.dependencies.versions}"
to="flatten" />
<copy todir="lib" flatten="true">
<path>
@@ -65,5 +65,5 @@ VersionMapper
</executions>
</plugin>
-------
++---+
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index ecf91f4..e1d7ea0 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -24,7 +24,7 @@
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
- ~~ http://maven.apache.org/doxia/references/apt-format.html
+ ~~ https://maven.apache.org/doxia/references/apt-format.html
Usage
@@ -38,7 +38,7 @@ Usage
it would not do anything). Below is the template for
<<<maven-antrun-plugin>>>'s <<<pom.xml>>>.
-------
++---+
<project>
[...]
<build>
@@ -70,7 +70,7 @@ Usage
</build>
[...]
</project>
-------
++---+
Moreover, you can add a script to each lifecycle phase, by duplicating the
<<<\<execution/\>>>> section and specifying a new phase.
@@ -78,7 +78,7 @@ Usage
Ultimately, you could specify some Ant {{{http://ant.apache.org/manual/using.html#targets}<<<\<target/\>>>>}}
attributes in the <<<\<target/\>>>> tag. Only <<<depends>>> attribute in Ant <<<\<target/\>>>> is not wrapped.
-------
++---+
[...]
<configuration>
<target name="The name of the target"
@@ -95,7 +95,7 @@ Usage
</target>
<configuration>
[...]
-------
++----+
* Additional source directories
@@ -123,10 +123,10 @@ Usage
If the Maven property you want to use is not available in an external file, you
will have to redefine the property before calling <ant>.
-------
++---+
<property name="maven.project.url" value="\${project.url}"/>
<ant antfile="build.xml"/>
-------
++---+
* Ant Expressions to Maven Expressions Mapping
@@ -151,7 +151,7 @@ Usage
*-----------------------------------+-----------------------------------+
| <<<Chmod>>> | {{{../maven-assembly-plugin/}<<<maven-assembly-plugin>>>}} |
*-----------------------------------+-----------------------------------+
-| <<<Condition>>> | {{{http://maven.apache.org/guides/introduction/introduction-to-profiles.html}<<<profiles>>>}} |
+| <<<Condition>>> | {{{/guides/introduction/introduction-to-profiles.html}<<<profiles>>>}} |
*-----------------------------------+-----------------------------------+
| <<<Copy>>> | {{{../maven-resources-plugin/}<<<maven-resources-plugin>>>}} |
*-----------------------------------+-----------------------------------+
diff --git a/src/site/site.xml b/src/site/site.xml
index 0ee053a..e76b9d5 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -24,7 +24,7 @@ under the License.
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 http://maven.apache.org/xsd/decoration-1.0.0.xsd">
<body>
<links>
- <item name="Ant" href="http://ant.apache.org/"/>
+ <item name="Ant" href="https://ant.apache.org/"/>
</links>
<menu name="Overview">
@@ -34,7 +34,7 @@ under the License.
<item name="Usage" href="usage.html"/>
<item name="FAQ" href="faq.html"/>
<!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
- <item name="License" href="http://www.apache.org/licenses/"/>
+ <item name="License" href="https://www.apache.org/licenses/"/>
<item name="Download" href="download.html"/>
</menu>
<menu name="Examples">
diff --git a/src/site/xdoc/download.xml.vm b/src/site/xdoc/download.xml.vm
index 3f71035..33e6354 100644
--- a/src/site/xdoc/download.xml.vm
+++ b/src/site/xdoc/download.xml.vm
@@ -33,11 +33,11 @@ under the License.
hours to reach all mirrors.<p/>
<p>In order to guard against corrupted downloads/installations, it is highly recommended to
- <a href="http://www.apache.org/dev/release-signing#verifying-signature">verify the signature</a>
+ <a href="https://www.apache.org/dev/release-signing#verifying-signature">verify the signature</a>
of the release bundles against the public <a href="https://www.apache.org/dist/maven/KEYS">KEYS</a> used by the Apache Maven
developers.</p>
- <p>${project.name} is distributed under the <a href="http://www.apache.org/licenses/">Apache License, version 2.0</a>.</p>
+ <p>${project.name} is distributed under the <a href="https://www.apache.org/licenses/">Apache License, version 2.0</a>.</p>
<p></p>We <b>strongly</b> encourage our users to configure a Maven repository mirror closer to their location, please read <a href="/guides/mini/guide-mirror-settings.html">How to Use Mirrors for Repositories</a>.</p>
@@ -85,8 +85,7 @@ under the License.
<p>
You may also consult the
- <a href="http://www.apache.org/mirrors/">complete list of
- mirrors.</a>
+ <a href="https://www.apache.org/mirrors/">complete list of mirrors.</a>
</p>
</subsection>
@@ -117,7 +116,7 @@ under the License.
<subsection name="Previous Versions">
- <p>Older non-recommended releases can be found on our <a href="http://archive.apache.org/dist/maven/plugins/">archive site</a>.</p>
+ <p>Older non-recommended releases can be found on our <a href="https://archive.apache.org/dist/maven/plugins/">archive site</a>.</p>
</subsection>
</section>