From nobody@FreeBSD.org  Wed Jan  6 00:49:40 2010
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 02C28106568B
	for <freebsd-gnats-submit@FreeBSD.org>; Wed,  6 Jan 2010 00:49:40 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id CC9118FC12
	for <freebsd-gnats-submit@FreeBSD.org>; Wed,  6 Jan 2010 00:49:39 +0000 (UTC)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id o060nd4s024697
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 6 Jan 2010 00:49:39 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id o060ndRJ024696;
	Wed, 6 Jan 2010 00:49:39 GMT
	(envelope-from nobody)
Message-Id: <201001060049.o060ndRJ024696@www.freebsd.org>
Date: Wed, 6 Jan 2010 00:49:39 GMT
From: Matthew Thyer <matt.thyer@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: wlan(4) does not document requirement for kernel option "IEEE80211_DEBUG"
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         142367
>Category:       docs
>Synopsis:       [patch] wlan(4) does not document requirement for kernel option "IEEE80211_DEBUG"
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    roam
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Jan 06 00:50:07 UTC 2010
>Closed-Date:    Fri Mar 15 23:22:49 UTC 2013
>Last-Modified:  Fri Mar 15 23:22:49 UTC 2013
>Originator:     Matthew Thyer
>Release:        8-STABLE
>Organization:
>Environment:
FreeBSD soekris-builder8 8.0-STABLE FreeBSD 8.0-STABLE #0 r200974: Fri Dec 25 12
:30:51 CST 2009     root@soekris-builder8:/usr/obj/usr/src/sys/MYGENERIC  i386
>Description:
Use of the "wlandebug" command produces the error message:

wlandebug: sysctl-get(net.wlan.0.debug): No such file or directory

This is due to the "IEEE80211_DEBUG" option not being present in the GENERIC ker
nel (for both 8-STABLE and HEAD).

The wlan(4) manual page does not describe the need for this kernel option and so
 the end user has to search the web to gain a clue as to what the problem is.

I suggest that this requirement be mentioned in the "DEBUGGING" section of the w
lan(4) manual page.

Sam Leffler notes this requirement in a message to the FreeBSD-CURRENT mailing l
ist with Message-ID: 481A2748.7080801@freebsd.org, Subject: "Re: Connection prob
lems with wme enabled" & date: "Thu, 01 May 2008 13:25:44 -0700".

Quote:

"Looks like I failed to include IEEE80211_DEBUG in the default kernel
configs; you'll need that to get wlan debug msgs."
>How-To-Repeat:
Run "wlandebug" with a GENERIC kernel and you'll get the error message:

wlandebug: sysctl-get(net.wlan.0.debug): No such file or directory
>Fix:
Add text to the "DEBUGGING" section of the wlan(4) manual page similar to:

The kernel option "IEEE80211_DEBUG" is required to use debugging controls.

Patch attached with submission follows:

--- /usr/src/share/man/man4/wlan.4	2009-12-24 15:14:38.000000000 +1030
+++ /usr/src/share/man/man4/wlan.4.new	2010-01-06 11:01:04.000000000 +1030
@@ -156,6 +156,8 @@
 defines the initial value of the debugging flags for each cloned
 .Nm
 interface; this is useful to enable debug messages during interface creation.
+.Pp
+The kernel option "IEEE80211_DEBUG" is required to use debugging controls.
 .Sh COMPATIBILITY
 The module name of
 .Nm


>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->patched 
State-Changed-By: roam 
State-Changed-When: Thu Jan 14 09:38:45 UTC 2010 
State-Changed-Why:  
Fixed in -CURRENT with slightly different wording, I'll merge the change 
into the stable branches in two weeks' time.  Thanks for reporting this! 


Responsible-Changed-From-To: freebsd-doc->roam 
Responsible-Changed-By: roam 
Responsible-Changed-When: Thu Jan 14 09:38:45 UTC 2010 
Responsible-Changed-Why:  
My MFC reminder. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/142367: commit references a PR
Date: Thu, 14 Jan 2010 09:38:33 +0000 (UTC)

 Author: roam (doc,ports committer)
 Date: Thu Jan 14 09:38:23 2010
 New Revision: 202278
 URL: http://svn.freebsd.org/changeset/base/202278
 
 Log:
   Document that the IEEE80211_DEBUG kernel option is needed for
   using the wlan(4) debugging controls with wording slightly
   different from that in the PR.
   
   PR:		142367
   Submitted by:	Matthew Thyer <matt.thyer@gmail.com>
   MFC after:	2 weeks
 
 Modified:
   head/share/man/man4/wlan.4
 
 Modified: head/share/man/man4/wlan.4
 ==============================================================================
 --- head/share/man/man4/wlan.4	Thu Jan 14 08:08:55 2010	(r202277)
 +++ head/share/man/man4/wlan.4	Thu Jan 14 09:38:23 2010	(r202278)
 @@ -130,7 +130,10 @@ Similarly there is an authenticator fram
  authentication services and a framework for integrating access
  control mechanisms specific to the 802.11 protocol.
  .Sh DEBUGGING
 -Debugging controls are available using:
 +If the
 +.Dv IEEE80211_DEBUG
 +option is included in the kernel configuration,
 +debugging controls are available using:
  .Pp
  .Dl "sysctl net.wlan.X.debug=mask"
  .Pp
 _______________________________________________
 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: Fri Mar 15 23:22:48 UTC 2013 
State-Changed-Why:  
MFCed/fixed by now or it will never be MFCed 

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