From 787385215456942f17260eafca1265a3222fde0a Mon Sep 17 00:00:00 2001 From: Tamas Cservenak Date: Wed, 26 Feb 2025 15:59:51 +0100 Subject: [PATCH] Javadoc and message tidy up --- .../main/java/org/apache/maven/api/cli/mvn/MavenOptions.java | 4 +++- .../maven/cling/invoker/mvn/CommonsCliMavenOptions.java | 2 +- .../java/org/apache/maven/cling/invoker/mvn/MavenParser.java | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/MavenOptions.java b/api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/MavenOptions.java index e290114dec6..2387105a3a2 100644 --- a/api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/MavenOptions.java +++ b/api/maven-api-cli/src/main/java/org/apache/maven/api/cli/mvn/MavenOptions.java @@ -208,7 +208,9 @@ public interface MavenOptions extends Options { Optional ignoreTransitiveRepositories(); /** - * Allows {@code @filename} to read options from file. + * Specifies "@file"-like file, to load up command line from. It may contain goals as well. Format is one parameter + * per line (similar to {@code maven.conf}) and {@code '#'} (hash) marked comment lines are allowed. Goals, if + * present, are appended, to those specified on CLI input, if any. */ Optional atFile(); diff --git a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java index 51f2fe28536..8fe493cfa6c 100644 --- a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java +++ b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/CommonsCliMavenOptions.java @@ -387,7 +387,7 @@ protected void prepareOptions(org.apache.commons.cli.Options options) { options.addOption(Option.builder(AT_FILE) .longOpt("at-file") .hasArg() - .desc("If set, Maven load and merge command line options from the file as well.") + .desc("If set, Maven will load command line options from the specified file and merge with CLI specified ones.") .build()); } } diff --git a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/MavenParser.java b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/MavenParser.java index 9e55bb1e7d5..fd030ba1858 100644 --- a/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/MavenParser.java +++ b/impl/maven-cli/src/main/java/org/apache/maven/cling/invoker/mvn/MavenParser.java @@ -45,7 +45,7 @@ protected List parseCliOptions(LocalContext context) { if (Files.isRegularFile(file)) { result.add(parseMavenAtFileOptions(file)); } else { - throw new IllegalArgumentException("Specified atFile does not exists (" + file + ")"); + throw new IllegalArgumentException("Specified file does not exists (" + file + ")"); } } // maven.config; if exists