Cinder

Use '-' in all CLI option names

Registered by Dean Troyer on 2012-06-28

Update the keystone cli client by changing all options to use '-' (dash) in long names rather than '_' (underscore). The previous underscore option name will be maintained for backward compatibility for a release or two but not show up in help output or documentation, or me clearly marked 'DEPRECATED' if they do appear.

Blueprint information

Status:: Complete

Approver:: None

Priority:: Medium

Drafter:: None

Direction:: Needs approval

Assignee:: Dean Troyer

Definition:: Obsolete

Series goal:: Proposed for folsom

Implementation:: Unknown

Milestone target:: None

Completed by: John Griffith on 2012-11-13

Related branches

Related bugs

Sprints

Whiteboard

An example of the changed implementation looks like:

        parser.add_argument('--os-username',
                            metavar='<auth-user-name>',
                            default=env('OS_USERNAME'),
                            help='Defaults to env[OS_USERNAME]')
        parser.add_argument('--os_username',
                            help=argparse.SUPPRESSED)

This allows either option name to be used but only the 'dash' version appears in help.

The environment variable name is unaffected.

The internal variable name is the same in either case.

If both options appear on the command line the value of the second one will be used.

(?)

Work Items

This blueprint contains Public information

Everyone can see this information.

Subscribers

No subscribers.