From nobody@FreeBSD.org  Tue Dec 27 16:55:37 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 206BD106566C
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 27 Dec 2011 16:55:37 +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 0FACD8FC14
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 27 Dec 2011 16:55:37 +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 pBRGtaZA042563
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 27 Dec 2011 16:55:36 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.4/8.14.4/Submit) id pBRGtais042562;
	Tue, 27 Dec 2011 16:55:36 GMT
	(envelope-from nobody)
Message-Id: <201112271655.pBRGtais042562@red.freebsd.org>
Date: Tue, 27 Dec 2011 16:55:36 GMT
From: Momchil Ivanov <momchil@xaxo.eu>
To: freebsd-gnats-submit@FreeBSD.org
Subject: update man ehci(4) to mention options USB_DEBUG
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         163646
>Category:       docs
>Synopsis:       update man ehci(4) to mention options USB_DEBUG
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    eadler
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Dec 27 17:00:31 UTC 2011
>Closed-Date:    Mon Mar 19 01:24:04 UTC 2012
>Last-Modified:  Mon Mar 19 01:24:04 UTC 2012
>Originator:     Momchil Ivanov
>Release:        8.2-STABLE
>Organization:
>Environment:
FreeBSD 8.2-STABLE #2: Tue Dec 27 17:01:47 CET 2011 i386
>Description:
The man page of ehci(4) mentions "LOADER TUNABLES" but they are only available after compiling the kernel with "options USB_DEBUG", which is not mentioned. The man page should make it clear that one needs to recompile the kernel with that option or these sysctls should be made availabe without "options USB_DEBUG". Probably the easiest way would be to update the man page and also mention that the sysctl hw.usb.ehci.lostintrbug is highly probable to solve problems with slow devices or ones that get stalled regularly.

For more information refer to the following thread [1].

1: http://lists.freebsd.org/pipermail/freebsd-usb/2011-December/010940.html
>How-To-Repeat:

>Fix:


>Release-Note:
>Audit-Trail:

