Siyao Meng created HDDS-8065:
--------------------------------

             Summary: Follow GNU long options convention for CLI options
                 Key: HDDS-8065
                 URL: https://issues.apache.org/jira/browse/HDDS-8065
             Project: Apache Ozone
          Issue Type: Task
            Reporter: Siyao Meng


bq. 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
{code}
  @CommandLine.Option(
      names = {"-ffc", "--filterByFactor"},
{code}

to become

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





--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to