Improve help strings

Better follow oslo.config style guide for consistent help strings: * Capitalize help strings * End help strings with "." * Improve wording and capitalization. Change-Id: Ib647bd85e636b16f1d1a040bb9ba04cd319a8826
2014-02-19 21:06:53 +01:00 · 2014-02-19 21:06:53 +01:00 · 5a241dfd70
parent 23b7f5381a
commit 5a241dfd70
19 changed files with 90 additions and 81 deletions
--- a/etc/ironic/ironic.conf.sample
+++ b/etc/ironic/ironic.conf.sample
@ -4,10 +4,10 @@
 # Options defined in ironic.netconf
 #

-# ip address of this host (string value)
+# IP address of this host. (string value)
 #my_ip=10.0.0.1

-# use ipv6 (boolean value)
+# Use IPv6. (boolean value)
 #use_ipv6=false


@ -15,7 +15,8 @@
 # Options defined in ironic.api.app
 #

-# Method to use for auth: noauth or keystone. (string value)
+# Method to use for authentication: noauth or keystone.
+# (string value)
 #auth_strategy=keystone


@ -23,7 +24,7 @@
 # Options defined in ironic.common.exception
 #

-# make exception message format errors fatal (boolean value)
+# Make exception message format errors fatal. (boolean value)
 #fatal_exception_format_errors=false


@ -50,7 +51,7 @@
 # Options defined in ironic.common.images
 #

-# Force backing images to raw format (boolean value)
+# Force backing images to raw format. (boolean value)
 #force_raw_images=true


@ -58,14 +59,15 @@
 # Options defined in ironic.common.paths
 #

-# Directory where the ironic python module is installed
+# Directory where the ironic python module is installed.
 # (string value)
 #pybasedir=/usr/lib/python/site-packages/ironic

-# Directory where ironic binaries are installed (string value)
+# Directory where ironic binaries are installed. (string
+# value)
 #bindir=$pybasedir/bin

-# Top-level directory for maintaining ironic's state (string
+# Top-level directory for maintaining ironic's state. (string
 # value)
 #state_path=$pybasedir

@ -74,10 +76,11 @@
 # Options defined in ironic.common.policy
 #

-# JSON file representing policy (string value)
+# JSON file representing policy. (string value)
 #policy_file=policy.json

-# Rule checked when requested rule is not found (string value)
+# Rule checked when requested rule is not found. (string
+# value)
 #policy_default_rule=default


@ -85,13 +88,14 @@
 # Options defined in ironic.common.service
 #

-# seconds between running periodic tasks (integer value)
+# Seconds between running periodic tasks. (integer value)
 #periodic_interval=60

 # Name of this node.  This can be an opaque identifier.  It is
 # not necessarily a hostname, FQDN, or IP address. However,
 # the node name must be valid within an AMQP key, and if using
-# ZeroMQ, a valid hostname, FQDN, or IP address (string value)
+# ZeroMQ, a valid hostname, FQDN, or IP address. (string
+# value)
 #host=ironic


@ -100,10 +104,10 @@
 #

 # Path to the rootwrap configuration file to use for running
-# commands as root (string value)
+# commands as root. (string value)
 #rootwrap_config=/etc/ironic/rootwrap.conf

-# Explicitly specify the temporary working directory (string
+# Explicitly specify the temporary working directory. (string
 # value)
 #tempdir=<None>

@ -131,7 +135,7 @@
 # Options defined in ironic.openstack.common.lockutils
 #

-# Whether to disable inter-process locks (boolean value)
+# Whether to disable inter-process locks. (boolean value)
 #disable_process_locking=false

 # Directory to use for lock files. (string value)
@ -444,15 +448,16 @@
 # Options defined in ironic.conductor.manager
 #

-# Url of Ironic API service. If not set Ironic can get current
-# value from Keystone service catalog. (string value)
+# URL of Ironic API service. If not set ironic can get the
+# current value from the keystone service catalog. (string
+# value)
 #api_url=<None>

 # Seconds between conductor heart beats. (integer value)
 #heartbeat_interval=10

