Bug 1494639
| Summary: | Remove documentation for removed vdo command options. | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | Red Hat Enterprise Linux 7 | Reporter: | Joe Shimkus <jshimkus> | ||||||
| Component: | doc-Storage_Administration_Guide | Assignee: | Marek Suchánek <msuchane> | ||||||
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Zhang Kexin <kzhang> | ||||||
| Severity: | unspecified | Docs Contact: | |||||||
| Priority: | unspecified | ||||||||
| Version: | 7.5 | CC: | jshimkus, rhel-docs | ||||||
| Target Milestone: | rc | Keywords: | Documentation | ||||||
| Target Release: | --- | ||||||||
| Hardware: | Unspecified | ||||||||
| OS: | Unspecified | ||||||||
| Whiteboard: | |||||||||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |||||||
| Doc Text: | Story Points: | --- | |||||||
| Clone Of: | Environment: | ||||||||
| Last Closed: | 2018-08-10 18:25:15 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: | 1495322, 1552784 | ||||||||
| Attachments: |
|
||||||||
Additional options have been removed from the vdo management command (vdo): --customFile --initializeBlockMap References to these should be removed from the documentation. Note that, for --initializeBlockMap, this change supersedes that described in Bugzilla #1494645. Further options that have been removed from the vdo management command (vdo). Any references in Bugzilla prior to the date of this comment are superseded. --albireoIndexDir --albireoSize --lvIndex --lvVdo --vdoPhysicalSize --address Thanks. I'm setting this bug as a blocker for the VDO docs tracking bug. All the options listed in previous comments should now be deleted from the VDO Integration Guide. Preview of the documentation: https://access.qa.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html-single/storage_administration_guide/#VDO-integration Joe, can you please check that the documentation lists no other removed options? Created attachment 1392158 [details]
vdo man page
Resulting from qa requests the format of the vdo command has changed. Additionally, "Section 29.7.1 vdo" does not list some of the commands that are provided by vdo. I have attached a .pdf of the man page generated for vdo as a reference. There are some additional issues with individual commands; e.g., the --activate option for create takes a value (enabled | disabled) rather than being a boolean. Also, --device and --indexMem are missing from create's description. The enable/disable commands have been renamed as activate/deactivate. The status command is missing --verbose. As painful as it might be, I'm going to suggest going through the .pdf I attached and cross-referencing or (maybe) copy-paste. :-) Created attachment 1392199 [details]
vdostats man page
Adding the vdostats man page as additional reference.
Thanks for the comments; I'm fixing the issues right now. Our general rule in cases like this is to keep references like section 29.7 just in man pages to avoid duplication. I'm fine with keeping the reference up to date until all the information has been included in the man page, but after that, it would be much more maintainable to rely just on the man page and delete 29.7. Do you think we could eventually do that? In other words, how complete is the man page now? It looks pretty comprehensive to me. Of course, it's still important to fix the command and option names because of other parts of the documentation that reference them. The man pages are (barring oversight) complete. So, relying on the man page would be reasonable. That's great to hear. I'm going to discuss with Andy Walsh if/when we can remove the reference. I'm keeping it in place until then. I've compared the commands reference section with what's in the man page on my RHEL 7.5 and fixed a couple of inconsistencies. See the following commit for details: https://gitlab.cee.redhat.com/red-hat-enterprise-linux-documentation/doc-Red_Hat_Enterprise_Linux-7-Storage_Administration_Guide/commit/bc066f775df71e477c42ac9ce83f14bd00ce31ca I think I can close this bug now. You can find the published content here: https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/storage_administration_guide/vdo-ig-commands |
Describe the issue: Changes to the vdo management command (vdo) include the removal of the following command options: --albireoBinaryPath --mdRaid5Mode --port --upgrade --syslog Suggestions for improvement: References to and descriptions of the affected options should be removed from the documentation.