Bug 1283372
| Summary: | oo-admin-gear man page displays wrong option | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Rory Thrasher <rthrashe> |
| Component: | Containers | Assignee: | Rory Thrasher <rthrashe> |
| Status: | CLOSED ERRATA | QA Contact: | Chao Yang <chaoyang> |
| Severity: | low | Docs Contact: | |
| Priority: | low | ||
| Version: | 2.2.0 | CC: | aos-bugs, gpei, jokerman, mmccomas |
| Target Milestone: | --- | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | openshift-origin-node-util-1.38.6.1-1.el6op | Doc Type: | Bug Fix |
| Doc Text: |
The man page for oo-admin-gear was incorrectly showing the short flag for --with-container-uuid as -u, which is incorrect and will not work. The man page was updated to correctly show that the short flag is -c.
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-03-22 16:53:03 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: | |||
Commits pushed to master at https://github.com/openshift/origin-server https://github.com/openshift/origin-server/commit/94be375c1a8061ab34af2165a29cfc8a06b704d9 man/oo-admin-gear.8: Fixes incorrect flag option Bug 1283372 BZ: https://bugzilla.redhat.com/show_bug.cgi?id=1283372 The man page for oo-admin-gear incorrectly stated that the short flag for --with-container-uuid was -u. Attempting to use -u will result in an error. The actual flag is -c, which is consistent with other oo-admin commands. Changes man page to show '-c' instead of the incorrect '-u'. https://github.com/openshift/origin-server/commit/cff40f974168c7c3bc6a27f51e46ead1acfb1ba5 Merge pull request #6322 from thrasher-redhat/bug1283372 Merged by openshift-bot QE,
Can we verify that the man page for oo-admin-gear now correctly has the "-c" steps
1. man oo-admin-gear
SYNOPSIS
oo-admin-gear {COMMAND} [--help|-h] [--version|-v] [--trace|-t] {--with-container-uuid|-c } gear uuid
Puddle: http://etherpad.corp.redhat.com/puddle-2-2-2016-02-19
Thank you
checked on openshift-origin-node-util-1.38.6.1-1.el6op.noarch
man oo-admin-gear
OO-ADMIN-GEAR(8) OpenShift Management Commands OO-ADMIN-GEAR(8)
NAME
oo-admin-gear - Administrative operations for OpenShift gears hosted on this node
SYNOPSIS
oo-admin-gear {COMMAND} [--help|-h] [--version|-v] [--trace|-t] {--with-container-uuid|-c } gear uuid
The --with-container-uuid is list with -c now.
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. https://rhn.redhat.com/errata/RHSA-2016-0489.html |
Description of problem: The man page for oo-admin-gear has the --with-container-uuid flag, with -u being the shortened flag. The command actually uses -c as the shortened version, as evidenced in the help output for oo-admin-gear How reproducible: 100% Steps to Reproduce: 1. man oo-admin-gear Actual results: SYNOPSIS oo-admin-gear {COMMAND} [--help|-h] [--version|-v] [--trace|-t] {--with-container-uuid|-u } gear uuid Expected results: SYNOPSIS oo-admin-gear {COMMAND} [--help|-h] [--version|-v] [--trace|-t] {--with-container-uuid|-c } gear uuid Additional info: