Bug 142367

Summary: [patch] wlan(4) does not document requirement for kernel option "IEEE80211_DEBUG"
Product: Documentation Reporter: matt.thyer
Component: Books & ArticlesAssignee: Peter Pentchev <roam>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description matt.thyer 2010-01-06 00:50:07 UTC 
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."

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:
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
Comment 1 dfilter service freebsd_committer freebsd_triage 2010-01-14 09:38:33 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"
Comment 2 Peter Pentchev freebsd_committer freebsd_triage 2010-01-14 09:38:45 UTC 
State Changed
From-To: open->patched

Fixed in -CURRENT with slightly different wording, I'll merge the change 
into the stable branches in two weeks' time.  Thanks for reporting this!
Comment 3 Peter Pentchev freebsd_committer freebsd_triage 2010-01-14 09:38:45 UTC 
Responsible Changed
From-To: freebsd-doc->roam

My MFC reminder.
Comment 4 Eitan Adler freebsd_committer freebsd_triage 2013-03-15 23:22:48 UTC 
State Changed
From-To: patched->closed

MFCed/fixed by now or it will never be MFCed