diff mbox series

Kconfig: describe NET, NO_NET, LWIP_DEBUG and LWIP_ASSERT

Message ID 20241105102524.10387-1-jerome.forissier@linaro.org
State New
Headers show
Series Kconfig: describe NET, NO_NET, LWIP_DEBUG and LWIP_ASSERT | expand

Commit Message

Jerome Forissier Nov. 5, 2024, 10:25 a.m. UTC
Some Kconfig symbols introduced in commit 8cb330355bd5 ("net: introduce
alternative implementation as net/lwip/") need a full description. The
NET symbol needs one, too.

Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org>
---
 Kconfig          | 5 +++++
 net/lwip/Kconfig | 7 +++++++
 2 files changed, 12 insertions(+)
diff mbox series

Patch

diff --git a/Kconfig b/Kconfig
index eb55f2511d9..6305e5eaad1 100644
--- a/Kconfig
+++ b/Kconfig
@@ -765,10 +765,15 @@  choice
 
 config NO_NET
 	bool "No networking support"
+	help
+	  Do not include networking support
 
 config NET
 	bool "Legacy U-Boot networking stack"
 	imply NETDEVICES
+	help
+	  Include networking support with U-Boot's own implementation of the
+	  TCP/IP protocol stack.
 
 config NET_LWIP
 	bool "Use lwIP for networking stack"
diff --git a/net/lwip/Kconfig b/net/lwip/Kconfig
index 8a67de4cf33..5ecff9ae07f 100644
--- a/net/lwip/Kconfig
+++ b/net/lwip/Kconfig
@@ -6,9 +6,16 @@  if NET_LWIP
 
 config LWIP_DEBUG
 	bool "Enable debug traces in the lwIP library"
+	help
+	  Prints messages to the console regarding network packets that go in
+          and out of the lwIP linrary.
 
 config LWIP_ASSERT
 	bool "Enable assertions in the lwIP library"
+	help
+	  Compiles additional error checking code into the lwIP library. These
+	  checks are related to conditions that should not happen in typical
+	  use, but may be helpful to debug new features.
 
 config PROT_DHCP_LWIP
 	bool