From nobody@FreeBSD.org  Wed May 25 13:47:00 2011
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 929D110656A3
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 25 May 2011 13:47:00 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22])
	by mx1.freebsd.org (Postfix) with ESMTP id 830DE8FC0C
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 25 May 2011 13:47:00 +0000 (UTC)
Received: from red.freebsd.org (localhost [127.0.0.1])
	by red.freebsd.org (8.14.4/8.14.4) with ESMTP id p4PDl0FJ095040
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 25 May 2011 13:47:00 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.4/8.14.4/Submit) id p4PDl03x095039;
	Wed, 25 May 2011 13:47:00 GMT
	(envelope-from nobody)
Message-Id: <201105251347.p4PDl03x095039@red.freebsd.org>
Date: Wed, 25 May 2011 13:47:00 GMT
From: Warren Block <wblock@wonkity.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] wording adjustments to usbdump.8 man page
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         157317
>Category:       docs
>Synopsis:       [patch] wording adjustments to usbdump.8 man page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bcr
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed May 25 13:50:08 UTC 2011
>Closed-Date:    Mon Jun 06 07:32:57 UTC 2011
>Last-Modified:  Mon Jun 06 07:32:57 UTC 2011
>Originator:     Warren Block
>Release:        8-stable
>Organization:
>Environment:
FreeBSD lightning 8.2-STABLE FreeBSD 8.2-STABLE #0: Sat May 21 15:01:13 MDT 2011     root@lightning:/usr/obj/usr/src/sys/LIGHTNING  i386
>Description:
Small changes to usbdump.8 wording to improve consistency and clarity.
>How-To-Repeat:

>Fix:
Apply patch.

Patch attached with submission follows:

--- /usr/src/usr.sbin/usbdump/usbdump.8.orig	2011-05-25 07:32:56.000000000 -0600
+++ /usr/src/usr.sbin/usbdump/usbdump.8	2011-05-25 07:43:19.000000000 -0600
@@ -53,21 +53,21 @@
 Snapshot bytes from each packet.
 .It Fl v
 Enable debugging messages.
-When it defined multiple times the verbose level increases.
+When given multiple times, the verbosity level increases.
 .It Fl w Ar file
 Write the raw packets to file.
 .El
 .Sh EXAMPLES
-Captures the USB raw packets alive on usbus2:
+Capture the USB raw packets alive on usbus2:
 .Pp
 .Dl "usbdump -i usbus2 -s 256 -v"
 .Pp
-Dumps the USB raw packets of usbus2 into the file without packet
+Dump the USB raw packets of usbus2 into the file without packet
 size limit:
 .Pp
 .Dl "usbdump -i usbus2 -s 0 -w /tmp/dump_pkts"
 .Pp
