From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gentoo-commits+bounces-1176485-garchives=archives.gentoo.org@lists.gentoo.org>
Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(No client certificate requested)
	by finch.gentoo.org (Postfix) with ESMTPS id 64CB51382C5
	for <garchives@archives.gentoo.org>; Tue,  2 Jun 2020 21:38:09 +0000 (UTC)
Received: from pigeon.gentoo.org (localhost [127.0.0.1])
	by pigeon.gentoo.org (Postfix) with SMTP id 4C2B9E07A7;
	Tue,  2 Jun 2020 21:38:08 +0000 (UTC)
Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183])
	(using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits))
	(No client certificate requested)
	by pigeon.gentoo.org (Postfix) with ESMTPS id 2DCADE07A7
	for <gentoo-commits@lists.gentoo.org>; Tue,  2 Jun 2020 21:38:08 +0000 (UTC)
Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84])
	(using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits))
	(No client certificate requested)
	by smtp.gentoo.org (Postfix) with ESMTPS id 240A934EF5B
	for <gentoo-commits@lists.gentoo.org>; Tue,  2 Jun 2020 21:38:06 +0000 (UTC)
Received: from localhost.localdomain (localhost [IPv6:::1])
	by oystercatcher.gentoo.org (Postfix) with ESMTP id 1F56A23B
	for <gentoo-commits@lists.gentoo.org>; Tue,  2 Jun 2020 21:38:04 +0000 (UTC)
From: "Robin H. Johnson" <robbat2@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Content-Transfer-Encoding: 8bit
Content-type: text/plain; charset=UTF-8
Reply-To: gentoo-dev@lists.gentoo.org, "Robin H. Johnson" <robbat2@gentoo.org>
Message-ID: <1591133731.51a7c4fae619a05b8f179f5f03b3e8a556df7205.robbat2@OpenRC>
Subject: [gentoo-commits] proj/netifrc:master commit in: doc/
X-VCS-Repository: proj/netifrc
X-VCS-Files: doc/net.example.Linux.in
X-VCS-Directories: doc/
X-VCS-Committer: robbat2
X-VCS-Committer-Name: Robin H. Johnson
X-VCS-Revision: 51a7c4fae619a05b8f179f5f03b3e8a556df7205
X-VCS-Branch: master
Date: Tue,  2 Jun 2020 21:38:04 +0000 (UTC)
Precedence: bulk
List-Post: <mailto:gentoo-commits@lists.gentoo.org>
List-Help: <mailto:gentoo-commits+help@lists.gentoo.org>
List-Unsubscribe: <mailto:gentoo-commits+unsubscribe@lists.gentoo.org>
List-Subscribe: <mailto:gentoo-commits+subscribe@lists.gentoo.org>
List-Id: Gentoo Linux mail <gentoo-commits.gentoo.org>
X-BeenThere: gentoo-commits@lists.gentoo.org
X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply
X-Archives-Salt: ba8641a5-3b5e-43fd-89e4-32c37ae68af6
X-Archives-Hash: 325eee177dd46fc6df43f204eaafa384

commit:     51a7c4fae619a05b8f179f5f03b3e8a556df7205
Author:     Robin H. Johnson <robbat2 <AT> gentoo <DOT> org>
AuthorDate: Tue Jun  2 21:35:31 2020 +0000
Commit:     Robin H. Johnson <robbat2 <AT> gentoo <DOT> org>
CommitDate: Tue Jun  2 21:35:31 2020 +0000
URL:        https://gitweb.gentoo.org/proj/netifrc.git/commit/?id=51a7c4fa

doc/net.example.Linux: document !wireless better

Users that used layer2 wireless configuration external to netifrc and
had previously configured netifrc with:
`modules="!iwconfig !wpa_supplicant"`
were surprised by the introduction of the iw & iwd modules, because the
modules tries to auto-configure the wireless interfaces.

Document that `modules="!wireless"` is a better configuration knob for
this situation.

Bug: https://bugs.gentoo.org/717226
Signed-off-by: Robin H. Johnson <robbat2 <AT> gentoo.org>

 doc/net.example.Linux.in | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/doc/net.example.Linux.in b/doc/net.example.Linux.in
index 53d9e84..4fc603b 100644
--- a/doc/net.example.Linux.in
+++ b/doc/net.example.Linux.in
@@ -43,8 +43,20 @@
 # You can also specify which modules not to use - for example you may be
 # using a supplicant or linux-wlan-ng to control wireless configuration but
 # you still want to configure network settings per SSID associated with.
-#modules="!iwconfig !wpa_supplicant"
-# IMPORTANT: If you need the above, please disable modules in that order
+#
+# A common case here may be using hostapd or other external configuration of
+# the wireless hardware at layer 2, but leaving netifrc to configure the layer
+# 3 networking
+#
+# Best practice for this situation is to disable ALL netifrc wireless modules:
+#modules="!wireless"
+#
+# This supersedes older cases where each module was disabled seperately:
+# If new modules are introduced that provide wireless support, they may be used
+# automatically otherwise, causing situations like
+# https://bugs.gentoo.org/717226
+# Do not use a line like this anymore:
+#modules="!iwconfig !wpa_supplicant !iw !iwd"
 
 
 ##############################################################################
@@ -435,9 +447,8 @@
 # won't have associated then)
 
 # If you're using anything else to configure wireless on your interface AND
-# you have installed wpa_supplicant, you need to disable wpa_supplicant
-#modules="!iwconfig !wpa_supplicant"
-#or
+# you have installed wpa_supplicant, you need to disable wpa_supplicant.
+# Please see the note about hostapd in the MODULES section.
 #modules="!wireless"
 
 ##############################################################################