luci-app-olsrd2: upgrade uci-defaults for ucitrack handling to use json
[feed/routing.git] / batman-adv / Config.in
index 48092e71d37c090bda01eec5184b9728a8b36702..81163366012acf57be24854496f6217cf78e33d4 100644 (file)
@@ -1,30 +1,88 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (C) 2007-2019  B.A.T.M.A.N. contributors:
+#
+# Marek Lindner, Simon Wunderlich
 
-config KMOD_BATMAN_ADV_DEBUG_LOG
-       bool "enable verbose debug logging"
+#
+# B.A.T.M.A.N meshing protocol
+#
+
+config BATMAN_ADV_BATMAN_V
+       bool "B.A.T.M.A.N. V protocol"
        depends on PACKAGE_kmod-batman-adv
-       default n
+       default y
+       help
+         This option enables the B.A.T.M.A.N. V protocol, the successor
+         of the currently used B.A.T.M.A.N. IV protocol. The main
+         changes include splitting of the OGM protocol into a neighbor
+         discovery protocol (Echo Location Protocol, ELP) and a new OGM
+         Protocol OGMv2 for flooding protocol information through the
+         network, as well as a throughput based metric.
+         B.A.T.M.A.N. V is currently considered experimental and not
+         compatible to B.A.T.M.A.N. IV networks.
 
-config KMOD_BATMAN_ADV_BLA
-       bool "enable bridge loop avoidance"
+config BATMAN_ADV_BLA
+       bool "Bridge Loop Avoidance"
        depends on PACKAGE_kmod-batman-adv
+       select PACKAGE_kmod-lib-crc16
        default y
+       help
+         This option enables BLA (Bridge Loop Avoidance), a mechanism
+         to avoid Ethernet frames looping when mesh nodes are connected
+         to both the same LAN and the same mesh. If you will never use
+         more than one mesh node in the same LAN, you can safely remove
+         this feature and save some space.
 
-config KMOD_BATMAN_ADV_DAT
-       bool "enable distributed arp table"
+config BATMAN_ADV_DAT
+       bool "Distributed ARP Table"
        depends on PACKAGE_kmod-batman-adv
        default y
+       help
+         This option enables DAT (Distributed ARP Table), a DHT based
+         mechanism that increases ARP reliability on sparse wireless
+         mesh networks. If you think that your network does not need
+         this option you can safely remove it and save some space.
+
+config BATMAN_ADV_NC
+       bool "Network Coding"
+       depends on PACKAGE_kmod-batman-adv
+       help
+         This option enables network coding, a mechanism that aims to
+         increase the overall network throughput by fusing multiple
+         packets in one transmission.
+         Note that interfaces controlled by batman-adv must be manually
+         configured to have promiscuous mode enabled in order to make
+         network coding work.
+         If you think that your network does not need this feature you
+         can safely disable it and save some space.
 
-config KMOD_BATMAN_ADV_MCAST
-       bool "enable multicast transmission optimization"
+config BATMAN_ADV_MCAST
+       bool "Multicast optimisation"
        depends on PACKAGE_kmod-batman-adv
        default y
+       help
+         This option enables the multicast optimisation which aims to
+         reduce the air overhead while improving the reliability of
+         multicast messages.
 
-config KMOD_BATMAN_ADV_NC
-       bool "enable network coding [requires promisc mode support]"
+config BATMAN_ADV_DEBUG
+       bool "B.A.T.M.A.N. debugging"
        depends on PACKAGE_kmod-batman-adv
-       default n
+       help
+         This is an option for use by developers; most people should
+         say N here. This enables compilation of support for
+         outputting debugging information to the debugfs log or tracing
+         buffer. The output is controlled via the batadv netdev specific
+         log_level setting.
 
-config KMOD_BATMAN_ADV_BATMAN_V
-       bool "enable batman v routing algorithm"
+config BATMAN_ADV_TRACING
+       bool "B.A.T.M.A.N. tracing support"
        depends on PACKAGE_kmod-batman-adv
-       default n
+       select KERNEL_FTRACE
+       select KERNEL_ENABLE_DEFAULT_TRACERS
+       help
+         This is an option for use by developers; most people should
+         say N here. Select this option to gather traces like the debug
+         messages using the generic tracing infrastructure of the kernel.
+         BATMAN_ADV_DEBUG must also be selected to get trace events for
+         batadv_dbg.