[
https://issues.apache.org/jira/browse/CLI-147?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12601463#action_12601463
]
Sebb commented on CLI-147:
--------------------------
What about adding a link to official documentation of the Gnu and Posix option
formats?
Assuming these can be found...
Also, the table needs to show the following additional possible option formats:
-Dprop1=value1 -Dprop2=value2
-Dprop1=value1 -Dprop1=value2
-Dprop3
where D requires one or two arguments, duplicates allowed / not allowed
-O 1
-O 1234
-O -1234
-O 127.0.0.1
-O -xyz
where O requires one parameter
similarly for the long case:
--order 1
--order 1234
--order -1234
--host 127.0.0.1
The documentation needs to describe how arguments that look like flags are
handled.
Does the parser treat them as arguments, or does it start recognising another
flag and report the argument as missing?
If the latter case, how does the user enter an argument that looks like a flag?
Similarly, if the option requires only one argument, how is an embedded = sign
handled?
Also, what about optional arguments? Are they permitted?
How are these handled when followed by another flag?
Are numbers allowed as single option letters?
For example, comm(1) allows the following formats:
-1
-12
-13
-1 -2
-1 -23
It's probably also useful documenting how spaces are handled, although that is
mainly a question of how the OS/JVM parses the command-ine.
If the CLI also does command-line parsing (rather than just accepting an array
of Strings as passed to main() by the JVM) then this needs to be documented too.
> Create page explaining which parser to use when
> -----------------------------------------------
>
> Key: CLI-147
> URL: https://issues.apache.org/jira/browse/CLI-147
> Project: Commons CLI
> Issue Type: Task
> Components: Documentation
> Affects Versions: 1.1
> Reporter: Henri Yandell
> Assignee: Henri Yandell
> Fix For: 1.2
>
>
> Basically a short summary of what each parser does.
> Also put each relevant bit in the javadoc.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
