commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "J. Lewis Muir (JIRA)" <j...@apache.org>
Subject [jira] Commented: (CLI-169) HelpFormatter ignores Option's value separator
Date Sun, 28 Sep 2008 02:35:44 GMT

    [ https://issues.apache.org/jira/browse/CLI-169?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12635202#action_12635202
] 

J. Lewis Muir commented on CLI-169:
-----------------------------------

Hmm...that's a bummer.

The {{ls}} example at the bottom of [http://commons.apache.org/cli/usage.html] suggested to
me the meaning I had come to.  Look at the {{--block-size=SIZE}} help output and then the
creation of the corresponding option below with the call to {{withValueSeparator('=')}}. 
If the meaning of the value separator is what you say, then this example seems wrong.  Now
that I'm looking more closely at this example, it doesn't set the argument name to "SIZE"
either.

Sorry for the bogus patch.

> HelpFormatter ignores Option's value separator
> ----------------------------------------------
>
>                 Key: CLI-169
>                 URL: https://issues.apache.org/jira/browse/CLI-169
>             Project: Commons CLI
>          Issue Type: Bug
>          Components: Help formatter
>    Affects Versions: 1.2
>            Reporter: J. Lewis Muir
>             Fix For: 1.2
>
>         Attachments: use-value-separator-in-help-formatter.patch
>
>   Original Estimate: 0.5h
>  Remaining Estimate: 0.5h
>
> The HelpFormatter always renders a space between the option name and value even if the
option has a value separator that is not a space.  For example, this option:
> {code}
> Option option = new Option("B", "bsize", true, "block size in bytes");
> option.setArgName("SIZE");
> option.setValueSeparator('=');
> {code}
> is rendered like this:
> {noformat}
> -B,--bsize <SIZE>  block size in bytes
> {noformat}
> But I would expect it to be rendered like this:
> {noformat}
> -B,--bsize=<SIZE>  block size in bytes
> {noformat}
> For the automatically generated usage message, a similar problem exists.  I changed it
to try to use the value separator when rendering the option with the short name only if there's
no long name.  If there's no short name, it always tries to use the value separator with the
long name rendering.
> For example, consider this option containing a short name and a specified value separator:
> {code}
> Option option = new Option("B", true, "block size in bytes");
> option.setArgName("SIZE");
> option.setValueSeparator('=');
> {code}
> The automatically generated usage message with my changes would look like this:
> {noformat}
> usage: app [-B=<SIZE>]
> {noformat}
> If the same option included a long name too:
> {code}
> Option option = new Option("B", "bsize", true, "block size in bytes");
> option.setArgName("SIZE");
> option.setValueSeparator('=');
> {code}
> with my changes the value separator is assumed to be meant for use with the long name.
 The short option rendering in the usage message will not try to use the value separator and
will render the usage message like this:
> {noformat}
> usage: app [-B <SIZE>]
> {noformat}
> Attached is a patch for these fixes with test cases.  The patch is against [http://svn.apache.org/repos/asf/commons/proper/cli/branches/cli-1.x].

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message