Bug 498891

Summary:	man page of btrace contains errors
Product:	Red Hat Enterprise Linux 5	Reporter:	Milos Malik <mmalik>
Component:	blktrace	Assignee:	Eric Sandeen <esandeen>
Status:	CLOSED ERRATA	QA Contact:	BaseOS QE <qe-baseos-auto>
Severity:	low	Docs Contact:
Priority:	low
Version:	5.3	CC:	ohudlick
Target Milestone:	rc
Target Release:	---
Hardware:	All
OS:	Linux
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2009-09-02 09:41:32 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 Milos Malik 2009-05-04 09:44:05 UTC

Description of problem:
The NAME section of the man page says "btrace - verifies an output file produced by blkparse" which is not true, because btrace is a convenient script, which runs blktrace (as producer) and blkparse (as consumer), and does not verify the output of blkparse.

The SYNOPSIS section contains a redundant word "Usage:".

The EXAMPLE section talks about running blktrace, but it should talk about running btrace.

Version-Release number of selected component (if applicable):
blktrace-1.0.0-3.el5

How reproducible:
always

Steps to Reproduce:
1. see the NAME section of the man page
2. see the SYNOPSIS section of the man page
3. see the EXAMPLE section of the man page
  
Actual results:


Expected results:


Additional info:

Comment 1 Eric Sandeen 2009-05-04 20:21:27 UTC

I've sent a patch fixing these and others upstream:

http://marc.info/?l=linux-btrace&m=124146824114158&w=2

Comment 2 Eric Sandeen 2009-05-11 15:34:48 UTC

http://git.kernel.dk/?p=blktrace.git;a=commitdiff;h=fbdf23ecc21c6fbbc6fd25d41e3072d06188d274#patch5

Comment 3 Eric Sandeen 2009-05-13 22:54:07 UTC

Committed & built in blktrace-1.0.0-6.el5

Comment 9 errata-xmlrpc 2009-09-02 09:41:32 UTC

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/RHEA-2009-1284.html