Merge pull request #421 from ecsv/batadv-2018.3

batman-adv: Cleanup of configuration options

diff --git a/batman-adv/Config.in b/batman-adv/Config.in
index c56a4b3bf4919fea95979972d8d2f44ea7d19ffa..52a688bb78a41e14845e3078c480844b6f3edcae 100644 (file)
--- a/batman-adv/Config.in
+++ b/batman-adv/Config.in
@@ -1,35 +1,97 @@
+# SPDX-License-Identifier: GPL-2.0
+# Copyright (C) 2007-2018  B.A.T.M.A.N. contributors:
+#
+# Marek Lindner, Simon Wunderlich
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of version 2 of the GNU General Public
+# License as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, see <http://www.gnu.org/licenses/>.
 
-config KMOD_BATMAN_ADV_DEBUG_LOG
-       bool "enable verbose debug logging"
-       depends on PACKAGE_kmod-batman-adv
-       default n
+#
+# B.A.T.M.A.N meshing protocol
+#
 
-config KMOD_BATMAN_ADV_BLA
-       bool "enable bridge loop avoidance"
+config BATMAN_ADV_BATMAN_V
+       bool "B.A.T.M.A.N. V protocol"
        depends on PACKAGE_kmod-batman-adv
        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_DAT
-       bool "enable distributed arp table"
+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_DEBUGFS
-       bool "enable debugfs support"
+config BATMAN_ADV_DAT
+       bool "Distributed ARP Table"
        depends on PACKAGE_kmod-batman-adv
-       default n
+       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 KMOD_BATMAN_ADV_MCAST
-       bool "enable multicast transmission optimization"
+config BATMAN_ADV_NC
+       bool "Network Coding"
        depends on PACKAGE_kmod-batman-adv
-       default y
+       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_NC
-       bool "enable network coding [requires promisc mode support]"
+config BATMAN_ADV_MCAST
+       bool "Multicast optimisation"
        depends on PACKAGE_kmod-batman-adv
-       default n
+       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_BATMAN_V
-       bool "enable batman v routing algorithm"
+config BATMAN_ADV_DEBUGFS
+       bool "batman-adv debugfs entries"
        depends on PACKAGE_kmod-batman-adv
-       default y
+       select KERNEL_DEBUG_FS
+       help
+         Enable this to export routing related debug tables via debugfs.
+         The information for each soft-interface and used hard-interface can be
+         found under batman_adv/
+
+         If unsure, say N.
+
+config BATMAN_ADV_DEBUG
+       bool "B.A.T.M.A.N. debugging"
+       depends on BATMAN_ADV_DEBUGFS
+       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 kernel log. The
+         output is controlled via the module parameter debug.

diff --git a/batman-adv/Makefile b/batman-adv/Makefile
index 0d9aa772081688c2a4d7924a4d076aba0bb8c48c..36c764e125f31ed5d476349855e2a3e24cf5f17c 100644 (file)
--- a/batman-adv/Makefile
+++ b/batman-adv/Makefile
@@ -27,16 +27,19 @@ define KernelPackage/batman-adv
   URL:=https://www.open-mesh.org/
   MAINTAINER:=Simon Wunderlich <sw@simonwunderlich.de>
   SUBMENU:=Network Support
-  DEPENDS:=+KMOD_BATMAN_ADV_BLA:kmod-lib-crc16 +kmod-crypto-crc32c +kmod-lib-crc32c +kmod-cfg80211
+  DEPENDS:=+kmod-lib-crc32c +kmod-cfg80211
   TITLE:=B.A.T.M.A.N. Adv
   FILES:=$(PKG_BUILD_DIR)/net/batman-adv/batman-adv.$(LINUX_KMOD_SUFFIX)
   AUTOLOAD:=$(call AutoProbe,batman-adv)
 endef
 
 define KernelPackage/batman-adv/description
