x/deb-oslo.config
Code Issues Proposed changes

update doc to use new type PortOpt

Browse Source 
We have supported a new type PortOpt, downstream will get benifit from
it, but our documents and docstrings still use old style of raw IntOpt
for port options. This patch updates those out dated docs.

Change-Id: I6d166903f591d3fe25336d133467148c01828b1b
ref: Icd4104ddfa2e36441e64aeccb0846712ce61b00f
This commit is contained in:
ZhiQiang Fan 2015-10-22 01:40:00 -06:00
parent d5cee91507
commit e208b50046
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/styleguide.rst
View File

@ -16,9 +16,9 @@ Examples::
cfg.StrOpt('bind_host',
default='0.0.0.0',
help='IP address to listen on.'),
cfg.IntOpt('bind_port',
default=9292,
help='Port number to listen on.')
cfg.PortOpt('bind_port',
default=9292,
help='Port number to listen on.')
Style Guide

8
oslo_config/cfg.py
View File

@ -166,9 +166,9 @@ Options can be registered as belonging to a group::
rabbit_host_opt = cfg.StrOpt('host',
default='localhost',
help='IP/hostname to listen on.'),
rabbit_port_opt = cfg.IntOpt('port',
default=5672,
help='Port number to listen on.')
rabbit_port_opt = cfg.PortOpt('port',
default=5672,
help='Port number to listen on.')
def register_rabbit_opts(conf):
conf.register_group(rabbit_group)
@ -296,7 +296,7 @@ in order to support a common usage pattern in OpenStack::
opts = [
cfg.StrOpt('bind_host', default='0.0.0.0'),
cfg.IntOpt('bind_port', default=9292),
cfg.PortOpt('bind_port', default=9292),
]
CONF = cfg.CONF