Clean up keystone-all.rst

This change fixes warnings and errors from
doc/source/man/keystone-all.rst when generating documentation.

Change-Id: Ie33b2600f28c517644730b2371ce34ca2e73b7a5
This commit is contained in:
Brant Knudson 2013-05-22 17:09:09 -05:00 committed by Gerrit Code Review
parent 600c38bae5
commit 793b8eba9d
2 changed files with 33 additions and 26 deletions

View File

@ -16,6 +16,8 @@ Keystone Startup Command
SYNOPSIS SYNOPSIS
======== ========
::
keystone-all [-h] [--version] [--pydev-debug-port PYDEV_DEBUG_PORT] keystone-all [-h] [--version] [--pydev-debug-port PYDEV_DEBUG_PORT]
[--verbose] [--noverbose] [--config-dir DIR] [--verbose] [--noverbose] [--config-dir DIR]
[--log-config PATH] [--log-date-format DATE_FORMAT] [--log-config PATH] [--log-date-format DATE_FORMAT]
@ -38,44 +40,46 @@ OPTIONS
-h, --help show this help message and exit -h, --help show this help message and exit
--version show program's version number and exit --version show program's version number and exit
--pydev-debug-port PYDEV_DEBUG_PORT --debug, -d Print debugging output (set logging level to DEBUG
instead of default WARNING level).
--nodebug The inverse of --debug
--verbose, -v Print more verbose output (set logging level to INFO --verbose, -v Print more verbose output (set logging level to INFO
instead of default WARNING level). instead of default WARNING level).
--noverbose The inverse of --verbose --noverbose The inverse of --verbose
--config-dir DIR Path to a config directory to pull *.conf files from. --use-syslog Use syslog for logging.
This file set is sorted, so as to provide a --nouse-syslog The inverse of --use-syslog
predictable parse order if individual options are --standard-threads Do not monkey-patch threading system modules.
over-ridden. The set is parsed after the file(s), if --nostandard-threads The inverse of --standard-threads
any, specified via --config-file, hence over-ridden --pydev-debug-port PYDEV_DEBUG_PORT
options in the directory take precedence. Port to connect to for remote debugger.
--config-file PATH Path to a config file to use. Multiple config files
can be specified, with values in later files taking
precedence. The default files used are:
['/etc/keystone/keystone.conf']
--log-config PATH If this option is specified, the logging configuration --log-config PATH If this option is specified, the logging configuration
file specified is used and overrides any other logging file specified is used and overrides any other logging
options specified. Please see the Python logging options specified. Please see the Python logging
module documentation for details on logging module documentation for details on logging
configuration files. configuration files.
--log-format FORMAT A logging.Formatter log message format string which
may use any of the available logging.LogRecord
attributes.
--log-date-format DATE_FORMAT --log-date-format DATE_FORMAT
Format string for %(asctime)s in log records. Format string for %(asctime)s in log records.
--use-syslog Use syslog for logging. --log-file PATH Name of log file to output. If not set, logging will
--nouse-syslog The inverse of --use-syslog go to stdout.
--log-dir LOG_DIR The directory in which to store log files. (will be --log-dir LOG_DIR The directory in which to store log files. (will be
prepended to --log-file) prepended to --log-file)
--syslog-log-facility SYSLOG_LOG_FACILITY --syslog-log-facility SYSLOG_LOG_FACILITY
syslog facility to receive log lines. syslog facility to receive log lines.
--standard-threads
--nostandard-threads The inverse of --standard-threads
--config-file PATH Path to a config file to use. Multiple config files
can be specified, with values in later files taking
precedence. The default files used are:
['/etc/keystone/keystone.conf']
--pydev-debug-host PYDEV_DEBUG_HOST --pydev-debug-host PYDEV_DEBUG_HOST
--debug, -d Print debugging output (set logging level to DEBUG Host to connect to for remote debugger.
instead of default WARNING level). --config-dir DIR Path to a config directory to pull \*.conf files from.
--nodebug The inverse of --debug This file set is sorted, so as to provide a
--log-format FORMAT A logging.Formatter log message format string which predictable parse order if individual options are
may use any of the available logging.LogRecord over-ridden. The set is parsed after the file(s), if
attributes. any, specified via --config-file, hence over-ridden
--log-file PATH Name of log file to output. If not set, logging will options in the directory take precedence.
go to stdout.
FILES FILES
===== =====

View File

@ -179,10 +179,13 @@ def configure():
CONF.register_cli_opts(COMMON_CLI_OPTS) CONF.register_cli_opts(COMMON_CLI_OPTS)
CONF.register_cli_opts(LOGGING_CLI_OPTS) CONF.register_cli_opts(LOGGING_CLI_OPTS)
register_cli_bool('standard-threads', default=False) register_cli_bool('standard-threads', default=False,
help='Do not monkey-patch threading system modules.')
register_cli_str('pydev-debug-host', default=None) register_cli_str('pydev-debug-host', default=None,
register_cli_int('pydev-debug-port', default=None) help='Host to connect to for remote debugger.')
register_cli_int('pydev-debug-port', default=None,
help='Port to connect to for remote debugger.')
register_str('admin_token', secret=True, default='ADMIN') register_str('admin_token', secret=True, default='ADMIN')
register_str('bind_host', default='0.0.0.0') register_str('bind_host', default='0.0.0.0')