[
https://issues.apache.org/jira/browse/HDFS-4322?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13534952#comment-13534952
]
Jonathan Allen commented on HDFS-4322:
--------------------------------------
The line breaks comment was aimed at making it easier to write help text.
Requiring the line breaks to be in the original text leads to mistakes and
inconsistent formatting, eg the help text for stat and chmod includes long
lines where the \n appears to have been missed. Moving responsibility for line
breaks to a separate format should remove this inconsistency.
> Tidy up fs -help
> ----------------
>
> Key: HDFS-4322
> URL: https://issues.apache.org/jira/browse/HDFS-4322
> Project: Hadoop HDFS
> Issue Type: Improvement
> Reporter: Jonathan Allen
> Assignee: Jonathan Allen
> Priority: Minor
>
> 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
