← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1279973] Re: Help text for deprecated cli option has _ rather than -

 

Reviewed:  https://review.openstack.org/438752
Committed: https://git.openstack.org/cgit/openstack/oslo.config/commit/?id=0c6040ef6b85a77abd277a9e63be614877ca7c6a
Submitter: Jenkins
Branch:    master

commit 0c6040ef6b85a77abd277a9e63be614877ca7c6a
Author: Ben Nemec <bnemec@xxxxxxxxxx>
Date:   Tue Feb 28 00:02:16 2017 +0000

    Handle both - and _ forms of deprecated opts
    
    While config file opts cannot have a - in their name, CLI opts can
    and the current deprecation code doesn't handle that case properly.
    Additionally, because oslo.config has some magic to translate one
    to the other it is possible we have existing users relying on the
    wrong behavior.  For this reason, let's add both forms of the opt
    when adding deprecated opts.  This will allow both to work as
    expected.
    
    The config generator is updated to ignore the - form of deprecated
    opts since they won't work in a config file anyway.
    
    I'm unsure how to filter the extra opts out of the help text, but
    since both forms will work in that case it's a minor cosmetic
    issue.
    
    Change-Id: I4d2584b33d97fe00a427b992682d9eac391725a2
    Closes-Bug: 1279973


** Changed in: oslo.config
       Status: In Progress => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Identity (keystone).
https://bugs.launchpad.net/bugs/1279973

Title:
  Help text for deprecated cli option has _ rather than -

Status in OpenStack Identity (keystone):
  Invalid
Status in oslo.config:
  Fix Released

Bug description:
  
  In oslo-incubator log.py, there's a cli option with a deprecated value [1]. 

      cfg.StrOpt('log-config-append',
                 deprecated_name='log-config',
                 help='...'),

  When the help text is generated, the primary name has the -s as
  expected, but the deprecated name has _:

    --log-config-append PATH, --log_config PATH

  You can see this in the output of keystone-all --help.

  The deprecated name in the help text should use - just like the
  primary name, so the output should be like:

    --log-config-append PATH, --log-config PATH

  [1] http://git.openstack.org/cgit/openstack/oslo-
  incubator/tree/openstack/common/log.py?id=4f7e269ddb8f388c715c2505151a4f8add71dd0f#n83

To manage notifications about this bug go to:
https://bugs.launchpad.net/keystone/+bug/1279973/+subscriptions