hadoop-hdfs-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Suresh Srinivas (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HDFS-3723) All commands should support meaningful --help
Date Mon, 06 Aug 2012 22:15:02 GMT

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

Suresh Srinivas commented on HDFS-3723:
---------------------------------------

Comments:
# It may be a good idea to have another jira, that adds utility to often repeated things in
this patch.
# In if conditions around the conditions such "-h".equalsIngoreCase() etc, you do not need
parenthesis
# GetGroups.java Uncomment ToolRunner.printGenericCommandUsage
# Can you please ensure an empty line is printed before printing generic command usage to
separate the command related args from generic args.
# In DFsck.java set returned result to zero when -help command is passed.
# DFSZkFailoverController.java - what is "|" for in {{java zkfc [ -formatZK [-force] | [-nonInteractive]
]}}
# TestHAAdmin.java - retain the previous test to check for -1 when you pass an invalid option
and add new tests for -help, -h and --help. Could we add these tests for all the commands,
if it is straightforward?

Unrelated to your patch (since you are making changes in these files already):
# DelegationTokenFetcher.java
#* Remove unnecessary imports DFSConfigKeys, URLUtils, Text
#* printUsage should not throw IOException
                
> All commands should support meaningful --help
> ---------------------------------------------
>
>                 Key: HDFS-3723
>                 URL: https://issues.apache.org/jira/browse/HDFS-3723
>             Project: Hadoop HDFS
>          Issue Type: Improvement
>          Components: scripts, tools
>    Affects Versions: 2.0.0-alpha
>            Reporter: E. Sammer
>            Assignee: Jing Zhao
>         Attachments: HDFS-3723.patch, HDFS-3723.patch
>
>
> Some (sub)commands support -help or -h options for detailed help while others do not.
Ideally, all commands should support meaningful help that works regardless of current state
or configuration.
> For example, hdfs zkfc --help (or -h or -help) is not very useful. Option checking should
occur before state / configuration checking.
> {code}
> [esammer@hadoop-fed01 ~]# hdfs zkfc --help
> Exception in thread "main" org.apache.hadoop.HadoopIllegalArgumentException: HA is not
enabled for this namenode.
>         at org.apache.hadoop.hdfs.tools.DFSZKFailoverController.setConf(DFSZKFailoverController.java:122)
>         at org.apache.hadoop.util.ToolRunner.run(ToolRunner.java:66)
>         at org.apache.hadoop.util.ToolRunner.run(ToolRunner.java:84)
>         at org.apache.hadoop.hdfs.tools.DFSZKFailoverController.main(DFSZKFailoverController.java:168)
> {code}
> This would go a long way toward better usability for ops staff.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message