[HDFS-10747] o.a.h.hdfs.tools.DebugAdmin usage message is misleading

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.7.0
• Fix Version/s: 2.7.4
• Component/s: hdfs-client
• Hadoop Flags: Reviewed
• Assignee: Mingliang Liu
• Reporter: Mingliang Liu
• Created: 10/Aug/16 20:01
• Updated: 02/Oct/19 17:14
• Resolved: 16/Aug/16 04:12

Description

HDFS-6917 added a helpful hdfs debug command to validate blocks and call recoverlease. The usage doc is kinda misleading, as following:

$ hdfs debug verify
creating a new configuration
verify [-meta <metadata-file>] [-block <block-file>]
  Verify HDFS metadata and block files.  If a block file is specified, we
  will verify that the checksums in the metadata file match the block
  file.

Actually the -meta <metadata-file> is necessary. [] is for optional arguments, if we follow the convention.

$ hdfs debug recoverLease
creating a new configuration
recoverLease [-path <path>] [-retries <num-retries>]
  Recover the lease on the specified path.  The path must reside on an
  HDFS filesystem.  The default number of retries is 1.

-path <path> is also the same case.

Issue Links

• relates to: HDFS-6917 Add an hdfs debug command to validate blocks, call recoverlease, etc.
• relates to: HDFS-7326 Add documentation for hdfs debug commands