-# Maximum time since the last check-in of a conductor (integer
-# value)
+# Maximum time (in seconds) since the last check-in of a
+# conductor. (integer value)
 #heartbeat_timeout=60

 # Interval between syncing the node power state to the
@ -466,7 +471,7 @@
 # Options defined in ironic.db.sqlalchemy.models
 #

-# MySQL engine (string value)
+# MySQL engine to use. (string value)
 #mysql_engine=InnoDB


@ -558,7 +563,7 @@
 # Options defined in ironic.drivers.modules.ipminative
 #

-# Maximum time in seconds to retry IPMI operations (integer
+# Maximum time in seconds to retry IPMI operations. (integer
 # value)
 #retry_timeout=10

@ -609,14 +614,14 @@
 # Options defined in ironic.api
 #

-# The listen IP for the Ironic API server (string value)
+# The listen IP for the Ironic API server. (string value)
 #host_ip=0.0.0.0

-# The port for the Ironic API server (integer value)
+# The port for the Ironic API server. (integer value)
 #port=6385

 # The maximum number of items returned in a single response
-# from a collection resource (integer value)
+# from a collection resource. (integer value)
 #max_limit=1000


@ -626,28 +631,28 @@
 # Options defined in ironic.drivers.modules.pxe
 #

-# additional append parameters for baremetal PXE boot (string
+# Additional append parameters for baremetal PXE boot. (string
 # value)
 #pxe_append_params=nofb nomodeset vga=normal

-# Template file for PXE configuration (string value)
+# Template file for PXE configuration. (string value)
 #pxe_config_template=$pybasedir/drivers/modules/pxe_config.template

-# IP address of Ironic compute node's tftp server (string
+# IP address of Ironic compute node's tftp server. (string
 # value)
 #tftp_server=$my_ip

-# Ironic compute node's tftp root path (string value)
+# Ironic compute node's tftp root path. (string value)
 #tftp_root=/tftpboot

-# Directory where images are stored on disk (string value)
+# Directory where images are stored on disk. (string value)
 #images_path=/var/lib/ironic/images/

-# Directory where master tftp images are stored on disk
+# Directory where master tftp images are stored on disk.
 # (string value)
 #tftp_master_path=/tftpboot/master_images

-# Directory where master tftp images are stored on disk
+# Directory where master instance images are stored on disk.
 # (string value)
 #instance_master_path=/var/lib/ironic/master_images

@ -792,8 +797,8 @@
 # Options defined in ironic.common.glance_service.v2.image_service
 #

-# A list of url scheme that can be downloaded directly via the
-# direct_url.  Currently supported schemes: [file]. (list
+# A list of URL schemes that can be downloaded directly via
+# the direct_url.  Currently supported schemes: [file]. (list
 # value)
 #allowed_direct_url_schemes=

@ -802,10 +807,10 @@
 # Options defined in ironic.common.image_service
 #

-# default glance hostname or ip (string value)
+# Default glance hostname or IP address. (string value)
 #glance_host=$my_ip

-# default glance port (integer value)
+# Default glance port. (integer value)
 #glance_port=9292

 # Default protocol to use when connecting to glance. Set to
@ -813,15 +818,15 @@
 #glance_protocol=http

 # A list of the glance api servers available to nova. Prefix
-# with https:// for ssl-based glance api servers.
-# ([hostname|ip]:port) (string value)
+# with https:// for SSL-based glance API servers. Format is
+# [hostname|IP]:port. (string value)
 #glance_api_servers=<None>

-# Allow to perform insecure SSL (https) requests to glance
+# Allow to perform insecure SSL (https) requests to glance.
 # (boolean value)
 #glance_api_insecure=false

-# Number retries when downloading an image from glance
+# Number of retries when downloading an image from glance.
 # (integer value)
 #glance_num_retries=0

@ -836,10 +841,10 @@
 # Options defined in ironic.common.neutron
 #

-# URL for connecting to neutron (string value)
+# URL for connecting to neutron. (string value)
 #url=http://127.0.0.1:9696

