docs/163646: update man ehci(4) to mention options USB_DEBUG

[Benjamin Kaduk]

The following reply was made to PR docs/163646; it has been noted by GNATS.

From: Benjamin Kaduk <kaduk at MIT.EDU>
To: Momchil Ivanov <momchil at xaxo.eu>
Cc: freebsd-gnats-submit at 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 at 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--