openstack/keystone
Code Issues Proposed changes

Cleaned up keystone-all --help output

Browse Source 
- Added a missing space: mayuse -> may use
- Removed default values from help messages, which were appearing as
  None, and should be added by argparse anyway
- Updated man pages

Change-Id: I471a1aaff40398488e19f91a16bd91d2d17db61d
This commit is contained in:
Dolph Mathews 2013-02-11 16:09:08 -06:00
parent 43ec45049f
commit 83e989fa35
3 changed files with 73 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
doc/source/man/keystone-all.rst
View File

@ -16,7 +16,15 @@ Keystone Startup Command
SYNOPSIS SYNOPSIS
======== ========
keystone-all [options] keystone-all [-h] [--version] [--pydev-debug-port PYDEV_DEBUG_PORT]
[--verbose] [--noverbose] [--config-dir DIR]
[--log-config PATH] [--log-date-format DATE_FORMAT]
[--use-syslog] [--nouse-syslog] [--log-dir LOG_DIR]
[--syslog-log-facility SYSLOG_LOG_FACILITY]
[--standard-threads] [--nostandard-threads]
[--config-file PATH] [--pydev-debug-host PYDEV_DEBUG_HOST]
[--debug] [--nodebug] [--log-format FORMAT]
[--log-file PATH]
DESCRIPTION DESCRIPTION
=========== ===========
@ -29,40 +37,45 @@ OPTIONS
======= =======
-h, --help show this help message and exit -h, --help show this help message and exit
--config-file=PATH Path to a config file to use. Multiple config files --version show program's version number and exit
can be specified, with values in later files taking --pydev-debug-port PYDEV_DEBUG_PORT
precedence. The default files used are: --verbose, -v Print more verbose output (set logging level to INFO
['/etc/keystone/keystone.conf'] instead of default WARNING level).
--config-dir=DIR Path to a config directory to pull *.conf files from. --noverbose The inverse of --verbose
--config-dir DIR Path to a config directory to pull *.conf files from.
This file set is sorted, so as to provide a This file set is sorted, so as to provide a
predictable parse order if individual options are predictable parse order if individual options are
over-ridden. The set is parsed after the file(s), if over-ridden. The set is parsed after the file(s), if
any, specified via --config-file, hence over-ridden any, specified via --config-file, hence over-ridden
options in the directory take precedence. options in the directory take precedence.
-d, --debug Print debugging output --log-config PATH If this option is specified, the logging configuration
--nodebug The inverse of --debug
-v, --verbose Print more verbose output
--noverbose The inverse of --verbose
--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 --log-date-format DATE_FORMAT
may use any of the available logging.LogRecord Format string for %(asctime)s in log records.
attributes. Default: none
--log-date-format=DATE_FORMAT
Format string for %(asctime)s in log records. Default:
none
--log-file=PATH (Optional) Name of log file to output to. If not set,
logging will go to stdout.
--log-dir=LOG_DIR (Optional) The directory to keep log files in (will be
prepended to --logfile)
--syslog-log-facility=SYSLOG_LOG_FACILITY
(Optional) The syslog facility to use when logging to
syslog (defaults to LOG_USER)
--use-syslog Use syslog for logging. --use-syslog Use syslog for logging.
--nouse-syslog The inverse of --use-syslog --nouse-syslog The inverse of --use-syslog
--log-dir LOG_DIR The directory in which to store log files. (will be
prepended to --log-file)
--syslog-log-facility SYSLOG_LOG_FACILITY
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
--debug, -d Print debugging output (set logging level to DEBUG
instead of default WARNING level).
--nodebug The inverse of --debug
--log-format FORMAT A logging.Formatter log message format string which
may use any of the available logging.LogRecord
attributes.
--log-file PATH Name of log file to output. If not set, logging will
go to stdout.
FILES FILES
===== =====

53
doc/source/man/keystone-manage.rst
View File

