[maven-dependency-plugin] branch master updated: [MDEP-749] document why excludeScope=test fails and what to do instead

[hb...@apache.org]

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-dependency-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new 807f24d  [MDEP-749] document why excludeScope=test fails and what to do instead
807f24d is described below

commit 807f24d2d12838564fb66e11e1d2cc093e6c3658
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Thu May 20 20:19:08 2021 +0200

    [MDEP-749] document why excludeScope=test fails and what to do instead
---
 .../fromDependencies/AbstractDependencyFilterMojo.java        | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
index a896865..9d66349 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/fromDependencies/AbstractDependencyFilterMojo.java
@@ -138,7 +138,16 @@ public abstract class AbstractDependencyFilterMojo
     protected String includeScope;
 
     /**
-     * Scope to exclude. An Empty string indicates no scopes (default).
+     * Scope to exclude. An Empty string indicates no scopes (default). The scopes being interpreted are the scopes as
+     * Maven sees them, not as specified in the pom. In summary:
+     * <ul>
+     * <li><code>runtime</code> scope excludes runtime and compile dependencies,</li>
+     * <li><code>compile</code> scope excludes compile, provided, and system dependencies,</li>
+     * <li><code>test</code> scope excludes all dependencies, then not really a legitimate option: it will fail,
+     * you probably meant to configure includeScope = compile or runtime</li>
+     * <li><code>provided</code> scope just excludes provided dependencies,</li>
+     * <li><code>system</code> scope just excludes system dependencies.</li>
+     * </ul>
      *
      * @since 2.0
      */