Bug 1283372 - oo-admin-gear man page displays wrong option
Summary: oo-admin-gear man page displays wrong option
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Containers
Version: 2.2.0
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: ---
Assignee: Rory Thrasher
QA Contact: Chao Yang
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-11-18 20:18 UTC by Rory Thrasher
Modified: 2016-03-22 16:53 UTC (History)
4 users (show)

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.
Clone Of:
Environment:
Last Closed: 2016-03-22 16:53:03 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHSA-2016:0489 0 normal SHIPPED_LIVE Important: Red Hat OpenShift Enterprise 2.2.9 security, bug fix, and enhancement update 2016-03-22 20:49:04 UTC

Description Rory Thrasher 2015-11-18 20:18:13 UTC
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:

Comment 1 openshift-github-bot 2015-11-24 17:57:23 UTC
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

Comment 4 Rory Thrasher 2016-02-22 22:30:00 UTC
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

Comment 5 Gaoyun Pei 2016-02-26 06:02:43 UTC
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.

Comment 7 errata-xmlrpc 2016-03-22 16:53:03 UTC
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


Note You need to log in before you can comment on or make changes to this bug.