You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2018/09/23 17:52:53 UTC
[maven-remote-resources-plugin] branch master updated: documentation
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-remote-resources-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new bc3f45e documentation
bc3f45e is described below
commit bc3f45ef507dde17ce250d5505d866128728fd1f
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sun Sep 23 19:52:52 2018 +0200
documentation
---
.../maven/plugin/resources/remote/BundleRemoteResourcesMojo.java | 3 ++-
.../maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java | 6 +++---
src/site/apt/index.apt.vm | 8 +++++---
src/site/apt/usage.apt.vm | 2 +-
4 files changed, 11 insertions(+), 8 deletions(-)
diff --git a/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java b/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java
index 0afe25d..91a7d06 100644
--- a/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java
+++ b/src/main/java/org/apache/maven/plugin/resources/remote/BundleRemoteResourcesMojo.java
@@ -39,7 +39,8 @@ import java.util.Arrays;
import java.util.List;
/**
- * Bundle up resources that should be considered as a remote-resource.
+ * Bundle up resources that should be considered as a remote-resource,
+ * generating <code>META-INF/maven/remote-resources.xml</code> descriptor.
*/
@Mojo( name = "bundle", defaultPhase = LifecyclePhase.GENERATE_RESOURCES, threadSafe = true )
public class BundleRemoteResourcesMojo
diff --git a/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java b/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
index 0f7c271..db7868e 100644
--- a/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
+++ b/src/main/java/org/apache/maven/plugin/resources/remote/ProcessRemoteResourcesMojo.java
@@ -110,13 +110,13 @@ import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* <p>
- * Pull down resourceBundles containing remote resources and process the resources contained inside. When that is done
+ * Pull down resourceBundles containing remote resources and process the resources contained inside. When that is done,
* the resources are injected into the current (in-memory) Maven project, making them available to the process-resources
* phase.
* </p>
* <p>
- * Resources that end in ".vm" are treated as velocity templates. For those, the ".vm" is stripped off for the final
- * artifact name and it's fed through velocity to have properties expanded, conditions processed, etc...
+ * Resources that end in ".vm" are treated as Velocity templates. For those, the ".vm" is stripped off for the final
+ * artifact name and it's fed through Velocity to have properties expanded, conditions processed, etc...
* </p>
* <p/>
* Resources that don't end in ".vm" are copied "as is".
diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm
index d40c19a..ac93784 100644
--- a/src/site/apt/index.apt.vm
+++ b/src/site/apt/index.apt.vm
@@ -27,10 +27,12 @@ ${project.name}
This plugin is used to retrieve JARs of resources from remote repositories,
process those resources, and incorporate them into JARs you build with
- Maven. A very common use-case is the need to package certain resources in a
- consistent way across your organization: at Apache it is required that every
+ Maven.
+
+ A very common use-case is the need to package certain resources in a
+ consistent way across your organization. For example at Apache, it is required that every
JAR produced contains a copy of the Apache license and a notice file that
- references all used software in a given project.
+ references all used software in a given project: see {{{/apache-resource-bundles/}Apache Resource Bundles}}.
* Goals Overview
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index fcc721b..075b844 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -58,7 +58,7 @@ Usage
-------------------
This will trigger the scanning of that project's <<<$\{basedir}/src/main/resources>>> directory and create the
- <<<$\{basedir}/target/classes/META-INF/maven/remote-resources.xml>>> manifest file.
+ <<<$\{basedir}/target/classes/META-INF/maven/remote-resources.xml>>> {{{./remote-resources.html}manifest file}}.
<<Note:>> The files have to be named like <<<*.vm>>> to mark them as {{{htps://velocity.apache.org}Velocity}} macro files which will
be filtered by the <<process>> goal. If you don't name the files according to this,