From: Benjamin Kaduk <kaduk@MIT.EDU>
To: Momchil Ivanov <momchil@xaxo.eu>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/163646: update man ehci(4) to mention options USB_DEBUG
Date: Mon, 2 Jan 2012 02:32:14 -0500 (EST)

   This message is in MIME format.  The first part should be readable text,
   while the remaining parts are likely unreadable without MIME-aware tools.
 
 ---559023410-1096159132-1325489534=:882
 Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed
 
 On Tue, 27 Dec 2011, Momchil Ivanov wrote:
 
 >
 >> Description:
 > The man page of ehci(4) mentions "LOADER TUNABLES" but they are only available after compiling the kernel with "options USB_DEBUG", which is not mentioned. The man page should make it clear that one needs to recompile the kernel with that option or these sysctls should be made availabe without "options USB_DEBUG". Probably the easiest way would be to update the man page and also mention that the sysctl hw.usb.ehci.lostintrbug is highly probable to solve problems with slow devices or ones that get stalled  regularly.
 >
 > For more information refer to the following thread [1].
 >
 > 1: http://lists.freebsd.org/pipermail/freebsd-usb/2011-December/010940.html
 
 I think that the attached patch should suffice (inline for convenience, 
 too, since it's short):
 --- ehci.4.orig	2012-01-02 02:04:25.000000000 -0500
 +++ ehci.4	2012-01-02 02:28:13.000000000 -0500
 @@ -29,7 +29,7 @@
   .\"
   .\" $FreeBSD: head/share/man/man4/ehci.4 219004 2011-02-24 18:08:23Z hselasky $
   .\"
 -.Dd February 24, 2011
 +.Dd January 2, 2012
   .Dt EHCI 4
   .Os
   .Sh NAME
 @@ -80,7 +80,11 @@
   device driver first appeared in
   .Fx 5.1 .
   .Sh LOADER TUNABLES
 -Tunables can be set at the
 +When the kernel has been compiled with
 +.Cd options USB_DEBUG ,
 +some tunables become available that affect the behavior of
 +.Nm .
 +These tunables can be set at the
   .Xr loader 8
   prompt before booting the kernel or stored in
   .Xr loader.conf 5 .
 
 
 
 -Ben Kaduk
 ---559023410-1096159132-1325489534=:882
 Content-Type: TEXT/PLAIN; charset=US-ASCII; name=ehci.4.diff.txt
 Content-Transfer-Encoding: BASE64
 Content-ID: <alpine.GSO.1.10.1201020232140.882@multics.mit.edu>
 Content-Description: 
 Content-Disposition: attachment; filename=ehci.4.diff.txt
 
 LS0tIGVoY2kuNC5vcmlnCTIwMTItMDEtMDIgMDI6MDQ6MjUuMDAwMDAwMDAw
 IC0wNTAwDQorKysgZWhjaS40CTIwMTItMDEtMDIgMDI6Mjg6MTMuMDAwMDAw
 MDAwIC0wNTAwDQpAQCAtMjksNyArMjksNyBAQA0KIC5cIg0KIC5cIiAkRnJl
 ZUJTRDogaGVhZC9zaGFyZS9tYW4vbWFuNC9laGNpLjQgMjE5MDA0IDIwMTEt
 MDItMjQgMTg6MDg6MjNaIGhzZWxhc2t5ICQNCiAuXCINCi0uRGQgRmVicnVh
 cnkgMjQsIDIwMTENCisuRGQgSmFudWFyeSAyLCAyMDEyDQogLkR0IEVIQ0kg
 NA0KIC5Pcw0KIC5TaCBOQU1FDQpAQCAtODAsNyArODAsMTEgQEANCiBkZXZp
 Y2UgZHJpdmVyIGZpcnN0IGFwcGVhcmVkIGluDQogLkZ4IDUuMSAuDQogLlNo
 IExPQURFUiBUVU5BQkxFUw0KLVR1bmFibGVzIGNhbiBiZSBzZXQgYXQgdGhl
 DQorV2hlbiB0aGUga2VybmVsIGhhcyBiZWVuIGNvbXBpbGVkIHdpdGgNCisu
 Q2Qgb3B0aW9ucyBVU0JfREVCVUcgLA0KK3NvbWUgdHVuYWJsZXMgYmVjb21l
 IGF2YWlsYWJsZSB0aGF0IGFmZmVjdCB0aGUgYmVoYXZpb3Igb2YNCisuTm0g
 Lg0KK1RoZXNlIHR1bmFibGVzIGNhbiBiZSBzZXQgYXQgdGhlDQogLlhyIGxv
 YWRlciA4DQogcHJvbXB0IGJlZm9yZSBib290aW5nIHRoZSBrZXJuZWwgb3Ig
 c3RvcmVkIGluDQogLlhyIGxvYWRlci5jb25mIDUgLg0K
 
 ---559023410-1096159132-1325489534=:882--
Responsible-Changed-From-To: freebsd-doc->eadler 
Responsible-Changed-By: eadler 
Responsible-Changed-When: Mon Feb 6 04:42:08 UTC 2012 
Responsible-Changed-Why:  
I'll take it. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/163646: commit references a PR
Date: Sun,  4 Mar 2012 16:26:59 +0000 (UTC)

 Author: eadler
 Date: Sun Mar  4 16:26:49 2012
 New Revision: 232501
 URL: http://svn.freebsd.org/changeset/base/232501
 
 Log:
   ehci tunables are only available when kernel is compiled with USB_DEBUG
   
   PR:		docs/163646
   Reported by:	Momchil Ivanov <momchil@xaxo.eu>
   Submitted by:	Benjamin Kaduk <kaduk@mit.edu>
   Approved by:	cperciva
   MFC after:	1 week
 
 Modified:
   head/share/man/man4/ehci.4
 
 Modified: head/share/man/man4/ehci.4
 ==============================================================================
 --- head/share/man/man4/ehci.4	Sun Mar  4 16:24:58 2012	(r232500)
 +++ head/share/man/man4/ehci.4	Sun Mar  4 16:26:49 2012	(r232501)
 @@ -80,7 +80,11 @@ The
  device driver first appeared in
  .Fx 5.1 .
  .Sh LOADER TUNABLES
 -Tunables can be set at the
 +When the kernel has been compiled with
 +.Cd options USB_DEBUG ,
 +some tunables become available that affect the behavior of
 +.Nm .
 +These tunables can be set at the
  .Xr loader 8
  prompt before booting the kernel or stored in
  .Xr loader.conf 5 .
 _______________________________________________
 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: eadler 
State-Changed-When: Sun Mar 4 16:44:40 UTC 2012 
State-Changed-Why:  
committed in 232501 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/163646: commit references a PR
Date: Mon, 19 Mar 2012 01:15:55 +0000 (UTC)

 Author: eadler
 Date: Mon Mar 19 01:15:36 2012
 New Revision: 233141
 URL: http://svn.freebsd.org/changeset/base/233141
 
 Log:
   MFC r232501:
   	ehci tunables are only available when kernel is compiled with USB_DEBUG
   
   PR:		docs/163646
   Approved by:	cperciva
 
 Modified:
   stable/9/share/man/man4/ehci.4
 Directory Properties:
   stable/9/share/man/man4/   (props changed)
 
 Modified: stable/9/share/man/man4/ehci.4
 ==============================================================================
 --- stable/9/share/man/man4/ehci.4	Mon Mar 19 01:04:46 2012	(r233140)
 +++ stable/9/share/man/man4/ehci.4	Mon Mar 19 01:15:36 2012	(r233141)
 @@ -80,7 +80,11 @@ The
  device driver first appeared in
  .Fx 5.1 .
  .Sh LOADER TUNABLES
 -Tunables can be set at the
 +When the kernel has been compiled with
 +.Cd options USB_DEBUG ,
 +some tunables become available that affect the behavior of
 +.Nm .
 +These tunables can be set at the
  .Xr loader 8
  prompt before booting the kernel or stored in
  .Xr loader.conf 5 .
 _______________________________________________
 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"
 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/163646: commit references a PR
Date: Mon, 19 Mar 2012 01:16:20 +0000 (UTC)

 Author: eadler
 Date: Mon Mar 19 01:16:11 2012
 New Revision: 233142
 URL: http://svn.freebsd.org/changeset/base/233142
 
 Log:
   MFC r232501:
   	ehci tunables are only available when kernel is compiled with USB_DEBUG
   
   PR:		docs/163646
   Approved by:	cperciva
 
 Modified:
   stable/8/share/man/man4/ehci.4
 Directory Properties:
   stable/8/share/man/man4/   (props changed)
 
 Modified: stable/8/share/man/man4/ehci.4
 ==============================================================================
 --- stable/8/share/man/man4/ehci.4	Mon Mar 19 01:15:36 2012	(r233141)
 +++ stable/8/share/man/man4/ehci.4	Mon Mar 19 01:16:11 2012	(r233142)
 @@ -87,7 +87,11 @@ The
  device driver first appeared in
  .Fx 5.1 .
  .Sh LOADER TUNABLES
 -Tunables can be set at the
 +When the kernel has been compiled with
 +.Cd options USB_DEBUG ,
 +some tunables become available that affect the behavior of
 +.Nm .
 +These tunables can be set at the
  .Xr loader 8
  prompt before booting the kernel or stored in
  .Xr loader.conf 5 .
 _______________________________________________
 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: eadler 
State-Changed-When: Mon Mar 19 01:24:02 UTC 2012 
State-Changed-Why:  
Committed. Thanks! 

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