Documentation #3396
closedceph - man page - comprehensive options/switches
0%
Description
I have some 2 cents/suggestions with regards to the man page of "ceph":
" ie: CEPH
NAME
ceph - ceph file system control utility"
Noticed that it only documents a subset of what the ceph CLI command can do; it would be great to have the man page output all of its options (switches), parameters (arguments), that way it will be in a single/central place. (In parallel, having a MAN Page section in CEPH docs would also be good - similar to industry standard documentations that would have man CLI pages be available in the Admin Guides (as in Appendices sections).
For instance, in the man page, there are quite a few stuff missing, such as ceph auth list; Although there is a section that points out MONITOR Commands and then displays a URL that points to the Ceph Monitor Commands:
"MONITOR COMMANDS
A more complete summary of commands understood by the monitor cluster can be found in the wiki, at
http://ceph.newdream.net/wiki/Monitor_commands"
Instead of having user hop from one source to another, would be great to have a comprehensive list of what the ceph control utility can do in the man page display.
Updated by Zac Dover over 4 years ago
- Status changed from New to Closed
This bug has been judged too old to fix. This is because either it is either
1) raised against a version of Ceph prior to Luminous, or
2) just really old, and untouched for so long that it is unlikely nowadays to represent a live documentation concern.
If you think that the closing of this bug is an error, raise another bug of a similar kind. If you think that the matter requires urgent attention, please let Zac Dover know at zac.dover@gmail.com.