This is an automated email from the ASF dual-hosted git repository. sjaranowski pushed a commit to branch MDEP-945 in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git
commit bc175a69af9695bc195101d0bc43c7954036b973 Author: Slawomir Jaranowski <[email protected]> AuthorDate: Sun Jun 16 17:10:38 2024 +0200 [MDEP-945] Fix documentation about get goal --- .../apache/maven/plugins/dependency/GetMojo.java | 12 ++-- src/site/apt/usage.apt.vm | 72 +++++++++++----------- 2 files changed, 42 insertions(+), 42 deletions(-) diff --git a/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java b/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java index d0b86033..73b3eb31 100644 --- a/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java +++ b/src/main/java/org/apache/maven/plugins/dependency/GetMojo.java @@ -105,7 +105,7 @@ public class GetMojo extends AbstractMojo { private List<ArtifactRepository> pomRemoteRepositories; /** - * Download transitively, retrieving the specified artifact and all of its dependencies. + * Resolve transitively, retrieving the specified artifact and all of its dependencies. */ @Parameter(property = "transitive", defaultValue = "true") private boolean transitive = true; @@ -241,7 +241,7 @@ public class GetMojo extends AbstractMojo { } /** - * The groupId of the artifact to download. Ignored if {@link #artifact} is used. + * The groupId of the artifact to resolve. Ignored if {@link #artifact} is used. * * @param groupId The groupId. */ @@ -251,7 +251,7 @@ public class GetMojo extends AbstractMojo { } /** - * The artifactId of the artifact to download. Ignored if {@link #artifact} is used. + * The artifactId of the artifact to resolve. Ignored if {@link #artifact} is used. * * @param artifactId The artifactId. */ @@ -261,7 +261,7 @@ public class GetMojo extends AbstractMojo { } /** - * The version of the artifact to download. Ignored if {@link #artifact} is used. + * The version of the artifact to resolve. Ignored if {@link #artifact} is used. * * @param version The version. */ @@ -271,7 +271,7 @@ public class GetMojo extends AbstractMojo { } /** - * The classifier of the artifact to download. Ignored if {@link #artifact} is used. + * The classifier of the artifact to resolve. Ignored if {@link #artifact} is used. * * @param classifier The classifier to be used. * @@ -283,7 +283,7 @@ public class GetMojo extends AbstractMojo { } /** - * The packaging of the artifact to download. Ignored if {@link #artifact} is used. + * The packaging of the artifact to resolve. Ignored if {@link #artifact} is used. * * @param type packaging. */ diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm index 030fa76e..1132cd5a 100644 --- a/src/site/apt/usage.apt.vm +++ b/src/site/apt/usage.apt.vm @@ -90,9 +90,9 @@ Usage If you intend to configure this goal for execution on the command line using: -+---+ +--- mvn dependency:copy -+---+ +--- you must not put the configuration inside the <executions> tag. Your configuration should look like this: @@ -258,9 +258,9 @@ mvn dependency:copy If you intend to configure this goal for execution on the command line using: -+---+ +--- mvn dependency:unpack -+---+ +--- you must not put the configuration inside the <executions> tag. Your configuration should look like this: @@ -457,16 +457,16 @@ mvn dependency:unpack In its simplest form, the goal can be called like this: -+---+ +--- mvn dependency:purge-local-repository -+---+ +--- To add the restriction that the <<<org.apache.maven:maven-plugin-api>>> artifact not be deleted, we can modify the command to this: -+---+ +--- mvn dependency:purge-local-repository -Dexclude=org.apache.maven:maven-plugin-api -+---+ +--- <<Note:>> The <<<exclude>>> parameter is a comma-delimited list of groupId:artifactId pairs. It has a corresponding List-based parameter - @@ -497,9 +497,9 @@ mvn dependency:purge-local-repository -Dexclude=org.apache.maven:maven-plugin-ap (in order to verify proper artifact resolution, for example), simply use this command: -+---+ +--- mvn dependency:purge-local-repository -DresolutionFuzziness=artifactId -+---+ +--- Finally, it's possible to bind this goal to the build lifecycle. One reason for this might be to clean out all dependencies when the build is initialized, to verify @@ -513,9 +513,9 @@ mvn dependency:purge-local-repository -DresolutionFuzziness=artifactId This goal can be executed from the command line: -+---+ +--- mvn dependency:analyze -+---+ +--- Sample output: @@ -540,9 +540,9 @@ mvn dependency:analyze This goal can be executed from the command line: -+---+ +--- mvn dependency:analyze-dep-mgt -+---+ +--- Sample output: @@ -593,15 +593,15 @@ mvn dependency:analyze-dep-mgt This goal can be executed from the command line: -+-----+ +--- mvn dependency:tree -+-----+ +--- Optionally, the <<<output>>> parameter can be specified to divert the output to a file: -+-----+ +--- mvn dependency:tree -DoutputFile=/path/to/file -+-----+ +--- Also, the <<<outputType>>> parameter can be used to generate different formats of output. The following formats are currently supported: @@ -616,9 +616,9 @@ mvn dependency:tree -DoutputFile=/path/to/file [] -+-----+ +--- mvn dependency:tree -DoutputFile=/path/to/file.graphml -DoutputType=graphml -+-----+ +--- * <<<dependency:build-classpath>>> @@ -627,27 +627,27 @@ mvn dependency:tree -DoutputFile=/path/to/file.graphml -DoutputType=graphml This goal will output a classpath string of dependencies from the local repository to a file or log and optionally attach and deploy the file. For instance, the file would contain a classpath string like this: -+---+ +--- /home/foo/.m2/repository/org/java/utils/util/util-1.0.jar:/home/foo/.m2/ .... -+---+ +--- The resulting file could then be used like this: -+---+ +--- java -cp `cat resultFile` MyClass -+---+ +--- In its simplest form, to output the classpath to the log, the goal can be called like this: -+---+ +--- mvn dependency:build-classpath -+---+ +--- or to write the classpath to cp.txt: -+---+ +--- mvn dependency:build-classpath -Dmdep.outputFile=cp.txt -+---+ +--- The goal can also be bound to a lifecycle phase with the following configuration: @@ -688,13 +688,13 @@ mvn dependency:build-classpath -Dmdep.outputFile=cp.txt * <<<dependency:get>>> - This goal fetches an artifact and (optionally) its dependencies from remote repositories using its Maven coordinates. + This goal resolves an artifact and (optionally) its dependencies from remote repositories using its Maven coordinates. + The Maven Central repository are always consider during resolving. -+-----+ -mvn dependency:get -DgroupId=org.apache.maven -DartifactId=maven-core -Dversion=2.2.1 -Dpackaging=jar -Dclassifier=sources -DremoteRepositories=central::default::https://repo.maven.apache.org/maven2,myrepo::::http://myrepo.com/maven2 -mvn dependency:get -DgroupId=org.apache.maven -DartifactId=maven-core -Dversion=2.2.1 -Dpackaging=jar -Dclassifier=sources -DremoteRepositories=https://repo.maven.apache.org/maven2 -mvn dependency:get -Dartifact=org.apache.maven:maven-core:2.2.1:jar:sources -DremoteRepositories=https://repo.maven.apache.org/maven2 -Ddest=/tmp/myfile.jar -+-----+ +--- +mvn dependency:get -DgroupId=org.apache.maven -DartifactId=maven-core -Dversion=2.2.1 -Dpackaging=jar -Dclassifier=sources +mvn dependency:get -DgroupId=org.apache.maven -DartifactId=maven-core -Dversion=2.2.1 -Dpackaging=jar -Dclassifier=sources -DremoteRepositories=https://myrepo.com/maven2 +--- * <<<dependency:analyze-exclusions>>> @@ -704,9 +704,9 @@ mvn dependency:get -Dartifact=org.apache.maven:maven-core:2.2.1:jar:sources -Dre Later a:b:2.0 has removed the unwanted dependency and you upgrade. This goal will inform you that the exclusion is no longer required. -+---+ +--- mvn dependency:analyze-exclusions -+---+ +--- Sample output:
