Extend mvn help text for various features of Maven 4.0.0 #463
Conversation
| 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() ); |
There was a problem hiding this comment.
I would rather write: ...with an exclamation mark (!) ex...., and question mark (?) marks it...
There was a problem hiding this 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?
There was a problem hiding this comment.
This is my concern too. The (default) help output should be compact, it used to fit on 1 page.
With the new jansi we're probably gaining some space due to the width calculation.
There was a problem hiding this 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?
There was a problem hiding this comment.
Let's not await that Jansi upgrade, it's been open for quite some time already. If/when we have more screen real estate, we can revisit the whole mvn -h output.
There was a problem hiding this comment.
OK guys, let's add as-is and re-review as a whole later.
| options.addOption( Option.builder( RESUME_FROM ).longOpt( "resume-from" ).hasArg().desc( "Resume reactor from specified project" ).build() ); | ||
| options.addOption( Option.builder( PROJECT_LIST ).longOpt( "projects" ).desc( "Comma-delimited list of specified reactor projects to build instead of all projects. A project can be specified by [groupId]:artifactId or by its relative path" ).hasArg().build() ); | ||
| options.addOption( Option.builder( PROJECT_LIST ).longOpt( "projects" ).desc( "Comma-delimited list of specified reactor projects to build instead of all projects. A project can be specified by [groupId]:artifactId or by its relative path. Prefixing a project with ! excludes it, and ? marks it as optional" ).hasArg().build() ); |
This PR intends to briefly explain the new features of 4.0.0 (and the undocumented exclusion prefix).
In MNGSITE-444 we will extend the documentation on the site in more detail.
This PR depends on #459.
Following this checklist to help us incorporate your
contribution quickly and easily:
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
[MNG-XXX] - Fixes bug in ApproximateQuantiles,where you replace
MNG-XXXwith the appropriate JIRA issue. Best practiceis to use the JIRA issue title in the pull request title and in the first line of the
commit message.
mvn clean verifyto make sure basic checks pass. A more thorough check willbe performed on your pull request automatically.
If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.
I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.