gluon-radv-filterd: Add documentation of site.conf parameter

2018-01-03 23:38:22 +01:00 · 2018-01-03 23:38:22 +01:00 · 32c191892d
commit 32c191892d
parent f1a9196deb
1 changed files with 14 additions and 0 deletions
--- a/docs/package/gluon-radv-filterd.rst
+++ b/docs/package/gluon-radv-filterd.rst
@ -38,3 +38,17 @@ selected router via the ``statistics.gateway6`` property using its interface MAC
 address. Note that this is different from the ``statistics.gateway`` property,
 which contains the MAC address of the main B.A.T.M.A.N. adv slave interface of
 the selected IPv4 gateway.
+
+site.conf
+---------
+
+radv_filterd.threshold : optional
+    - minimal difference in TQ value that another gateway has to be better than
+      the currently chosen gateway to become the new chosen gateway
+    - defaults to ``20``
+
+Example::
+
+  radv_filterd = {
+    threshold = 20,
+  }