From 10d7ad210764e948a84b83dc961640dbad51074b Mon Sep 17 00:00:00 2001
From: Matthias Schiffer <mschiffer@universe-factory.net>
Date: Fri, 5 Feb 2016 10:40:26 +0100
Subject: [PATCH] docs: add more documentation of WLAN configuration
Fixes #574
---
docs/features/wlan-configuration.rst | 26 ++++++++++++++++++++++++++
docs/index.rst | 1 +
2 files changed, 27 insertions(+)
create mode 100644 docs/features/wlan-configuration.rst
diff --git a/docs/features/wlan-configuration.rst b/docs/features/wlan-configuration.rst
new file mode 100644
index 000000000..ff280eba0
--- /dev/null
+++ b/docs/features/wlan-configuration.rst
@@ -0,0 +1,26 @@
+WLAN configuration
+==================
+
+Gluon allows to configure 2.4GHz and 5GHz radios independently. The configuration
+may include any or all of the three networks "client" (AP mode), "mesh" (802.11s
+mode) and "ibss" (adhoc mode), which can be used simultaneously (using "mesh" and
+"ibss" at same time should be avoided though as weaker hardware usually can't handle the additional
+load). See :doc:`../user/site` for details on the configuration.
+
+Upgrade behaviour
+-----------------
+
+For each of these networks, the site configuration may define a `disabled` flag (by
+default, all configured networks are enabled). This flag is merely a default setting,
+on upgrades the existing setting is always retained (as this setting may have been changed
+by the user). This means that is is not possible to enable or disable an existing network
+configurations during upgrades.
+
+For the "mesh" and "ibss" networks, the default setting only has an effect if none
+of the two has existed before. If a new configuration has been added for "mesh" or "ibss",
+while the other of the two has already existed before, the enabled/disabled state of the
+existing configuration will also be set for the new configuration.
+
+This allows upgrades to change from IBSS to 11s and vice-versa while retaining the
+"wireless meshing is enabled/disabled" property configured by the user regardless
+of the used mode.
diff --git a/docs/index.rst b/docs/index.rst
index 7b4d56e79..6ae4f0132 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -24,6 +24,7 @@ Features
features/configmode
features/autoupdater
+ features/wlan-configuration
features/private-wlan
features/wired-mesh
features/announce
--
GitLab