Bug 623567 - man-page/--help inconsistency
man-page/--help inconsistency
Status: CLOSED ERRATA
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: fcoe-utils (Show other bugs)
6.0
All Linux
medium Severity medium
: rc
: ---
Assigned To: Petr Šabata
Miroslav Vadkerti
http://open-fcoe.org/openfc/bugzilla/...
: ManPageChange, Patch
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2010-08-12 03:42 EDT by Miroslav Vadkerti
Modified: 2011-05-19 10:20 EDT (History)
3 users (show)

See Also:
Fixed In Version: fcoe-utils-1.0.14-14.el6
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2011-05-19 10:20:13 EDT
Type: ---
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:


Attachments (Terms of Use)
fcnsq usage patch (467 bytes, patch)
2010-10-12 09:26 EDT, Petr Šabata
no flags Details | Diff

  None (edit)
Description Miroslav Vadkerti 2010-08-12 03:42:23 EDT
Description of problem:
I found come inconsistency issues with help vs man-page options in some fcoe-utils bins:


2 option(s) reported by the fcoeadm --help ONLY (not in man-page):
	--Scan
	-S

1 option(s) reported for fcnsq by the man page ONLY (not in --help):
	-q
(short option not mentioned in help)

Version-Release number of selected component (if applicable):
fcoe-utils-1.0.14-8.el6

How reproducible:
100%

Steps to Reproduce:
1. man fcoeadm; fcoeadm --help
3. man fcnsq; fcnsq --help
  
Actual results:
Inconsistency

Expected results:
Man page and --help consistent

Additional info:
Comment 1 Petr Šabata 2010-10-12 09:26:23 EDT
Created attachment 452964 [details]
fcnsq usage patch

Patch for the fcnsq usage (help) to show the short option for --quiet as well.
Comment 2 Petr Šabata 2010-11-18 08:43:32 EST
fcnsq fixed in CVS, fcoe-utils-1.0.14-10.el6
Comment 3 Miroslav Vadkerti 2011-01-21 01:29:41 EST
Petr, what about the -S/--Scan option. This is still not documented in the man page. I assume this is still not available from upstream. But I think we could come up with a documentation string.
Comment 4 Miroslav Vadkerti 2011-01-24 09:32:22 EST
Thanks to jzeleny for investigation. The -S option does this:
Validates that the interface name has an active fcoe session

Also --Scan option does not work. Please update the options struct to have this working. Thanks!
Comment 5 Petr Šabata 2011-01-24 09:57:40 EST
Fixed in CVS tag fcoe-utils-1.0.14-13.el6
Comment 6 Petr Pisar 2011-01-24 10:42:20 EST
doc/fcoeadm.8:
 -S, --Scan ethX
           Validates that the interface name has an active fcoe session.
                                                           ^^^^
The `fcoe' string should be written as `FCoE' as is done at other places of the manual.
Comment 7 Petr Šabata 2011-01-25 10:00:57 EST
Good point, Petr.
I updated the patch in fcoe-utils-1.0.14-14.el6
Comment 11 errata-xmlrpc 2011-05-19 10:20:13 EDT
An advisory has been issued which should help the problem
described in this bug report. This report is therefore being
closed with a resolution of ERRATA. For more information
on therefore solution and/or where to find the updated files,
please follow the link below. You may reopen this bug report
if the solution does not work for you.

http://rhn.redhat.com/errata/RHBA-2011-0743.html

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