Bug 977929

Summary:	broker-util scripts in need of manpages
Product:	OpenShift Online	Reporter:	Jason DeTiberus <jdetiber>
Component:	Pod	Assignee:	Lili Nader <lnader>
Status:	CLOSED CURRENTRELEASE	QA Contact:	libra bugs <libra-bugs>
Severity:	low	Docs Contact:
Priority:	unspecified
Version:	2.x	CC:	abhgupta, bleanhar, jdetiber, jhou, libra-onpremise-devel, lmeyer, lnader, mfisher
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:	973809	Environment:
Last Closed:	2014-01-24 03:33:33 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:	973809
Bug Blocks:

Description Jason DeTiberus 2013-06-25 15:26:43 UTC

+++ This bug was initially created as a clone of Bug #973809 +++

Description of problem:
oo-admin-clear-pending-ops is described internally but not documented for our users.

Expected results:
man oo-admin-clear-pending-ops should tell us how to use it and what it's for.
oo-admin-clear-pending-ops -h should tell us what it's for.

Might be a good idea to mention it in the Troubleshooting Guide too.

--- Additional comment from Jason DeTiberus on 2013-06-25 11:25:48 EDT ---

All broker-util scripts in need of manpages:
  /usr/sbin/oo-admin-clear-pending-ops
  /usr/sbin/oo-admin-ctl-authorization
  /usr/sbin/oo-analytics-export
  /usr/sbin/oo-analytics-import

Comment 1 Lili Nader 2013-11-04 23:54:38 UTC

This has already been fixed by lmeyer

Comment 2 Luke Meyer 2013-11-06 05:15:32 UTC

pending ops has a man page. Not the rest.

[root@broker ~]# man oo-admin-ctl-authorization
No manual entry for oo-admin-ctl-authorization
[root@broker ~]# man oo-analytics-export
No manual entry for oo-analytics-export
[root@broker ~]# man oo-analytics-import
No manual entry for oo-analytics-import

Comment 3 Abhishek Gupta 2013-11-13 17:50:16 UTC

*** Bug 1008563 has been marked as a duplicate of this bug. ***

Comment 4 Brenton Leanhardt 2013-11-18 19:48:11 UTC

The currently missing man pages for openshift-origin-broker-util are:

  /usr/sbin/oo-admin-ctl-authorization
  /usr/sbin/oo-admin-upgrade
  /usr/sbin/oo-analytics-export
  /usr/sbin/oo-analytics-import
  /usr/sbin/oo-quarantine

Comment 5 Lili Nader 2013-11-26 00:42:20 UTC

Added for man pages for oo-admin-ctl-authorization, oo-analytics-export, oo-analytics-import

https://github.com/openshift/origin-server/pull/4251

Comment 6 Lili Nader 2013-11-26 00:43:27 UTC

QE - please create separate bugs for the other scripts.  Otherwise this bug will never be resolved...if people keep adding to it.

Comment 7 Jianwei Hou 2013-11-26 06:05:10 UTC

Opened bug 1034554 and bug 1034555 as separate issue tracker.

Comment 8 openshift-github-bot 2013-11-26 09:06:37 UTC

Commit pushed to master at https://github.com/openshift/origin-server

https://github.com/openshift/origin-server/commit/b05b2be2c2f4683efc807d576c690dc80c8252a1
Bug 977929

Comment 9 Jianwei Hou 2013-11-27 02:59:02 UTC

Verified on devenv_4076
oo-admin-ctl-authorization, oo-analytics-export, oo-analytics-import now has man pages, the rest admin tools will be tracked separately.