[GitHub] [maven] MartinKanters commented on a change in pull request #463: Extend mvn help text for various features of Maven 4.0.0

2021-04-02 Thread GitBox


MartinKanters commented on a change in pull request #463:
URL: https://github.com/apache/maven/pull/463#discussion_r606357348



##
File path: maven-embedder/src/main/java/org/apache/maven/cli/CLIManager.java
##
@@ -121,11 +121,11 @@ public CLIManager()
 options.addOption( Option.builder( Character.toString( QUIET ) 
).longOpt( "quiet" ).desc( "Quiet output - only show errors" ).build() );
 options.addOption( Option.builder( Character.toString( DEBUG ) 
).longOpt( "debug" ).desc( "Produce execution debug output" ).build() );
 options.addOption( Option.builder( Character.toString( ERRORS ) 
).longOpt( "errors" ).desc( "Produce execution error messages" ).build() );
-options.addOption( Option.builder( Character.toString( NON_RECURSIVE ) 
).longOpt( "non-recursive" ).desc( "Do not recurse into sub-projects" ).build() 
);
+options.addOption( Option.builder( Character.toString( NON_RECURSIVE ) 
).longOpt( "non-recursive" ).desc( "Do not recurse into sub-projects. When used 
together with -pl, do not recurse into sub-projects of selected aggregators" 
).build() );
 options.addOption( Option.builder( Character.toString( 
UPDATE_SNAPSHOTS ) ).longOpt( "update-snapshots" ).desc( "Forces a check for 
missing releases and updated snapshots on remote repositories" ).build() );
-options.addOption( Option.builder( Character.toString( 
ACTIVATE_PROFILES ) ).longOpt( "activate-profiles" ).desc( "Comma-delimited 
list of profiles to activate" ).hasArg().build() );
+options.addOption( Option.builder( Character.toString( 
ACTIVATE_PROFILES ) ).longOpt( "activate-profiles" ).desc( "Comma-delimited 
list of profiles to activate. Prefixing a profile with ! excludes it, and ? 
marks it as optional" ).hasArg().build() );

Review comment:
   Ah, that sounds good. When there's more space, we should take a look at 
explaining the flags a bit better I think. But perhaps for now we should stick 
with this?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org




[GitHub] [maven] MartinKanters commented on a change in pull request #463: Extend mvn help text for various features of Maven 4.0.0

2021-04-02 Thread GitBox


MartinKanters commented on a change in pull request #463:
URL: https://github.com/apache/maven/pull/463#discussion_r606258893



##
File path: maven-embedder/src/main/java/org/apache/maven/cli/CLIManager.java
##
@@ -121,11 +121,11 @@ public CLIManager()
 options.addOption( Option.builder( Character.toString( QUIET ) 
).longOpt( "quiet" ).desc( "Quiet output - only show errors" ).build() );
 options.addOption( Option.builder( Character.toString( DEBUG ) 
).longOpt( "debug" ).desc( "Produce execution debug output" ).build() );
 options.addOption( Option.builder( Character.toString( ERRORS ) 
).longOpt( "errors" ).desc( "Produce execution error messages" ).build() );
-options.addOption( Option.builder( Character.toString( NON_RECURSIVE ) 
).longOpt( "non-recursive" ).desc( "Do not recurse into sub-projects" ).build() 
);
+options.addOption( Option.builder( Character.toString( NON_RECURSIVE ) 
).longOpt( "non-recursive" ).desc( "Do not recurse into sub-projects. When used 
together with -pl, do not recurse into sub-projects of selected aggregators" 
).build() );
 options.addOption( Option.builder( Character.toString( 
UPDATE_SNAPSHOTS ) ).longOpt( "update-snapshots" ).desc( "Forces a check for 
missing releases and updated snapshots on remote repositories" ).build() );
-options.addOption( Option.builder( Character.toString( 
ACTIVATE_PROFILES ) ).longOpt( "activate-profiles" ).desc( "Comma-delimited 
list of profiles to activate" ).hasArg().build() );
+options.addOption( Option.builder( Character.toString( 
ACTIVATE_PROFILES ) ).longOpt( "activate-profiles" ).desc( "Comma-delimited 
list of profiles to activate. Prefixing a profile with ! excludes it, and ? 
marks it as optional" ).hasArg().build() );

Review comment:
   We strived for conciseness, as this text is now already four lines long 
(for profiles already seven, which makes it the longest option in mvn help by 
far). By writing out the symbols in full, this will increase even further. Are 
you sure you want this?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org