You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by gn...@apache.org on 2022/01/03 07:31:39 UTC

[maven-mvnd] branch master updated: Improve the doc text of mvnd.pluginRealmEvictPattern option, fixes #533 (#534)

This is an automated email from the ASF dual-hosted git repository.

gnodet pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-mvnd.git


The following commit(s) were added to refs/heads/master by this push:
     new 09cb99f  Improve the doc text of mvnd.pluginRealmEvictPattern option, fixes #533 (#534)
09cb99f is described below

commit 09cb99fd48d7b8b0de09ffb8656b77a1648b4e95
Author: Guillaume Nodet <gn...@gmail.com>
AuthorDate: Mon Jan 3 08:31:32 2022 +0100

    Improve the doc text of mvnd.pluginRealmEvictPattern option, fixes #533 (#534)
---
 build-plugin/pom.xml                                          |  2 +-
 .../src/main/java/org/mvndaemon/mvnd/plugin/doc/DocMojo.java  |  3 ++-
 .../src/main/java/org/mvndaemon/mvnd/common/Environment.java  | 11 ++++++++++-
 3 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/build-plugin/pom.xml b/build-plugin/pom.xml
index 0ef65b3..2c661cb 100644
--- a/build-plugin/pom.xml
+++ b/build-plugin/pom.xml
@@ -34,7 +34,7 @@
         <maven.compiler.target>1.8</maven.compiler.target>
         <maven.compiler.source>1.8</maven.compiler.source>
 
-        <roaster.version>2.22.2.Final</roaster.version>
+        <roaster.version>2.23.2.Final</roaster.version>
         <maven.plugin-tools.version>3.6.0</maven.plugin-tools.version>
         <maven-plugin-plugin.version>${maven.plugin-tools.version}</maven-plugin-plugin.version>
     </properties>
diff --git a/build-plugin/src/main/java/org/mvndaemon/mvnd/plugin/doc/DocMojo.java b/build-plugin/src/main/java/org/mvndaemon/mvnd/plugin/doc/DocMojo.java
index 8c12dd4..46285f3 100644
--- a/build-plugin/src/main/java/org/mvndaemon/mvnd/plugin/doc/DocMojo.java
+++ b/build-plugin/src/main/java/org/mvndaemon/mvnd/plugin/doc/DocMojo.java
@@ -99,7 +99,8 @@ public class DocMojo extends AbstractMojo {
             final Properties optionsProperties = new SortedProperties();
             for (EnumConstantSource enumConst : source.getEnumConstants()) {
                 final JavaDocSource<EnumConstantSource> javaDoc = enumConst.getJavaDoc();
-                final String javadocText = javaDoc.getText();
+                final String javadocText = javaDoc.getText()
+                        .replaceAll("&#47;", "/");
                 optionsProperties.setProperty(enumConst.getName(), javadocText);
             }
             optionsProperties.store(Files.newOutputStream(propsPath), null);
diff --git a/common/src/main/java/org/mvndaemon/mvnd/common/Environment.java b/common/src/main/java/org/mvndaemon/mvnd/common/Environment.java
index 1fa9b64..20547e6 100644
--- a/common/src/main/java/org/mvndaemon/mvnd/common/Environment.java
+++ b/common/src/main/java/org/mvndaemon/mvnd/common/Environment.java
@@ -251,7 +251,16 @@ public enum Environment {
      */
     MVND_SOCKET_FAMILY("mvnd.socketFamily", null, "inet", OptionType.STRING, Flags.DISCRIMINATING),
     /**
-     * Regexp pattern that will force eviction of the plugin realms if one of its dependencies matches.
+     * Pattern that will force eviction of the plugin realms if one of its dependencies matches.
+     * The overall pattern is a comma separated list of either:
+     * <ul>
+     * <li>a glob pattern starting with <code>'glob:'</code> (the default syntax if no scheme is specified),</li>
+     * <li>a regex pattern starting with <code>'regex:'</code>,</li>
+     * <li>a maven expression, either <code>'mvn:[groupId]:[artifactId]:[version]'</code>,
+     * <code>'mvn:[groupId]:[artifactId]'</code> or <code>'mvn:[artifactId]</code>'.</li>
+     * </ul>
+     * This pattern will be evaluated against the full path of the dependencies, so it is usually desirable to
+     * start with <code>'glob:**&#47;'</code> to support any location of the local repository.
      */
     MVND_PLUGIN_REALM_EVICT_PATTERN("mvnd.pluginRealmEvictPattern", null, "", OptionType.STRING, Flags.OPTIONAL),
     /**