-Read the USB raw packets from the file:
+Read and display the USB raw packets from the file:
 .Pp
 .Dl "usbdump -r /tmp/dump_pkts -v"
 .Sh SEE ALSO


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->bcr 
Responsible-Changed-By: bcr 
Responsible-Changed-When: Tue May 31 06:37:28 UTC 2011 
Responsible-Changed-Why:  
Take this PR. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=157317 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/157317: commit references a PR
Date: Tue, 31 May 2011 07:13:17 +0000 (UTC)

 Author: bcr (doc committer)
 Date: Tue May 31 07:13:07 2011
 New Revision: 222519
 URL: http://svn.freebsd.org/changeset/base/222519
 
 Log:
   Minor wording adjustments to usbdump(8).
   
   PR:		docs/157317
   Submitted by:	Warren Block (wblock at wonkity dot com)
   Reviewed by:	hps@
   MFC after:	5 days
 
 Modified:
   head/usr.sbin/usbdump/usbdump.8
 
 Modified: head/usr.sbin/usbdump/usbdump.8
 ==============================================================================
 --- head/usr.sbin/usbdump/usbdump.8	Tue May 31 07:02:49 2011	(r222518)
 +++ head/usr.sbin/usbdump/usbdump.8	Tue May 31 07:13:07 2011	(r222519)
 @@ -25,7 +25,7 @@
  .\"
  .\" $FreeBSD$
  .\"
 -.Dd December 4, 2010
 +.Dd May 31, 2011
  .Dt USBDUMP 8
  .Os
  .Sh NAME
 @@ -63,16 +63,16 @@ Write the raw packets to
  .Ar file .
  .El
  .Sh EXAMPLES
 -Captures USB raw packets on usbus2:
 +Capture the USB raw packets on usbus2:
  .Pp
  .Dl "usbdump -i usbus2 -s 256 -v"
  .Pp
 -Dumps the USB raw packets of usbus2 into the file without packet
 +Dump the USB raw packets of usbus2 into the file without packet
  size limit:
  .Pp
  .Dl "usbdump -i usbus2 -s 0 -w /tmp/dump_pkts"
  .Pp
 -Read the USB raw packets from previous file:
 +Read and display the USB raw packets from previous file:
  .Pp
  .Dl "usbdump -r /tmp/dump_pkts -v"
  .Sh OUTPUT FORMAT
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->patched 
State-Changed-By: bcr 
State-Changed-When: Tue May 31 07:21:54 UTC 2011 
State-Changed-Why:  
A modified version of the patch was committed to HEAD, awaiting MFC in a few 
days. Set to patched state until then. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=157317 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/157317: commit references a PR
Date: Mon,  6 Jun 2011 07:26:26 +0000 (UTC)

 Author: bcr (doc committer)
 Date: Mon Jun  6 07:26:07 2011
 New Revision: 222740
 URL: http://svn.freebsd.org/changeset/base/222740
 
 Log:
   MFC r217358, 222286, 222519:
   
   r222519:
   Minor wording adjustments to usbdump(8).
   
   PR:		docs/157317
   Submitted by:	Warren Block (wblock at wonkity dot com)
   Reviewed by:	hps@
   
   r222286:
   [mdoc] Fixed .Dt call.
   
   r217358:
   Documents OUTPUT formats.  While I'm here cleans up styles and words.
   
   Reviewed by:	brueffer@
 
 Modified:
   stable/8/usr.sbin/usbdump/usbdump.8
 Directory Properties:
   stable/8/usr.sbin/usbdump/   (props changed)
 
 Modified: stable/8/usr.sbin/usbdump/usbdump.8
 ==============================================================================
 --- stable/8/usr.sbin/usbdump/usbdump.8	Mon Jun  6 07:15:19 2011	(r222739)
 +++ stable/8/usr.sbin/usbdump/usbdump.8	Mon Jun  6 07:26:07 2011	(r222740)
 @@ -25,8 +25,8 @@
  .\"
  .\" $FreeBSD$
  .\"
 -.Dd October 14, 2010
 -.Dt usbdump 8
 +.Dd May 31, 2011
 +.Dt USBDUMP 8
  .Os
  .Sh NAME
  .Nm usbdump
 @@ -41,37 +41,92 @@
  .Sh DESCRIPTION
  The
  .Nm
 -utility provides a way to dump USB packets on each host controller.
 +utility provides a way to dump USB packets on host controllers.
  .Pp
 -The following options are accepted.
 +The following options are accepted:
  .Bl -tag -width ".Fl f Ar file"
  .It Fl i Ar ifname
 -Listen on USB bus interface.
 +Listen on USB bus interface
 +.Ar ifname .
  .It Fl r Ar file
 -Read the raw packets from file.
 +Read the raw packets from
 +.Ar file .
  .It Fl s Ar snaplen
 -Snapshot bytes from each packet.
 +Snapshot
 +.Ar snaplen
 +bytes from each packet.
  .It Fl v
  Enable debugging messages.
 -When it defined multiple times the verbose level increases.
 +When defined multiple times the verbosity level increases.
  .It Fl w Ar file
 -Write the raw packets to file.
 +Write the raw packets to
 +.Ar file .
  .El
  .Sh EXAMPLES
 -Captures the USB raw packets alive on usbus2:
 +Capture the USB raw packets on usbus2:
  .Pp
  .Dl "usbdump -i usbus2 -s 256 -v"
  .Pp
 -Dumps the USB raw packets of usbus2 into the file without packet
 +Dump the USB raw packets of usbus2 into the file without packet
  size limit:
  .Pp
  .Dl "usbdump -i usbus2 -s 0 -w /tmp/dump_pkts"
  .Pp
 -Read the USB raw packets from the file:
 +Read and display the USB raw packets from previous file:
  .Pp
  .Dl "usbdump -r /tmp/dump_pkts -v"
 +.Sh OUTPUT FORMAT
 +The output format of
 +.Nm
 +is as follows:
 +.Pp
 +.Dl "<time> <bus>.<addr> <ep> <xfertype> <S/D> (<frames>/<length>) <...>"
 +.Pp
 +The meaning of the output format elements is as follows:
 +.Bl -tag -width "<xfertype>"
 +.It <time>
 +A timestamp preceding all output lines.
 +The timestamp has the format "hh:mm:ss.frac" and is as accurate as
 +the kernel's clock.
 +.It <bus>
 +The USB host controller's bus unit number.
 +.It <addr>
 +The unique number of the USB device as allocated by the host controller driver.
 +.It <ep>
 +The USB endpoint address that indicates whether the address is
 +.Dv OUT
 +or
 +.Dv IN .
 +.It <xfertype>
 +The USB transfer type.
 +Can be
 +.Dv CTRL ,
 +.Dv ISOC ,
 +.Dv BULK
 +or
 +.Dv INTR .
 +.It <S/D>
 +`S' indicates a USB submit.
 +`D' indicates a USB transfer done.
 +.It <frames>
 +Numbers of frames in this packets.
 +If this is a USB submit, its value is
 +.Li xfer->nframes
 +which means how many frames are acceptable or registered to transfer.
 +If this is a USB done,
 +.Li xfer->aframes
 +is the actual number of frames.
 +.It <length>
 +Total packet size.
 +If this is a USB submit, its value is
 +.Li xfer->sumlen .
 +If this is a USB done, its value is
 +.Li xfer->actlen .
 +.It <...>
 +Optional field used for printing an error string if the packet is from USB done.
 +.El
  .Sh SEE ALSO
  .Xr usbconfig 8
  .Sh AUTHORS
  .An Weongyo Jeong
 -.Aq weongyo@FreeBSD.org .
 +.Aq weongyo@FreeBSD.org
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: bcr 
State-Changed-When: Mon Jun 6 07:31:31 UTC 2011 
State-Changed-Why:  
MFC is done. Thanks for sending the patch. PR closed! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=157317 
>Unformatted:
