Bug 904351
| Summary: | Provide keystone man page for the command line interface. | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Red Hat OpenStack | Reporter: | Stephen Gordon <sgordon> | ||||
| Component: | python-keystoneclient | Assignee: | Jakub Ruzicka <jruzicka> | ||||
| Status: | CLOSED ERRATA | QA Contact: | Martin Pavlásek <mpavlase> | ||||
| Severity: | low | Docs Contact: | |||||
| Priority: | medium | ||||||
| Version: | 2.1 | CC: | apevec, ayoung, jruzicka, markmc, mpavlase | ||||
| Target Milestone: | snapshot2 | Keywords: | Triaged | ||||
| Target Release: | 3.0 | ||||||
| Hardware: | Unspecified | ||||||
| OS: | Unspecified | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | python-keystoneclient-0.2.3-2.el6ost | Doc Type: | Bug Fix | ||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | 903322 | Environment: | |||||
| Last Closed: | 2013-06-12 16:42:52 UTC | Type: | Bug | ||||
| Regression: | --- | Mount Type: | --- | ||||
| Documentation: | --- | CRM: | |||||
| Verified Versions: | Category: | --- | |||||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |||||
| Cloudforms Team: | --- | Target Upstream Version: | |||||
| Embargoed: | |||||||
| Bug Depends On: | |||||||
| Bug Blocks: | 903322 | ||||||
| Attachments: |
|
||||||
|
Comment 1
Adam Young
2013-02-01 05:25:30 UTC
Started an upstream review on the master branch. https://review.openstack.org/20976 Work continues upstream to auto-generate man page from command line help (help2rst script), included here for the product is raw help2man generated manpage. Partialy ok: - there is no man page in python-keystoneclient-0.2.0-1.el6ost - man page is present in python-keystoneclient-0.2.0-4.el6ost Man pages corresponds with keystone help. Except that description of 'discover' action is not complete. Probably related to bug 888572. ------ snippet of `man keystone` user-update Update user’s name, email, and enabled status discover Discover Keystone servers and show authentication protocols and bootstrap Grants a new role to a new user on a new tenant, after creating each. ------ Compare with: ------ snippet of `keystone help` user-update Update user's name, email, and enabled status discover Discover Keystone servers, supported API versions and extensions. bootstrap Grants a new role to a new user on a new tenant, after creating each. ------ I see a keystone man page: [root@localhost ~]# rpm -ql python-keystoneclient | grep man /usr/share/man/man1/keystone.1.gz [root@localhost ~]# man keystone | head -1 KEYSTONE(1) User Commands KEYSTONE(1) Created attachment 753954 [details]
Screwed text in keystone manpage
The text in current manpage in python-keystoneclient-0.2.3-1.el6ost is really screwed up.
Lot of action/description pairs and whole lines are merged together to one big block of text. See the screenshot.
I replaced the broken help2man generated man page with a hand crafted one that is likely to be merged into upstream soon: https://bugs.launchpad.net/python-keystoneclient/+bug/1185142 Broken content in man pages has been fixed according to gerrit. I'd like to correct myself: The content has been sucessfully fixed in package python-keystoneclient-0.2.3-2.el6ost (as same as it is on gerrit #20976) Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. http://rhn.redhat.com/errata/RHSA-2013-0944.html |