@ -53,41 +53,46 @@ Available commands:
OPTIONS OPTIONS
======= =======
Options:
-h, --help show this help message and exit -h, --help show this help message and exit
--config-file=PATH Path to a config file to use. Multiple config files --version show program's version number and exit
can be specified, with values in later files taking --pydev-debug-port PYDEV_DEBUG_PORT
precedence. The default files used are: [] --verbose, -v Print more verbose output (set logging level to INFO
--config-dir=DIR Path to a config directory to pull *.conf files from. instead of default WARNING level).
--noverbose The inverse of --verbose
--config-dir DIR Path to a config directory to pull *.conf files from.
This file set is sorted, so as to provide a This file set is sorted, so as to provide a
predictable parse order if individual options are predictable parse order if individual options are
over-ridden. The set is parsed after the file(s), if over-ridden. The set is parsed after the file(s), if
any, specified via --config-file, hence over-ridden any, specified via --config-file, hence over-ridden
options in the directory take precedence. options in the directory take precedence.
-d, --debug Print debugging output --log-config PATH If this option is specified, the logging configuration
--nodebug The inverse of --debug
-v, --verbose Print more verbose output
--noverbose The inverse of --verbose
--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 --log-date-format DATE_FORMAT
may use any of the available logging.LogRecord Format string for %(asctime)s in log records.
attributes. Default: none
--log-date-format=DATE_FORMAT
Format string for %(asctime)s in log records. Default:
none
--log-file=PATH (Optional) Name of log file to output to. If not set,
logging will go to stdout.
--log-dir=LOG_DIR (Optional) The directory to keep log files in (will be
prepended to --logfile)
--syslog-log-facility=SYSLOG_LOG_FACILITY
(Optional) The syslog facility to use when logging to
syslog (defaults to LOG_USER)
--use-syslog Use syslog for logging. --use-syslog Use syslog for logging.
--nouse-syslog The inverse of --use-syslog. --nouse-syslog The inverse of --use-syslog
--log-dir LOG_DIR The directory in which to store log files. (will be
prepended to --log-file)
--syslog-log-facility SYSLOG_LOG_FACILITY
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
--debug, -d Print debugging output (set logging level to DEBUG
instead of default WARNING level).
--nodebug The inverse of --debug
--log-format FORMAT A logging.Formatter log message format string which
may use any of the available logging.LogRecord
attributes.
--log-file PATH Name of log file to output. If not set, logging will
go to stdout.
FILES FILES
===== =====

16
keystone/config.py
View File

@ -51,27 +51,25 @@ logging_cli_opts = [
cfg.StrOpt('log-format', cfg.StrOpt('log-format',
default=_DEFAULT_LOG_FORMAT, default=_DEFAULT_LOG_FORMAT,
metavar='FORMAT', metavar='FORMAT',
help='A logging.Formatter log message format string which may' help='A logging.Formatter log message format string which may '
'use any of the available logging.LogRecord attributes. ' 'use any of the available logging.LogRecord attributes.'),
'Default: %(default)s'),
cfg.StrOpt('log-date-format', cfg.StrOpt('log-date-format',
default=_DEFAULT_LOG_DATE_FORMAT, default=_DEFAULT_LOG_DATE_FORMAT,
metavar='DATE_FORMAT', metavar='DATE_FORMAT',
help='Format string for %%(asctime)s in log records. ' help='Format string for %%(asctime)s in log records.'),
'Default: %(default)s'),
cfg.StrOpt('log-file', cfg.StrOpt('log-file',
metavar='PATH', metavar='PATH',
help='(Optional) Name of log file to output to. ' help='Name of log file to output. '
'If not set, logging will go to stdout.'), 'If not set, logging will go to stdout.'),
cfg.StrOpt('log-dir', cfg.StrOpt('log-dir',
help='(Optional) The directory to keep log files in ' help='The directory in which to store log files. '
'(will be prepended to --logfile)'), '(will be prepended to --log-file)'),
cfg.BoolOpt('use-syslog', cfg.BoolOpt('use-syslog',
default=False, default=False,
help='Use syslog for logging.'), help='Use syslog for logging.'),
cfg.StrOpt('syslog-log-facility', cfg.StrOpt('syslog-log-facility',
default='LOG_USER', default='LOG_USER',
help='syslog facility to receive log lines') help='syslog facility to receive log lines.')
] ]
CONF = cfg.CONF CONF = cfg.CONF