Adding long form of help arguments to the help output

Review Request #1732 - Created Feb. 7, 2015 and submitted

Information
Eric Ayers
pants
zundel/help-long-format
1055
f3b1967...
Reviewers
pants-reviews
benjyw, jsirois, lahosken
Adding long form of help arguments to the help output

As discussed at the Pants summit, this change modifies the existing help output to print the long form of the option.

Previously, the help output printed only the short form (scoped) flags:

run.jvm
  -h, --help              show this help message and exit
  --jvm-options <option>...
                          Run the jvm with these extra jvm options. (default:
                          ['-Xmx1g', '-XX:MaxPermSize=256m'])
  --args <arg>...         Run the jvm with these extra program args. (default:
                          [])
  --[no-]debug            Run the jvm under a debugger. (default: None)
  ...

The updated output is as follows:

run.jvm
  --run-jvm-help
  -h, --help              show this help message and exit
  --run-jvm-jvm-options
  --jvm-options <option>...
                          Run the jvm with these extra jvm options. (default:
                          ['-Xmx1g', '-XX:MaxPermSize=256m'])
  --run-jvm-args
  --args <arg>...         Run the jvm with these extra program args. (default:
                          [])
  --[no-]run-jvm-debug
  --[no-]debug            Run the jvm under a debugger. (default: None)
  ...
Larry Hosken
Benjy Weinberger
Eric Ayers
Eric Ayers
Review request changed

Status: Closed (submitted)

Change Summary:

thanks for the reviews submitted at 31629b1

Loading...