[HDFS-10567] Improve plan command help message

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Component/s: datanode
• Hadoop Flags: Reviewed
• Assignee: Xiaobing Zhou
• Reporter: Lei (Eddy) Xu
• Created: 22/Jun/16 22:47
• Updated: 16/Aug/16 07:56
• Resolved: 16/Aug/16 03:01

Description

    --bandwidth <arg>             Maximum disk bandwidth to be consumed by
                                  diskBalancer. e.g. 10
    --maxerror <arg>              Describes how many errors can be
                                  tolerated while copying between a pair
                                  of disks.
    --out <arg>                   File to write output to, if not
                                  specified defaults will be used.
    --plan <arg>                  creates a plan for datanode.
    --thresholdPercentage <arg>   Percentage skew that wetolerate before
                                  diskbalancer starts working e.g. 10
    --v                           Print out the summary of the plan on
                                  console

We should

• Put the unit into --bandwidth, or its help message. Is it an integer or float / double number? Not clear in CLI message.
• Give more details about --plan. It is not clear what the <arg> is for.
• --thresholdPercentage, has typo wetolerate in the error message. Also it needs to indicated that it is the difference between space utilization between two disks / volumes. Is it an integer or float / double number?

Thanks.

Issue Links

• is duplicated by: HDFS-10736 Format disk balance command's output info