Bug 1348528 - different content of man page and help message
Summary: different content of man page and help message
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Ceph Storage
Classification: Red Hat Storage
Component: Ceph-Installer
Version: 3.0
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: rc
: 3.1
Assignee: Christina Meno
QA Contact: ceph-qe-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-06-21 11:46 UTC by Martin Kudlej
Modified: 2018-02-20 12:20 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-02-20 12:20:22 UTC
Embargoed:


Attachments (Terms of Use)

Description Martin Kudlej 2016-06-21 11:46:56 UTC
Description of problem:
man page content:
CEPH-INSTALLER(8)                                                                                                                                                       CEPH-INSTALLER(8)

NAME
       ceph-installer - Command line utility to install and configure Ceph using an HTTP REST API

GLOBAL OPTIONS
       -h, --help, help    Show this program's help menu

       --log, --logging
              Set the level of logging. Acceptable values: debug, warning, error, critical

ENVIRONMENT VARIABLES
       CEPH_INSTALLER_ADDRESS
              Define the location of the installer.

              Defaults to "http://localhost:8181"

COMMANDS
   task
       Human-readable task information: stdout, stderr, and the ability to "poll" a task that waits until the command completes to be able to show the output in a readable way.

       Usage:

          ceph-installer task $IDENTIFIER

       Options:

          --poll        Poll until the task has completed (either on failure or success)
           stdout        Retrieve the stdout output from the task
           stderr        Retrieve the stderr output from the task
           command       The actual command used to call ansible
           ended         The timestamp (in UTC) when the command completed
           started       The timestamp (in UTC) when the command started
           exit_code     The shell exit status for the process
           succeeded     Boolean value to indicate if process completed correctly

   dev
       Deploying the ceph-installer HTTP service to a remote server with ansible.  This command wraps ansible and certain flags to make it easier to deploy a development version.

       Usage:

          ceph-installer dev $HOST

       Note: Requires a remote user with passwordless sudo. User defaults to "vagrant".

       Options:

       --user Define a user to connect to the remote server. Defaults  to 'vagrant'

       --branch
              What branch to use for the deployment. Defaults to 'master'

       -vvvv  Enable high verbosity when running ansible


help message content:
A command line utility to install and configure Ceph using an HTTP API as a REST service
to call Ansible.

Address: http://localhost:8181/
Version: 1.0.11

Global Options:
-h, --help, help    Show this program's help menu
--log, --logging    Set the level of logging. Acceptable values:
                    debug, warning, error, critical

Environment Variables:
CEPH_INSTALLER_ADDRESS    Define the location of the installer.
                          Defaults to "http://localhost:8181"

Available subcommands:

task                     /api/tasks/ operations
dev                      Development options




Version-Release number of selected component (if applicable):
ceph-installer-1.0.11-1.el7scon.noarch

How reproducible:
100%


Expected results:
I think there should be note in help message that more info can be found in man page OR there should be at least task command options in help mesage OR man page and help message should be the same.

Comment 2 Ken Dreyer (Red Hat) 2016-09-23 21:00:59 UTC
I wonder if we should rename this utility "ceph-installer-troubleshooter". The name is awfully generic and we don't expect users to run this unless there are problems.


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