Bug 1184499 - Ceph man page is out of sync with actual command options
Summary: Ceph man page is out of sync with actual command options
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Ceph Storage
Classification: Red Hat Storage
Component: RADOS
Version: 1.2.2
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: pre-dev-freeze
: 1.2.4
Assignee: Ken Dreyer (Red Hat)
QA Contact: Tamil
URL:
Whiteboard:
Depends On: 1271774
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-01-21 14:48 UTC by Brad Hubbard
Modified: 2017-07-30 15:12 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-12-08 16:35:52 UTC
Embargoed:


Attachments (Terms of Use)
ceph -h output on firefly (17.50 KB, text/plain)
2015-01-28 22:26 UTC, David Zafman
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Ceph Project Bug Tracker 10676 0 None None None Never

Description Brad Hubbard 2015-01-21 14:48:15 UTC
Description of problem:

Running "ceph -h" shows several options for ceph, such as "-s" for status, which are not documented in the man page.

Version-Release number of selected component (if applicable):
ceph-0.80.6-0.el7.centos.x86_64

Comment 1 David Zafman 2015-01-28 22:26:54 UTC
Created attachment 985389 [details]
ceph -h output on firefly

Comment 2 David Zafman 2015-01-28 22:31:35 UTC
I created a pull request for firefly with cherry picked man page changes which don't appear to include any newer changes.

Pull request #3521
Backport doc fixes that appear to apply to firefly
https://github.com/ceph/ceph/pull/3521

Nilamdyuti Goswami could you go over the documentation and compare with the ceph -h output attached to this bug.

Comment 3 Nilamdyuti 2015-01-29 09:48:49 UTC
(In reply to Brad Hubbard from comment #0)
> Description of problem:
> 
> Running "ceph -h" shows several options for ceph, such as "-s" for status,
> which are not documented in the man page.
> 
> Version-Release number of selected component (if applicable):
> ceph-0.80.6-0.el7.centos.x86_64

The initial man page for Ceph was in a rudimentary stage and there was no description for it's commands. When I updated the man page based on the output of "ceph -h", I did it for ceph-0.87 which was merged to master and can be found here http://docs.ceph.com/docs/master/man/8/ceph/

It has everything from the output of "ceph -h" including "-s" for status. I have two Ceph clusters deployed in my machine using RHEL7 nodes, one with version 0.80 and other one with version 0.87. Both of them give the same output for "ceph -h".

The reason output of "ceph -h" command in your ceph-0.80.6-0.el7.centos.x86_64 cluster is different from "man ceph" is probably because the updated ceph man page hasn't been included in "ceph-common" package neither for master nor for firefly.

Comment 4 Nilamdyuti 2015-01-29 10:04:42 UTC
(In reply to David Zafman from comment #2)
> I created a pull request for firefly with cherry picked man page changes
> which don't appear to include any newer changes.
> 
> Pull request #3521
> Backport doc fixes that appear to apply to firefly
> https://github.com/ceph/ceph/pull/3521
> 
> Nilamdyuti Goswami could you go over the documentation and compare with the
> ceph -h output attached to this bug.

I compared the documentation with the attached output, both have the same contents. I also checked again by taking a output of "ceph -h" in my ceph-0.80 cluster and found it to be the same as in master.

If you are back porting the changes in master to firefly, kindly use the commits from https://github.com/ceph/ceph/pull/3201 as it has better style formatting for improved readability.

Comment 5 Federico Lucifredi 2015-03-27 00:43:02 UTC
Please confirm this is resolved.

Comment 6 Federico Lucifredi 2015-03-27 00:43:25 UTC
Please confirm this is resolved, and close the bug.

Comment 7 David Zafman 2015-03-27 01:28:47 UTC
Tracker 10676 marked resolved.

This should be part of the next Firefly point release v0.80.10

Closing this bug.

Comment 12 Ian Colle 2015-03-27 05:21:43 UTC
Reopening until patch is downstream.

Comment 13 Nilamdyuti 2015-03-27 09:04:19 UTC
(In reply to Federico Lucifredi from comment #6)
> Please confirm this is resolved, and close the bug.

As said by David and Brad in their comments, this will be resolved in the next downstream release i.e, v1.2.4 (v0.80.10 upstream).

Comment 14 Federico Lucifredi 2015-03-27 16:37:06 UTC
Understood. Flagging 1.3 as well, as that will ship first.

Comment 17 Ken Dreyer (Red Hat) 2015-10-19 20:39:45 UTC
The fixed man page shipped in Ceph v0.80.10 upstream, so we'll take in in as part of the RHCS 1.2 rebase to Ceph v0.80.11 (bz 1271774)

Comment 18 Ken Dreyer (Red Hat) 2015-12-08 16:35:52 UTC
Closing all RHCS 1.2 bugs, since we are not planning to do a formal RHCS 1.2.4 release.

This particular issue was already fixed in the initial RHCS 1.3.0 release.


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