From 1220b210c42b8feb2d0012d6ceadfea884405edb Mon Sep 17 00:00:00 2001 From: Pádraig Brady Date: Wed, 20 Mar 2013 11:03:16 +0000 Subject: 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 --- openstack/common/log.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'openstack') 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.'), -- cgit