From 5656035bed3064d4f16f5483c27c138bf353236b Mon Sep 17 00:00:00 2001
From: david gauchard <gauchard@laas.fr>
Date: Sat, 25 Jun 2022 23:18:54 +0200
Subject: [PATCH] document side-effects for wifi-off-at-boot (#8614)

* adding wifi-off-at-boot side-effects mention in documentation
---
 doc/esp8266wifi/generic-class.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/esp8266wifi/generic-class.rst b/doc/esp8266wifi/generic-class.rst
index f1ed42ea0..db844b08b 100644
--- a/doc/esp8266wifi/generic-class.rst
+++ b/doc/esp8266wifi/generic-class.rst
@@ -55,6 +55,10 @@ This change is harmless with standard sketches: Calls to ``WiFi.mode()`` do
 enable radio as usual.  It also smooths current spikes at boot and decreases
 DHCP stress.
 
+Known side-effects:
+
+-  ``WiFi.mode()`` must be called before changing mac addresses with ``wifi_set_macaddr({SOFTAP,STATION}_IF, ...)``.
+
 Legacy behavior can be restored by calling ``enableWiFiAtBootTime()`` from
 anywhere in the code (it is a weak void function intended to play with the
 linker).