Ryan Skraba created AVRO-2688:
---------------------------------
Summary: Improve documentation and usage of avro-tools CLI
Key: AVRO-2688
URL: https://issues.apache.org/jira/browse/AVRO-2688
Project: Apache Avro
Issue Type: Improvement
Reporter: Ryan Skraba
Currently, the avro-tools main CLI wraps a number of different utilities that
could be useful to any user. Reading the code is necessary to understand what
each tool does.
It would be practical to unify the behaviour and flags of the different
utilities and have them provide more useful self-documenting information on
usage errors and --help.
As an example:
{code}
$ avrotool idl --help
Usage: idl [in] [out]
If an output path is not specified, outputs to stdout.
If no input or output is specified, takes input from
stdin and outputs to stdin.
The special path "-" may also be specified to refer to
stdin and stdout.
$ avrotool recodec --help
Exception in thread "main" joptsimple.UnrecognizedOptionException: help is not
a recognized option
at
joptsimple.OptionException.unrecognizedOption(OptionException.java:108)
at joptsimple.OptionParser.handleLongOptionToken(OptionParser.java:510)
at
joptsimple.OptionParserState$2.handleArgument(OptionParserState.java:56)
{code}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
