Bug 604045

Summary: Report command line options badly documented
Product: Red Hat Enterprise Linux 6 Reporter: David Kutálek <dkutalek>
Component: reportAssignee: Gavin Romig-Koch <gavin>
Status: CLOSED CURRENTRELEASE QA Contact: David Kutálek <dkutalek>
Severity: medium Docs Contact:
Priority: low    
Version: 6.0CC: ahecox
Target Milestone: rcKeywords: Documentation
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: report-0.16-1 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2010-11-10 21:29:34 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description David Kutálek 2010-06-15 09:24:32 UTC
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 Program Management 2010-06-15 09:33:11 UTC
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 14:14:43 UTC
pushed to fedora hosted src repo.

Comment 5 releng-rhel@redhat.com 2010-11-10 21:29:34 UTC
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.