Bug 1293555

Summary:	[GSS] 'rados' man page doesn't mention the 'listwatchers' switch
Product:	[Red Hat Storage] Red Hat Ceph Storage	Reporter:	Vimal Kumar <vikumar>
Component:	RADOS	Assignee:	Kefu Chai <kchai>
Status:	CLOSED ERRATA	QA Contact:	ceph-qe-bugs <ceph-qe-bugs>
Severity:	medium	Docs Contact:
Priority:	medium
Version:	1.3.0	CC:	ceph-eng-bugs, dzafman, flucifre, hnallurv, kchai, kdreyer, racpatel
Target Milestone:	rc
Target Release:	1.3.2
Hardware:	x86_64
OS:	Linux
Whiteboard:
Fixed In Version:	RHEL: ceph-0.94.5-1.el7cp Ubuntu: ceph_0.94.5-2redhat1	Doc Type:	Bug Fix
Doc Text:	Cause: The rados(8) man page did not include the listwatchers command. Consequence: As a result, users had to use the "--help" flag to discover the command. Fix: The rados(8) man page has been updated. Result: The rados man page and --help text both describe the command.	Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-02-29 14:44:37 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:

Description Vimal Kumar 2015-12-22 06:21:48 UTC

1) Description of problem:

The man page of 'rados' does not mention the 'listwatchers' switch. The '--help' switch of rados shows it though.

2) Version-Release number of selected component (if applicable):

RHCS1.3

ceph-0.94.1-13.el7cp

3) How reproducible:

Always

4) Steps to Reproduce:

'man rados' and search for 'listwatchers'.

5) Actual results:

'man rados' doesn't contain references to the 'listwatchers' switch.

6) Expected results:

The man page for rados should contain information on all the switches the binary supports.

Comment 2 Kefu Chai 2015-12-23 13:29:58 UTC

upstream pr https://github.com/ceph/ceph/pull/7021

Comment 3 Ken Dreyer (Red Hat) 2016-01-04 16:09:33 UTC

Thanks Kefu! That looks simple enough for us to take downstream in the next RHCS 1.3.2 re-spin.

Comment 4 Kefu Chai 2016-01-11 13:57:25 UTC

merged into master in upstream in as c2e391301efc43f0b431e89737246b2c43bf10a9

Comment 9 Rachana Patel 2016-01-25 15:07:32 UTC

working as expected for Ubuntu -  0.94.5-2redhat1trusty

Comment 10 Rachana Patel 2016-01-25 19:34:54 UTC

working as expected for -0.94.5-3.el7cp.x86_64, hence moving to verified.

Comment 11 Kefu Chai 2016-01-26 04:33:03 UTC

thanks Ken. we keep the rendered nroff manpages in the repo in hammer. and we are shipping the nroff manpages instead of their source files in the dist tarball. but since sometime before infernalis and after hammer's release, we removed the generated man pages from our git repo, and keep shipping the rendered man pages.

so this change only updates the reST source file unless it is backported to hammer.

but once jewel is released, we can drop your patch.

Comment 12 Ken Dreyer (Red Hat) 2016-01-29 18:56:33 UTC

Thanks Kefu!

For the record, https://github.com/ceph/ceph/pull/7434 was merged to hammer upstream so we're good now for future releases.

Comment 14 errata-xmlrpc 2016-02-29 14:44:37 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://access.redhat.com/errata/RHBA-2016:0313