openstack/oslo.config
Code Issues Proposed changes

Expand DeprecatedOpt documentation

Browse Source 
It is not a priori obvious how deprecated options are chosen, so
expand the docstring a bit

Change-Id: If10b45fb042b4a4d6063129b693228fd6ca86b82
This commit is contained in:
Ian Wienand 2013-09-25 14:31:06 +10:00
parent 9dabbd0ff7
commit 3d59667b78
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
oslo/config/cfg.py
View File

@ -733,6 +733,13 @@ class DeprecatedOpt(object):
cfg.CONF.register_group(cfg.OptGroup('blaa'))
cfg.CONF.register_opt(cfg.StrOpt('foo', deprecated_opts=oldopts),
group='blaa')
Multi-value options will return all new and deprecated
options. For single options, if the new option is present
("[blaa]/foo" above) it will override any deprecated options
present. If the new option is not present and multiple
deprecated options are present, the option corresponding to
the first element of deprecated_opts will be chosen.
"""
def __init__(self, name, group=None):