Glance Client

missing CLI option help text

Bug #1531469 reported by Vincent Legoll
4
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Glance Client
Confirmed
Wishlist
Unassigned

Bug Description

Reading

http://docs.openstack.org/cli-reference/content/glanceclient_commands.html

it appears that some options are not fully documented, please fill them in...

--os-cert <certificate>

    Defaults to env[OS_CERT].
--os-key <key>

    Defaults to env[OS_KEY].

What are they doing, when should we use them ?

See original description
Revision history for this message
Cyril Roelandt (cyril-roelandt) wrote :

I believe this should be reported against python-glanceclient rather than glance.

affects: glance → python-glanceclient
Revision history for this message
Vincent Legoll (vincent-legoll) wrote :

Yep, sorry for the wrong assignment. Thanks for the clarification.

Mohammed Ashraf (mohammed-asharaf)
Changed in python-glanceclient:
assignee: nobody → Mohammed Ashraf (mohammed-asharaf)
Vincent Legoll (vincent-legoll)
description: updated
Bhargavi (challa-bhargavi1)
Changed in python-glanceclient:
assignee: Mohammed Ashraf (mohammed-asharaf) → Bhargavi (challa-bhargavi1)
Revision history for this message
Vincent Legoll (vincent-legoll) wrote :

The two options cited in the original bug reports are only examples of badly documented options, please review them all.

There are other ones that don't have any useful information in the help text either with a completely unhelpful text or with only the default value...

Only paraphrasing the option name with text is not any better than no help text:
--os-trust-id OS_TRUST_ID
    Trust ID
--os-user-id OS_USER_ID
    User ID

BTW, this doc:
http://docs.openstack.org/cli-reference/content/glanceclient_commands.html
And the CLI's --help output should stay in sync, or even better generate the html from the CLI's output.

First fix the CLI's help, then generate HTML doc from it.

Bhargavi (bhargavi-c81)
Changed in python-glanceclient:
assignee: Bhargavi (challa-bhargavi1) → Bhargavi (bhargavi-c81)
Revision history for this message
Ian Cordasco (icordasc) wrote :

Updated the link reference: http://docs.openstack.org/cli-reference/glance.html

Changed in python-glanceclient:
assignee: Bhargavi (bhargavi-c81) → nobody
importance: Undecided → Wishlist
status: New → Confirmed
Revision history for this message
Cyril Roelandt (cyril-roelandt) wrote :

See also https://bugs.launchpad.net/keystoneauth/+bug/1962037 which should fix a few of those.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.