diff options
author | Petr Kovar <pkovar@redhat.com> | 2017-01-18 19:47:46 +0100 |
---|---|---|
committer | Petr Kovar <pkovar@redhat.com> | 2017-01-18 19:51:06 +0100 |
commit | b66ca10b85bbf2e626882a16f6778d4e0c5a9db2 (patch) | |
tree | 966a85b1f0a7187efa28a5fd73fe6d69c16a5e74 | |
parent | 5caeaf05d383016f6220a38e2694e8a3819c47a2 (diff) | |
download | python-barbicanclient-b66ca10b85bbf2e626882a16f6778d4e0c5a9db2.tar.gz |
Fix doc referencing --payload-content-type
Referencing --payload-content-type seems incorrect.
Also, fix trivial formatting and spelling issues.
Change-Id: I68984ce55c1e8882b80a20a6c17b258383225ff3
-rw-r--r-- | README.rst | 2 | ||||
-rw-r--r-- | barbicanclient/barbican_cli/cas.py | 2 | ||||
-rw-r--r-- | barbicanclient/barbican_cli/secrets.py | 6 | ||||
-rw-r--r-- | doc/source/cli_usage.rst | 15 |
4 files changed, 13 insertions, 12 deletions
@@ -176,7 +176,7 @@ usage options acl user add Add ACL users to a secret or container as identified by its href. acl user remove Remove ACL users from a secret or container as identified by its href. ca get Retrieve a CA by providing its URI. - ca list List cas. + ca list List CAs. complete print bash completion command secret container create Store a container in Barbican. secret container delete Delete a container by providing its href. diff --git a/barbicanclient/barbican_cli/cas.py b/barbicanclient/barbican_cli/cas.py index 6e8f338..79459a6 100644 --- a/barbicanclient/barbican_cli/cas.py +++ b/barbicanclient/barbican_cli/cas.py @@ -33,7 +33,7 @@ class GetCA(show.ShowOne): class ListCA(lister.Lister): - """List cas.""" + """List CAs.""" def get_parser(self, prog_name): parser = super(ListCA, self).get_parser(prog_name) diff --git a/barbicanclient/barbican_cli/secrets.py b/barbicanclient/barbican_cli/secrets.py index cce8009..8c23117 100644 --- a/barbicanclient/barbican_cli/secrets.py +++ b/barbicanclient/barbican_cli/secrets.py @@ -42,13 +42,13 @@ class GetSecret(show.ShowOne): help='if specified, retrieve the ' 'unencrypted secret data; ' 'the data type can be specified with ' - '--payload-content-type.', + '--payload_content_type.', action='store_true') parser.add_argument('--payload', '-p', help='if specified, retrieve the ' 'unencrypted secret data; ' 'the data type can be specified with ' - '--payload-content-type. If the user' + '--payload_content_type. If the user' ' wishes to only retrieve the value of' ' the payload they must add ' '"-f value" to format returning only' @@ -57,7 +57,7 @@ class GetSecret(show.ShowOne): parser.add_argument('--payload_content_type', '-t', default='text/plain', help='the content type of the decrypted' - ' secret (default: %(default)s.') + ' secret (default: %(default)s).') return parser def take_action(self, args): diff --git a/doc/source/cli_usage.rst b/doc/source/cli_usage.rst index e23692f..78eed1b 100644 --- a/doc/source/cli_usage.rst +++ b/doc/source/cli_usage.rst @@ -69,16 +69,17 @@ varies from one to another. The help message for **get** can be seen below. optional arguments: -h, --help show this help message and exit --decrypt, -d if specified, retrieve the unencrypted secret data; - the data type can be specified with --payload-content- - type. + the data type can be specified with + --payload_content_type. --payload, -p if specified, retrieve the unencrypted secret data; - the data type can be specified with --payload-content- - type. If the user wishes to only retrieve the value of - the payload they must add "-f value" to format - returning only the value of the payload + the data type can be specified with + --payload_content_type. If the user wishes to only + retrieve the value of the payload they must add + "-f value" to format returning only the value of + the payload --payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE the content type of the decrypted secret (default: - text/plain. + text/plain). output formatters: output formatter options |