-B.A.T.M.A.N. advanced is a kernel module which allows to
-build layer 2 mesh networks. This package builds
-version $(PKG_VERSION) of the kernel module.
+B.A.T.M.A.N. (better approach to mobile ad-hoc networking) is
+a routing protocol for multi-hop ad-hoc mesh networks. The
+networks may be wired or wireless. See
+https://www.open-mesh.org/ for more information and user space
+tools. This package builds version $(PKG_VERSION) of the kernel
+module.
 endef
 
 define KernelPackage/batman-adv/config
@@ -49,13 +52,13 @@ endef
 
 PKG_EXTRA_KCONFIG:= \
        CONFIG_BATMAN_ADV=m \
-       CONFIG_BATMAN_ADV_DEBUG=$(if $(CONFIG_KMOD_BATMAN_ADV_DEBUG_LOG),y,n) \
-       CONFIG_BATMAN_ADV_DEBUGFS=$(if $(CONFIG_KMOD_BATMAN_ADV_DEBUGFS),y,n) \
-       CONFIG_BATMAN_ADV_BLA=$(if $(CONFIG_KMOD_BATMAN_ADV_BLA),y,n) \
-       CONFIG_BATMAN_ADV_DAT=$(if $(CONFIG_KMOD_BATMAN_ADV_DAT),y,n) \
-       CONFIG_BATMAN_ADV_MCAST=$(if $(CONFIG_KMOD_BATMAN_ADV_MCAST),y,n) \
-       CONFIG_BATMAN_ADV_NC=$(if $(CONFIG_KMOD_BATMAN_ADV_NC),y,n) \
-       CONFIG_BATMAN_ADV_BATMAN_V=$(if $(CONFIG_KMOD_BATMAN_ADV_BATMAN_V),y,n) \
+       CONFIG_BATMAN_ADV_DEBUG=$(if $(CONFIG_BATMAN_ADV_DEBUG),y,n) \
+       CONFIG_BATMAN_ADV_DEBUGFS=$(if $(CONFIG_BATMAN_ADV_DEBUGFS),y,n) \
+       CONFIG_BATMAN_ADV_BLA=$(if $(CONFIG_BATMAN_ADV_BLA),y,n) \
+       CONFIG_BATMAN_ADV_DAT=$(if $(CONFIG_BATMAN_ADV_DAT),y,n) \
+       CONFIG_BATMAN_ADV_MCAST=$(if $(CONFIG_BATMAN_ADV_MCAST),y,n) \
+       CONFIG_BATMAN_ADV_NC=$(if $(CONFIG_BATMAN_ADV_NC),y,n) \
+       CONFIG_BATMAN_ADV_BATMAN_V=$(if $(CONFIG_BATMAN_ADV_BATMAN_V),y,n) \
 
 PKG_EXTRA_CFLAGS:= \
        $(patsubst CONFIG_%, -DCONFIG_%=1, $(patsubst %=m,%,$(filter %=m,$(PKG_EXTRA_KCONFIG)))) \
@@ -73,9 +76,9 @@ NOSTDINC_FLAGS = \
        -DBATADV_SOURCE_VERSION=\\\"openwrt-$(PKG_VERSION)-$(PKG_RELEASE)\\\"
 
 COMPAT_SOURCES = \
-       $(if $(CONFIG_KMOD_BATMAN_ADV_MCAST),../../compat-sources/net/core/skbuff.o,) \
-       $(if $(CONFIG_KMOD_BATMAN_ADV_MCAST),../../compat-sources/net/ipv4/igmp.o,) \
-       $(if $(CONFIG_KMOD_BATMAN_ADV_MCAST),../../compat-sources/net/ipv6/mcast_snoop.o,) \
+       $(if $(CONFIG_BATMAN_ADV_MCAST),../../compat-sources/net/core/skbuff.o,) \
+       $(if $(CONFIG_BATMAN_ADV_MCAST),../../compat-sources/net/ipv4/igmp.o,) \
+       $(if $(CONFIG_BATMAN_ADV_MCAST),../../compat-sources/net/ipv6/mcast_snoop.o,) \
 
 define Build/Compile
        +env "batman-adv-y=$(COMPAT_SOURCES)" \