-# timeout value for connecting to neutron in seconds (integer
+# Timeout value for connecting to neutron in seconds. (integer
 # value)
 #url_timeout=30

--- a/ironic/api/init.py
+++ b/ironic/api/init.py
@ -21,14 +21,14 @@ from oslo.config import cfg
 API_SERVICE_OPTS = [
    cfg.StrOpt('host_ip',
               default='0.0.0.0',
-               help='The listen IP for the Ironic API server'),
+               help='The listen IP for the Ironic API server.'),
    cfg.IntOpt('port',
               default=6385,
-               help='The port for the Ironic API server'),
+               help='The port for the Ironic API server.'),
    cfg.IntOpt('max_limit',
               default=1000,
               help='The maximum number of items returned in a single '
-                    'response from a collection resource'),
+                    'response from a collection resource.'),
    ]

 CONF = cfg.CONF
--- a/ironic/api/app.py
+++ b/ironic/api/app.py
@ -28,7 +28,7 @@ from ironic.common import policy
 auth_opts = [
    cfg.StrOpt('auth_strategy',
        default='keystone',
-        help='Method to use for auth: noauth or keystone.'),
+        help='Method to use for authentication: noauth or keystone.'),
    ]

 CONF = cfg.CONF
--- a/ironic/common/exception.py
+++ b/ironic/common/exception.py
@ -36,7 +36,7 @@ LOG = logging.getLogger(__name__)
 exc_log_opts = [
    cfg.BoolOpt('fatal_exception_format_errors',
                default=False,
-                help='make exception message format errors fatal'),
+                help='Make exception message format errors fatal.'),
 ]

 CONF = cfg.CONF
--- a/ironic/common/glance_service/v2/image_service.py
+++ b/ironic/common/glance_service/v2/image_service.py
@ -26,7 +26,7 @@ from ironic.common.glance_service import service_utils
 glance_opts = [
    cfg.ListOpt('allowed_direct_url_schemes',
                default=[],
-                help='A list of url scheme that can be downloaded directly '
+                help='A list of URL schemes that can be downloaded directly '
                'via the direct_url.  Currently supported schemes: '
                '[file].')
 ]
--- a/ironic/common/image_service.py
+++ b/ironic/common/image_service.py
@ -24,25 +24,26 @@ from oslo.config import cfg
 glance_opts = [
    cfg.StrOpt('glance_host',
               default='$my_ip',
-               help='default glance hostname or ip'),
+               help='Default glance hostname or IP address.'),
    cfg.IntOpt('glance_port',
               default=9292,
-               help='default glance port'),
+               help='Default glance port.'),
    cfg.StrOpt('glance_protocol',
               default='http',
               help='Default protocol to use when connecting to glance. '
               'Set to https for SSL.'),
    cfg.StrOpt('glance_api_servers',
               help='A list of the glance api servers available to nova. '
-               'Prefix with https:// for ssl-based glance api servers. '
-               '([hostname|ip]:port)'),
+               'Prefix with https:// for SSL-based glance API servers. '
+               'Format is [hostname|IP]:port.'),
    cfg.BoolOpt('glance_api_insecure',
                default=False,
                help='Allow to perform insecure SSL (https) requests to '
-                     'glance'),
+                     'glance.'),
    cfg.IntOpt('glance_num_retries',
               default=0,
-               help='Number retries when downloading an image from glance'),
+               help='Number of retries when downloading an image from '
+                    'glance.'),
    cfg.StrOpt('auth_strategy',
               default='keystone',
               help='Default protocol to use when connecting to glance. '
--- a/ironic/common/images.py
+++ b/ironic/common/images.py
@ -38,7 +38,7 @@ LOG = logging.getLogger(__name__)
 image_opts = [
    cfg.BoolOpt('force_raw_images',
                default=True,
-                help='Force backing images to raw format'),
+                help='Force backing images to raw format.'),
 ]

 CONF = cfg.CONF
