Bug 604045 - Report command line options badly documented
Report command line options badly documented
Status: CLOSED CURRENTRELEASE
Product: Red Hat Enterprise Linux 6
Classification: Red Hat
Component: report (Show other bugs)
6.0
All Linux
low Severity medium
: rc
: ---
Assigned To: Gavin Romig-Koch
David Kutálek
: Documentation
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2010-06-15 05:24 EDT by David Kutálek
Modified: 2010-11-10 16:29 EST (History)
1 user (show)

See Also:
Fixed In Version: report-0.16-1
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2010-11-10 16:29:34 EST
Type: ---
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description David Kutálek 2010-06-15 05:24:32 EDT
Description of problem:

There are these flaws in 'report' command documentation:
1) in online help (report --help):
   a) --username=USERNAME  File to attach to ticket
      This option explanation seems to me wrong or at least confusing
   b) there is no explanation what 'args' can/should be (a file to report?)
2) in manual (man report):
   a) all options mentioned are without '--' prefix
   b) there is no explanation what '[args]' can/should be (a file to report?)
   c) these options are not documented in manual: -v, --verbose, -h, --help, --gtk

Version-Release number of selected component (if applicable):

report-0.15-1.el6

How reproducible:

Always

Steps to Reproduce:
1. man report
2. report --help
  
Actual results:

As described above.

Expected results:

All options clearly documented in both manual and online help.
Arguments described.

Additional info:
Comment 1 RHEL Product and Program Management 2010-06-15 05:33:11 EDT
This request was evaluated by Red Hat Product Management for inclusion in a Red
Hat Enterprise Linux major release.  Product Management has requested further
review of this request by Red Hat Engineering, for potential inclusion in a Red
Hat Enterprise Linux Major release.  This request is not yet committed for
inclusion.
Comment 2 Gavin Romig-Koch 2010-06-18 10:14:43 EDT
pushed to fedora hosted src repo.
Comment 5 releng-rhel@redhat.com 2010-11-10 16:29:34 EST
Red Hat Enterprise Linux 6.0 is now available and should resolve
the problem described in this bug report. This report is therefore being closed
with a resolution of CURRENTRELEASE. You may reopen this bug report if the
solution does not work for you.

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