diff options
| author | Pádraig Brady <pbrady@redhat.com> | 2013-03-20 11:03:16 +0000 |
|---|---|---|
| committer | Pádraig Brady <pbrady@redhat.com> | 2013-03-20 11:26:59 +0000 |
| commit | 1220b210c42b8feb2d0012d6ceadfea884405edb (patch) | |
| tree | 201000974e31920a471954a0a59978bde3e20ab2 /openstack/common | |
| parent | 65e3d8c9773880094c0a4c164e046fae9cb7a5d9 (diff) | |
| download | oslo-1220b210c42b8feb2d0012d6ceadfea884405edb.tar.gz oslo-1220b210c42b8feb2d0012d6ceadfea884405edb.tar.xz oslo-1220b210c42b8feb2d0012d6ceadfea884405edb.zip | |
clarify --log-file comments
Clarify that --log-dir is only applicable for
relative --log-file paths.
Also change the description of --log-file, to be less specific.
By changing "If not set" to "If no default is set", it
allows for a better description given the cumulative nature of
these config settings. Distributors can use this for example
to set a default in a distribution wide config file that is
then indicated by a commented default in a user editable file.
I.E. the following config file is now more accurate:
# Name of log file to output to.
# If no default is set, logging will go to stdout.
# log_file = /some/dist/default/set/elsewhere.conf
Change-Id: I9a39511b6d6cfff907471ab7a6f31c34592a1015
Diffstat (limited to 'openstack/common')
| -rw-r--r-- | openstack/common/log.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/openstack/common/log.py b/openstack/common/log.py index 59df758..6315c56 100644 --- a/openstack/common/log.py +++ b/openstack/common/log.py @@ -87,11 +87,11 @@ logging_cli_opts = [ metavar='PATH', deprecated_name='logfile', help='(Optional) Name of log file to output to. ' - 'If not set, logging will go to stdout.'), + 'If no default is set, logging will go to stdout.'), cfg.StrOpt('log-dir', deprecated_name='logdir', - help='(Optional) The directory to keep log files in ' - '(will be prepended to --log-file)'), + help='(Optional) The base directory used for relative ' + '--log-file paths'), cfg.BoolOpt('use-syslog', default=False, help='Use syslog for logging.'), |