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:
Joseph Heck
Priority:
Medium
Drafter:
None
Direction:
Approved
Assignee:
Dean Troyer
Definition:
Approved
Series goal:
Accepted for folsom
Implementation:
Implemented
Milestone target:
milestone icon 2012.2
Started by
Joseph Heck on 2012-07-10
Completed by
Joseph Heck on 2012-07-10

Related branches

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.