[jira] [Commented] (HADOOP-9158) Tidy up fs -help

["Daryn Sharp (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/HADOOP-9158?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13575799#comment-13575799 ] 

Daryn Sharp commented on HADOOP-9158:
-------------------------------------

I think this is a great idea.  Although I think using the apache commons option parser, like {{GenericOptionParser}} does, would be a much more flexible solution.  It already provides a tidy way to display and format usages.

Regarding {{-help}} producing lots of output, you can use {{-help <command>}} to get help for just that command.  {{-usage}} is supposed to show usage for all commands, but it appears to have been broken.
                
> Tidy up fs -help
> ----------------
>
>                 Key: HADOOP-9158
>                 URL: https://issues.apache.org/jira/browse/HADOOP-9158
>             Project: Hadoop Common
>          Issue Type: Improvement
>            Reporter: Jonathan Allen
>            Assignee: Jonathan Allen
>            Priority: Minor
>         Attachments: HADOOP-9158.patch
>
>
> There are a number of issues with the current fs -help implementation that could do with tidying up.
> 1) Running 'hadoop fs -help' displays the full detailed help for all commands.  This produces a large amount of text and makes it hard to find what you're looking for.  Better functionality would be:
> - hadoop fs -usage : shows the basic usage information for all commands
> - hadoop fs -help : shows usage and brief summary (couple of lines) for all commands
> - hadoop fs -help <command> : shows full description of the specified command
> 2) Help text is hardcoded into each command class. This should be replaced by resource files to allow internationalisation.
> 3) Line breaks are hardcoded into the help text. The help text should be auto-formatted at display time.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira