openstack/python-keystoneclient
Code Issues Proposed changes

help text improvements

Browse Source 
from comments in Ibbc7fab2033d8f037262b465b98d1713579adfc2

v2: synced to the README
manpage will be updated in https://review.openstack.org/#/c/20976

Change-Id: I33006a4b935b9272fd99775936a17b3cfd08e294
This commit is contained in:
Alan Pevec 2013-02-16 23:28:05 +01:00
parent f46aea4e96
commit ae36809fde
2 changed files with 12 additions and 11 deletions
README.rst
keystoneclient
shell.py

12
README.rst

@ -153,7 +153,7 @@ You'll find complete documentation on the shell by running ``keystone help``::
subcommands. subcommands.
Optional arguments: Optional arguments:
--version show program's version number and exit --version Shows the client version and exits
--timeout <seconds> Set request timeout (in seconds) --timeout <seconds> Set request timeout (in seconds)
--os-username <auth-user-name> --os-username <auth-user-name>
Name used for authentication with the OpenStack Name used for authentication with the OpenStack
@ -192,11 +192,11 @@ You'll find complete documentation on the shell by running ``keystone help``::
--os-cert <certificate> --os-cert <certificate>
Defaults to env[OS_CERT] Defaults to env[OS_CERT]
--os-key <key> Defaults to env[OS_KEY] --os-key <key> Defaults to env[OS_KEY]
--os-cache Use the auth token cache. Default to env[OS_CACHE] --os-cache Use the auth token cache. Defaults to env[OS_CACHE]
--force-new-token If keyring is available and in used, token will always --force-new-token If the keyring is available and in use, token will
be stored and fetched from the keyring, until the always be stored and fetched from the keyring until
token has expired. Use this option to request a new the token has expired. Use this option to request a
token and replace the existing one in keyring. new token and replace the existing one in the keyring.
--stale-duration <seconds> --stale-duration <seconds>
Stale duration (in seconds) used to determine whether Stale duration (in seconds) used to determine whether
a token has expired when retrieving it from keyring. a token has expired when retrieving it from keyring.

11
keystoneclient/shell.py

@ -84,7 +84,8 @@ class OpenStackIdentityShell(object):
parser.add_argument('--version', parser.add_argument('--version',
action='version', action='version',
version=keystoneclient.__version__) version=keystoneclient.__version__,
help="Shows the client version and exits")
parser.add_argument('--debug', parser.add_argument('--debug',
default=False, default=False,
@ -208,7 +209,7 @@ class OpenStackIdentityShell(object):
default=env('OS_CACHE', default=False), default=env('OS_CACHE', default=False),
action='store_true', action='store_true',
help='Use the auth token cache. ' help='Use the auth token cache. '
'Default to env[OS_CACHE]') 'Defaults to env[OS_CACHE]')
parser.add_argument('--os_cache', parser.add_argument('--os_cache',
help=argparse.SUPPRESS) help=argparse.SUPPRESS)
@ -216,12 +217,12 @@ class OpenStackIdentityShell(object):
default=False, default=False,
action="store_true", action="store_true",
dest='force_new_token', dest='force_new_token',
help="If keyring is available and in used, " help="If the keyring is available and in use, "
"token will always be stored and fetched " "token will always be stored and fetched "
"from the keyring, until the token has " "from the keyring until the token has "
"expired. Use this option to request a " "expired. Use this option to request a "
"new token and replace the existing one " "new token and replace the existing one "
"in keyring.") "in the keyring.")
parser.add_argument('--stale-duration', parser.add_argument('--stale-duration',
metavar='<seconds>', metavar='<seconds>',