--- a/ironic/common/neutron.py
+++ b/ironic/common/neutron.py
@ -27,10 +27,10 @@ from ironic.openstack.common import log as logging
 neutron_opts = [
    cfg.StrOpt('url',
               default='http://127.0.0.1:9696',
-               help='URL for connecting to neutron'),
+               help='URL for connecting to neutron.'),
    cfg.IntOpt('url_timeout',
               default=30,
-               help='timeout value for connecting to neutron in seconds'),
+               help='Timeout value for connecting to neutron in seconds.'),
   ]

 CONF = cfg.CONF
--- a/ironic/common/paths.py
+++ b/ironic/common/paths.py
@ -25,13 +25,13 @@ path_opts = [
    cfg.StrOpt('pybasedir',
               default=os.path.abspath(os.path.join(os.path.dirname(__file__),
                                                    '../')),
-               help='Directory where the ironic python module is installed'),
+               help='Directory where the ironic python module is installed.'),
    cfg.StrOpt('bindir',
               default='$pybasedir/bin',
-               help='Directory where ironic binaries are installed'),
+               help='Directory where ironic binaries are installed.'),
    cfg.StrOpt('state_path',
               default='$pybasedir',
-               help="Top-level directory for maintaining ironic's state"),
+               help="Top-level directory for maintaining ironic's state."),
 ]

 CONF = cfg.CONF
--- a/ironic/common/policy.py
+++ b/ironic/common/policy.py
@ -30,10 +30,10 @@ from ironic.openstack.common import policy
 policy_opts = [
    cfg.StrOpt('policy_file',
               default='policy.json',
-               help=_('JSON file representing policy')),
+               help=_('JSON file representing policy.')),
    cfg.StrOpt('policy_default_rule',
               default='default',
-               help=_('Rule checked when requested rule is not found')),
+               help=_('Rule checked when requested rule is not found.')),
    ]

 CONF = cfg.CONF
--- a/ironic/common/service.py
+++ b/ironic/common/service.py
@ -31,14 +31,14 @@ from ironic.openstack.common.rpc import service as rpc_service
 service_opts = [
    cfg.IntOpt('periodic_interval',
               default=60,
-               help='seconds between running periodic tasks'),
+               help='Seconds between running periodic tasks.'),
    cfg.StrOpt('host',
               default=socket.getfqdn(),
               help='Name of this node.  This can be an opaque identifier.  '
               'It is not necessarily a hostname, FQDN, or IP address. '
               'However, the node name must be valid within '
               'an AMQP key, and if using ZeroMQ, a valid '
-               'hostname, FQDN, or IP address'),
+               'hostname, FQDN, or IP address.'),
 ]

 cfg.CONF.register_opts(service_opts)
--- a/ironic/common/utils.py
+++ b/ironic/common/utils.py
@ -43,10 +43,10 @@ utils_opts = [
    cfg.StrOpt('rootwrap_config',
               default="/etc/ironic/rootwrap.conf",
               help='Path to the rootwrap configuration file to use for '
-                    'running commands as root'),
+                    'running commands as root.'),
    cfg.StrOpt('tempdir',
               default=None,
-               help='Explicitly specify the temporary working directory'),
+               help='Explicitly specify the temporary working directory.'),
 ]

 CONF = cfg.CONF
--- a/ironic/conductor/manager.py
+++ b/ironic/conductor/manager.py
@ -69,14 +69,16 @@ LOG = log.getLogger(__name__)
 conductor_opts = [
        cfg.StrOpt('api_url',
                   default=None,
-                   help=('Url of Ironic API service. If not set Ironic can '
-                         'get current value from Keystone service catalog.')),
+                   help=('URL of Ironic API service. If not set ironic can '
+                         'get the current value from the keystone service '
+                         'catalog.')),
        cfg.IntOpt('heartbeat_interval',
                   default=10,
                   help='Seconds between conductor heart beats.'),
        cfg.IntOpt('heartbeat_timeout',
                   default=60,
-                   help='Maximum time since the last check-in of a conductor'),
+                   help='Maximum time (in seconds) since the last check-in '
+                        'of a conductor.'),
        cfg.IntOpt('sync_power_state_interval',
                   default=60,
                   help='Interval between syncing the node power state to the '
--- a/ironic/db/sqlalchemy/models.py
+++ b/ironic/db/sqlalchemy/models.py
@ -35,7 +35,7 @@ from ironic.openstack.common.db.sqlalchemy import models
 sql_opts = [
    cfg.StrOpt('mysql_engine',
               default='InnoDB',
-               help='MySQL engine')
+               help='MySQL engine to use.')
 ]

 cfg.CONF.register_opts(sql_opts, 'database')
