Update note on DISABLE_WIFI setting

SmingHub · Apr 26, 2021 · 3826133 · 3826133
1 parent dec3716
commit 3826133
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 3 deletions.
diff --git a/Sming/Arch/Esp8266/Components/sming-arch/README.rst b/Sming/Arch/Esp8266/Components/sming-arch/README.rst
@@ -11,10 +11,14 @@ Default: OFF. In order to use SDK 3.0.0 or newer please follow the instructions
 No-WiFi build
 -------------
 
-.. envvar:: DISABLE_WIFI
+.. note::
+
+   This is an EXPERIMENTAL feature. Not all hardware functions may be available.
+
+If a project does not require WiFi (or networking) then setting the :envvar:`DISABLE_WIFI` variable
+will reduce code size and RAM usage significantly.
+It does this using an un-official :component-esp8266:`esp_no_wifi` Component.
 
-   If a project does not require WiFi (or networking) bulding with this option enabled reduces code size
-   and memory usage signficantly. It does this using an un-official :component-esp8266:`esp_no_wifi` Component.
 
 
 Custom LWIP

diff --git a/Sming/README.rst b/Sming/README.rst
@@ -81,6 +81,27 @@ Localisation
    This is provided as a #define symbol for your application to use.
    See :source:`Sming/Core/SmingLocale.h` for further details.
 
+
+Networking
+~~~~~~~~~~
+
+.. envvar:: DISABLE_WIFI
+
+   .. note::
+
+      EXPERIMENTAL
+
+   0 (Default)
+   1 - Remove core networking support
+
+   Applications which do not require networking can set this flag to avoid building
+   or linking the core :component:`Network` library.
+
+   This will reduce build times, application size and RAM usage.
+   Builds will not succeeded if network code has been inadvertently included.
+
+
+
 Components
 ----------