[ 
https://issues.apache.org/jira/browse/HDFS-8552?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Xiaoyu Yao updated HDFS-8552:
-----------------------------
    Description: 
The usage message from code does not match with the one documented. 
1. "java NameNode" should be "hdfs namenode"
-2. Many of options are not documented. -

Usage message from code:
{code}
  private static final String USAGE = "Usage: java NameNode ["
      + StartupOption.BACKUP.getName() + "] | \n\t["
      + StartupOption.CHECKPOINT.getName() + "] | \n\t["
      + StartupOption.FORMAT.getName() + " ["
      + StartupOption.CLUSTERID.getName() + " cid ] ["
      + StartupOption.FORCE.getName() + "] ["
      + StartupOption.NONINTERACTIVE.getName() + "] ] | \n\t["
      + StartupOption.UPGRADE.getName() + 
        " [" + StartupOption.CLUSTERID.getName() + " cid]" +
        " [" + StartupOption.RENAMERESERVED.getName() + "<k-v pairs>] ] | \n\t["
      + StartupOption.UPGRADEONLY.getName() + 
        " [" + StartupOption.CLUSTERID.getName() + " cid]" +
        " [" + StartupOption.RENAMERESERVED.getName() + "<k-v pairs>] ] | \n\t["
      + StartupOption.ROLLBACK.getName() + "] | \n\t["
      + StartupOption.ROLLINGUPGRADE.getName() + " "
      + RollingUpgradeStartupOption.getAllOptionString() + " ] | \n\t["
      + StartupOption.IMPORT.getName() + "] | \n\t["
      + StartupOption.INITIALIZESHAREDEDITS.getName() + "] | \n\t["
      + StartupOption.BOOTSTRAPSTANDBY.getName() + "] | \n\t["
      + StartupOption.RECOVER.getName() + " [ "
      + StartupOption.FORCE.getName() + "] ] | \n\t["
      + StartupOption.METADATAVERSION.getName() + " ] "
      + " ]";
{code}

Usage from document:
hdfs namenode [-backup] |
          [-checkpoint] |
          [-format [-clusterid cid ] [-force] [-nonInteractive] ] |
          [-upgrade [-clusterid cid] [-renameReserved<k-v pairs>] ] |
          [-upgradeOnly [-clusterid cid] [-renameReserved<k-v pairs>] ] |
          [-rollback] |
          [-rollingUpgrade <downgrade |rollback> ] |
          [-finalize] |
          [-importCheckpoint] |
          [-initializeSharedEdits] |
          [-bootstrapStandby] |
          [-recover [-force] ] |
          [-metadataVersion ]

  was:
The usage message from code does not match with the one documented. 
1. "java NameNode" should be "hdfs namenode"
2. Many of options are not documented. 

Usage message from code:
{code}
  private static final String USAGE = "Usage: java NameNode ["
      + StartupOption.BACKUP.getName() + "] | \n\t["
      + StartupOption.CHECKPOINT.getName() + "] | \n\t["
      + StartupOption.FORMAT.getName() + " ["
      + StartupOption.CLUSTERID.getName() + " cid ] ["
      + StartupOption.FORCE.getName() + "] ["
      + StartupOption.NONINTERACTIVE.getName() + "] ] | \n\t["
      + StartupOption.UPGRADE.getName() + 
        " [" + StartupOption.CLUSTERID.getName() + " cid]" +
        " [" + StartupOption.RENAMERESERVED.getName() + "<k-v pairs>] ] | \n\t["
      + StartupOption.UPGRADEONLY.getName() + 
        " [" + StartupOption.CLUSTERID.getName() + " cid]" +
        " [" + StartupOption.RENAMERESERVED.getName() + "<k-v pairs>] ] | \n\t["
      + StartupOption.ROLLBACK.getName() + "] | \n\t["
      + StartupOption.ROLLINGUPGRADE.getName() + " "
      + RollingUpgradeStartupOption.getAllOptionString() + " ] | \n\t["
      + StartupOption.IMPORT.getName() + "] | \n\t["
      + StartupOption.INITIALIZESHAREDEDITS.getName() + "] | \n\t["
      + StartupOption.BOOTSTRAPSTANDBY.getName() + "] | \n\t["
      + StartupOption.RECOVER.getName() + " [ "
      + StartupOption.FORCE.getName() + "] ] | \n\t["
      + StartupOption.METADATAVERSION.getName() + " ] "
      + " ]";
{code}

Usage from document:
hdfs namenode [-backup] |
          [-checkpoint] |
          [-format [-clusterid cid ] [-force] [-nonInteractive] ] |
          [-upgrade [-clusterid cid] [-renameReserved<k-v pairs>] ] |
          [-upgradeOnly [-clusterid cid] [-renameReserved<k-v pairs>] ] |
          [-rollback] |
          [-rollingUpgrade <downgrade |rollback> ] |
          [-finalize] |
          [-importCheckpoint] |
          [-initializeSharedEdits] |
          [-bootstrapStandby] |
          [-recover [-force] ] |
          [-metadataVersion ]


> Fix hdfs namenode CLI usage message and its document
> ----------------------------------------------------
>
>                 Key: HDFS-8552
>                 URL: https://issues.apache.org/jira/browse/HDFS-8552
>             Project: Hadoop HDFS
>          Issue Type: Bug
>    Affects Versions: 2.6.0
>            Reporter: Xiaoyu Yao
>            Assignee: Brahma Reddy Battula
>         Attachments: HDFS-8552.patch
>
>
> The usage message from code does not match with the one documented. 
> 1. "java NameNode" should be "hdfs namenode"
> -2. Many of options are not documented. -
> Usage message from code:
> {code}
>   private static final String USAGE = "Usage: java NameNode ["
>       + StartupOption.BACKUP.getName() + "] | \n\t["
>       + StartupOption.CHECKPOINT.getName() + "] | \n\t["
>       + StartupOption.FORMAT.getName() + " ["
>       + StartupOption.CLUSTERID.getName() + " cid ] ["
>       + StartupOption.FORCE.getName() + "] ["
>       + StartupOption.NONINTERACTIVE.getName() + "] ] | \n\t["
>       + StartupOption.UPGRADE.getName() + 
>         " [" + StartupOption.CLUSTERID.getName() + " cid]" +
>         " [" + StartupOption.RENAMERESERVED.getName() + "<k-v pairs>] ] | 
> \n\t["
>       + StartupOption.UPGRADEONLY.getName() + 
>         " [" + StartupOption.CLUSTERID.getName() + " cid]" +
>         " [" + StartupOption.RENAMERESERVED.getName() + "<k-v pairs>] ] | 
> \n\t["
>       + StartupOption.ROLLBACK.getName() + "] | \n\t["
>       + StartupOption.ROLLINGUPGRADE.getName() + " "
>       + RollingUpgradeStartupOption.getAllOptionString() + " ] | \n\t["
>       + StartupOption.IMPORT.getName() + "] | \n\t["
>       + StartupOption.INITIALIZESHAREDEDITS.getName() + "] | \n\t["
>       + StartupOption.BOOTSTRAPSTANDBY.getName() + "] | \n\t["
>       + StartupOption.RECOVER.getName() + " [ "
>       + StartupOption.FORCE.getName() + "] ] | \n\t["
>       + StartupOption.METADATAVERSION.getName() + " ] "
>       + " ]";
> {code}
> Usage from document:
> hdfs namenode [-backup] |
>           [-checkpoint] |
>           [-format [-clusterid cid ] [-force] [-nonInteractive] ] |
>           [-upgrade [-clusterid cid] [-renameReserved<k-v pairs>] ] |
>           [-upgradeOnly [-clusterid cid] [-renameReserved<k-v pairs>] ] |
>           [-rollback] |
>           [-rollingUpgrade <downgrade |rollback> ] |
>           [-finalize] |
>           [-importCheckpoint] |
>           [-initializeSharedEdits] |
>           [-bootstrapStandby] |
>           [-recover [-force] ] |
>           [-metadataVersion ]



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to