hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jonathan Allen (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HADOOP-9158) Tidy up fs -help
Date Sat, 16 Mar 2013 15:04:12 GMT

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

Jonathan Allen commented on HADOOP-9158:

Just to clarify the previous comment (as I've just noticed the formatting got lost), the current
help text for -ls is as shown below whereas using the HelpFormatter loses the indents and
pushes everything to the left.

List the contents that match the specified file pattern. If
path is not specified, the contents of /user/<currentUser>
will be listed. Directory entries are of the form 
	dirName (full path) <dir> 
and file entries are of the form 
	fileName(full path) <r n> size 
where n is the number of replicas specified for the file 
and size is the size of the file, in bytes.
  -d  Directories are listed as plain files.
  -h  Formats the sizes of files in a human-readable fashion
      rather than a number of bytes.
  -R  Recursively list the contents of directories.
> 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

View raw message