Javadoc and message tidy up

apache · Feb 26, 2025 · 7873852 · 7873852
1 parent 037a34f
commit 7873852
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 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
@@ -208,7 +208,9 @@ public interface MavenOptions extends Options {
     Optional<Boolean> 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<String> 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
@@ -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
@@ -45,7 +45,7 @@ protected List<Options> 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