[HDDS-8065] Follow GNU long options convention for CLI options

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Done
• Fix Version/s: 1.4.0
• Labels: pull-request-available
• Assignee: JiaChi Wang
• Reporter: Siyao Meng
• Created: 02/Mar/23 00:47
• Updated: 15/Mar/23 06:42
• Resolved: 15/Mar/23 06:42

Description

GNU adds long options to these conventions. Long options consist of – followed by a name made of alphanumeric characters and dashes. Option names are typically one to three words long, with hyphens to separate words. Users can abbreviate the option names as long as the abbreviations are unique.

https://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html

Proposal: Add lower case hyphen arg names for those that only has camel case long option:

e.g.
https://github.com/apache/ozone/blob/91757d51451e184039366e3dd38d1b64c8864af9/hadoop-hdds/tools/src/main/java/org/apache/hadoop/hdds/scm/cli/pipeline/ListPipelinesSubcommand.java#L60-L61

  @CommandLine.Option(
      names = {"-ffc", "--filterByFactor"},

to become

  @CommandLine.Option(
      names = {"-ffc", "--filter-by-factor", "--filterByFactor"},

Issue Links

• is related to: HDDS-7944 Add dash-separated-options where missing
• links to: GitHub Pull Request #4394