Bug 1376103 - pcs error reporting should be improved and reply shortened so admins don't have to scroll
Summary: pcs error reporting should be improved and reply shortened so admins don't ha...
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: pcs
Version: 7.3
Hardware: Unspecified
OS: Unspecified
medium
low
Target Milestone: rc
: ---
Assignee: Tomas Jelinek
QA Contact: cluster-qe@redhat.com
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-09-14 16:50 UTC by Jaroslav Kortus
Modified: 2020-12-15 07:45 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-12-15 07:45:46 UTC
Target Upstream Version:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1210844 0 low CLOSED [RFE] please offer more concise help/syntax reference 2021-02-22 00:41:40 UTC
Red Hat Bugzilla 1309643 0 low CLOSED not enough specific help for some cli subcommands 2021-02-22 00:41:40 UTC

Internal Links: 1210844 1309643

Description Jaroslav Kortus 2016-09-14 16:50:49 UTC
Description of problem:
[root@virt-247 ~]# pcs clsuter stop --all

Usage: pcs [-f file] [-h] [commands]...
Control and configure pacemaker and corosync.

Options:
    -h, --help  Display usage and exit.
    -f file     Perform actions on file instead of active CIB.
    --debug     Print all network traffic and external commands run.
    --version   Print pcs version information.

[... more text here ...]

The help does not actually help me. Message like "Invalid command. Use --help [command] to get detailed help" would be much more useful.

In this scenario I get bunch of unexpected text, have to scroll up to see if there was any error, none found, and then look through the command again to see the typo. Having only the short message would save me time. This is especially true for very long help texts (like pcs resource help).

I know we discussed it earlier that having detailed info (more "heuristics" involved in looking into what exactly was wrong and more detailed error message) would be beneficial, but even having the shorter version as described above would be a good start and could be much easier to do.

Version-Release number of selected component (if applicable):
pcs-0.9.152-8.el7.x86_64

How reproducible:
100%

Steps to Reproduce:
1. make typo in pcs commands ("pcs clufter stop" for instance ;)) 
2.
3.

Actual results:
long help text, lots of reading, no exact error message, angry admins

Expected results:
short error message, message only and not the whole help (it's getting bigger with every release), admins cursing only about their typing :)

Additional info:

Comment 4 RHEL Program Management 2020-12-15 07:45:46 UTC
After evaluating this issue, there are no plans to address it further or fix it in an upcoming release.  Therefore, it is being closed.  If plans change such that this issue will be fixed in an upcoming release, then the bug can be reopened.


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