diff --git a/openstack/common/cache/cache.py b/openstack/common/cache/cache.py index d7cd16e62..777e221cc 100644 --- a/openstack/common/cache/cache.py +++ b/openstack/common/cache/cache.py @@ -36,7 +36,7 @@ def _get_olso_configs(): return [ cfg.StrOpt('cache_url', default='memory://', - help='Url to connect to the cache backend.') + help='URL to connect to the cache back end.') ] diff --git a/openstack/common/db/sqlalchemy/session.py b/openstack/common/db/sqlalchemy/session.py index 3607ac741..49821aee3 100644 --- a/openstack/common/db/sqlalchemy/session.py +++ b/openstack/common/db/sqlalchemy/session.py @@ -291,10 +291,10 @@ from openstack.common import timeutils sqlite_db_opts = [ cfg.StrOpt('sqlite_db', default='oslo.sqlite', - help='the filename to use with sqlite'), + help='The file name to use with SQLite'), cfg.BoolOpt('sqlite_synchronous', default=True, - help='If true, use synchronous mode for sqlite'), + help='If True, SQLite uses synchronous mode'), ] database_opts = [ @@ -324,7 +324,7 @@ database_opts = [ group='DATABASE'), cfg.DeprecatedOpt('idle_timeout', group='sql')], - help='timeout before idle sql connections are reaped'), + help='Timeout before idle sql connections are reaped'), cfg.IntOpt('min_pool_size', default=1, deprecated_opts=[cfg.DeprecatedOpt('sql_min_pool_size', @@ -347,7 +347,7 @@ database_opts = [ group='DEFAULT'), cfg.DeprecatedOpt('sql_max_retries', group='DATABASE')], - help='maximum db connection retries during startup. ' + help='Maximum db connection retries during startup. ' '(setting -1 implies an infinite retry count)'), cfg.IntOpt('retry_interval', default=10, @@ -355,7 +355,7 @@ database_opts = [ group='DEFAULT'), cfg.DeprecatedOpt('reconnect_interval', group='DATABASE')], - help='interval between retries of opening a sql connection'), + help='Interval between retries of opening a sql connection'), cfg.IntOpt('max_overflow', default=None, deprecated_opts=[cfg.DeprecatedOpt('sql_max_overflow', diff --git a/openstack/common/log.py b/openstack/common/log.py index f4ef463a5..ded32b44d 100644 --- a/openstack/common/log.py +++ b/openstack/common/log.py @@ -118,7 +118,7 @@ logging_cli_opts = [ help='Use syslog for logging.'), cfg.StrOpt('syslog-log-facility', default='LOG_USER', - help='syslog facility to receive log lines') + help='Syslog facility to receive log lines') ] generic_log_opts = [ @@ -132,18 +132,18 @@ log_opts = [ default='%(asctime)s.%(msecs)03d %(process)d %(levelname)s ' '%(name)s [%(request_id)s %(user_identity)s] ' '%(instance)s%(message)s', - help='format string to use for log messages with context'), + help='Format string to use for log messages with context'), cfg.StrOpt('logging_default_format_string', default='%(asctime)s.%(msecs)03d %(process)d %(levelname)s ' '%(name)s [-] %(instance)s%(message)s', - help='format string to use for log messages without context'), + help='Format string to use for log messages without context'), cfg.StrOpt('logging_debug_format_suffix', default='%(funcName)s %(pathname)s:%(lineno)d', - help='data to append to log format when level is DEBUG'), + help='Data to append to log format when level is DEBUG'), cfg.StrOpt('logging_exception_prefix', default='%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s ' '%(instance)s', - help='prefix each line of exception output with this format'), + help='Prefix each line of exception output with this format'), cfg.ListOpt('default_log_levels', default=[ 'amqp=WARN', @@ -154,13 +154,13 @@ log_opts = [ 'suds=INFO', 'iso8601=WARN', ], - help='list of logger=LEVEL pairs'), + help='List of logger=LEVEL pairs'), cfg.BoolOpt('publish_errors', default=False, - help='publish error events'), + help='Publish error events'), cfg.BoolOpt('fatal_deprecations', default=False, - help='make deprecations fatal'), + help='Make deprecations fatal'), # NOTE(mikal): there are two options here because sometimes we are handed # a full instance (and could include more information), and other times we diff --git a/openstack/common/middleware/sizelimit.py b/openstack/common/middleware/sizelimit.py index b402398b9..8a38e6212 100644 --- a/openstack/common/middleware/sizelimit.py +++ b/openstack/common/middleware/sizelimit.py @@ -28,8 +28,8 @@ from openstack.common.middleware import base max_req_body_size = cfg.IntOpt('max_request_body_size', deprecated_name='osapi_max_request_body_size', default=114688, - help='the maximum body size ' - 'per each request(bytes)') + help='The maximum body size ' + 'per request, in bytes') CONF = cfg.CONF CONF.register_opt(max_req_body_size) diff --git a/openstack/common/quota.py b/openstack/common/quota.py index 2f09fe622..e07ebd68d 100644 --- a/openstack/common/quota.py +++ b/openstack/common/quota.py @@ -31,19 +31,19 @@ LOG = logging.getLogger(__name__) common_quota_opts = [ cfg.BoolOpt('use_default_quota_class', default=True, - help='whether to use default quota class for default quota'), + help='Whether to use default quota class for default quota'), cfg.StrOpt('quota_driver', default='openstack.common.quota.DbQuotaDriver', - help='default driver to use for quota checks'), + help='Default driver to use for quota checks'), cfg.IntOpt('until_refresh', default=0, - help='count of reservations until usage is refreshed'), + help='Count of reservations until usage is refreshed'), cfg.IntOpt('max_age', default=0, - help='number of seconds between subsequent usage refreshes'), + help='Number of seconds between subsequent usage refreshes'), cfg.IntOpt('reservation_expire', default=86400, - help='number of seconds until a reservation expires'), + help='Number of seconds until a reservation expires'), ] CONF = cfg.CONF diff --git a/openstack/common/rpc/impl_kombu.py b/openstack/common/rpc/impl_kombu.py index d604adb84..8dce5524a 100644 --- a/openstack/common/rpc/impl_kombu.py +++ b/openstack/common/rpc/impl_kombu.py @@ -38,9 +38,9 @@ from openstack.common import sslutils kombu_opts = [ cfg.StrOpt('kombu_ssl_version', default='', - help='SSL version to use (valid only if SSL enabled). ' - 'valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may ' - 'be available on some distributions' + help='If SSL is enabled, the SSL version to use. Valid ' + 'values are TLSv1, SSLv23 and SSLv3. SSLv2 might ' + 'be available on some distributions.' ), cfg.StrOpt('kombu_ssl_keyfile', default='', @@ -63,33 +63,33 @@ kombu_opts = [ help='RabbitMQ HA cluster host:port pairs'), cfg.BoolOpt('rabbit_use_ssl', default=False, - help='connect over SSL for RabbitMQ'), + help='Connect over SSL for RabbitMQ'), cfg.StrOpt('rabbit_userid', default='guest', - help='the RabbitMQ userid'), + help='The RabbitMQ userid'), cfg.StrOpt('rabbit_password', default='guest', - help='the RabbitMQ password', + help='The RabbitMQ password', secret=True), cfg.StrOpt('rabbit_virtual_host', default='/', - help='the RabbitMQ virtual host'), + help='The RabbitMQ virtual host'), cfg.IntOpt('rabbit_retry_interval', default=1, - help='how frequently to retry connecting with RabbitMQ'), + help='How frequently to retry connecting with RabbitMQ'), cfg.IntOpt('rabbit_retry_backoff', default=2, - help='how long to backoff for between retries when connecting ' + help='How long to backoff for between retries when connecting ' 'to RabbitMQ'), cfg.IntOpt('rabbit_max_retries', default=0, - help='maximum retries with trying to connect to RabbitMQ ' - '(the default of 0 implies an infinite retry count)'), + help='Maximum number of RabbitMQ connection retries. ' + 'Default is 0 (infinite retry count)'), cfg.BoolOpt('rabbit_ha_queues', default=False, - help='use H/A queues in RabbitMQ (x-ha-policy: all).' - 'You need to wipe RabbitMQ database when ' - 'changing this option.'), + help='Use HA queues in RabbitMQ (x-ha-policy: all). ' + 'If you change this option, you must wipe the ' + 'RabbitMQ database.'), ]