cli: mention --profile in --config help text

It's easy for new users to confuse the "--config" and "--profile"
settings.

We want to guide users towards using non-default profile names (eg
"stream" or "cbs", etc) where possible. If a user is pointing at a
non-standard configuration file location, they should really use the
--profile option also to keep their configuration sane.

Update the --help text for the --config option to emphasize the
--profile option.
This commit is contained in:
Ken Dreyer 2021-09-28 10:36:18 -04:00 committed by Tomas Kopecek
parent a4f16fe1f0
commit 071533206e

View file

@ -118,8 +118,8 @@ def get_options():
parser.add_option("-p", "--profile", default=progname,
help="specify a configuration profile. default: %s" % progname)
parser.add_option("-c", "--config", dest="configFile",
help="load profile's settings from another file", metavar="FILE")
parser.add_option("--keytab", help="specify a Kerberos keytab to use", metavar="FILE")
help="load profile's settings from another file. Use with --profile.",
metavar="FILE")
parser.add_option("--principal", help="specify a Kerberos principal to use")
parser.add_option("--cert", help="specify a SSL cert to use", metavar="FILE")
parser.add_option("--runas", help="run as the specified user (requires special privileges)")