--- a/ironic/drivers/modules/ipminative.py
+++ b/ironic/drivers/modules/ipminative.py
@ -33,7 +33,7 @@ from pyghmi.ipmi import command as ipmi_command
 opts = [
    cfg.IntOpt('retry_timeout',
               default=10,
-               help='Maximum time in seconds to retry IPMI operations'),
+               help='Maximum time in seconds to retry IPMI operations.'),
    ]

 CONF = cfg.CONF
--- a/ironic/drivers/modules/pxe.py
+++ b/ironic/drivers/modules/pxe.py
@ -45,26 +45,27 @@ from ironic.openstack.common import loopingcall
 pxe_opts = [
    cfg.StrOpt('pxe_append_params',
               default='nofb nomodeset vga=normal',
-               help='additional append parameters for baremetal PXE boot'),
+               help='Additional append parameters for baremetal PXE boot.'),
    cfg.StrOpt('pxe_config_template',
               default=paths.basedir_def(
                    'drivers/modules/pxe_config.template'),
-               help='Template file for PXE configuration'),
+               help='Template file for PXE configuration.'),
    cfg.StrOpt('tftp_server',
               default='$my_ip',
-               help='IP address of Ironic compute node\'s tftp server'),
+               help='IP address of Ironic compute node\'s tftp server.'),
    cfg.StrOpt('tftp_root',
               default='/tftpboot',
-               help='Ironic compute node\'s tftp root path'),
+               help='Ironic compute node\'s tftp root path.'),
    cfg.StrOpt('images_path',
               default='/var/lib/ironic/images/',
-               help='Directory where images are stored on disk'),
+               help='Directory where images are stored on disk.'),
    cfg.StrOpt('tftp_master_path',
               default='/tftpboot/master_images',
-               help='Directory where master tftp images are stored on disk'),
+               help='Directory where master tftp images are stored on disk.'),
    cfg.StrOpt('instance_master_path',
               default='/var/lib/ironic/master_images',
-               help='Directory where master tftp images are stored on disk'),
+               help='Directory where master instance images are stored on '
+                    'disk.'),
    # NOTE(dekehn): Additional boot files options may be created in the event
    #  other architectures require different boot files.
    cfg.StrOpt('pxe_bootfile_name',
--- a/ironic/netconf.py
+++ b/ironic/netconf.py
@ -45,10 +45,10 @@ def _get_my_ip():
 netconf_opts = [
    cfg.StrOpt('my_ip',
               default=_get_my_ip(),
-               help='ip address of this host'),
+               help='IP address of this host.'),
    cfg.BoolOpt('use_ipv6',
                default=False,
-                help='use ipv6'),
+                help='Use IPv6.'),
 ]

 CONF.register_opts(netconf_opts)
--- a/ironic/openstack/common/lockutils.py
+++ b/ironic/openstack/common/lockutils.py
@ -41,7 +41,7 @@ LOG = logging.getLogger(__name__)

 util_opts = [
    cfg.BoolOpt('disable_process_locking', default=False,
-                help='Whether to disable inter-process locks'),
+                help='Whether to disable inter-process locks.'),
    cfg.StrOpt('lock_path',
               default=os.environ.get("IRONIC_LOCK_PATH"),
               help=('Directory to use for lock files.'))
--- a/ironic/tests/base.py
+++ b/ironic/tests/base.py
@ -51,7 +51,7 @@ from ironic.tests import policy_fixture
 test_opts = [
    cfg.StrOpt('sqlite_clean_db',
               default='clean.sqlite',
-               help='File name of clean sqlite db'),
+               help='File name of clean sqlite db.'),
    ]

 CONF = cfg.CONF