summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGustavo Luiz Duarte <gustavold@gmail.com>2026-09-03 17:26:06 +0100
committerJakub Kicinski <kuba@kernel.org>2026-09-09 18:09:53 -0700
commita4b9392ef046bd8a165fb5091adebc2c6ea46890 (patch)
tree6075549306c9be26818acc5ea7467137c1d8a080
parent7be9bfb7689e875fc94b711dcafe27c86413c966 (diff)
downloadlinux-next-a4b9392ef046bd8a165fb5091adebc2c6ea46890.tar.gz
linux-next-a4b9392ef046bd8a165fb5091adebc2c6ea46890.zip
docs: netconsole: document local_ip auto-selection
An unset local_ip is auto-populated from the egress interface at enable time, but any value the user writes, including 0.0.0.0, is used as-is. This deviates from the behavior prior to "netconsole: use the address family instead of the ipv6 flag", which interpreted 0.0.0.0 as unset. Document this so the distinction between "unset" and "set to 0.0.0.0" is clear. Reviewed-by: Breno Leitao <leitao@debian.org> Signed-off-by: Gustavo Luiz Duarte <gustavold@gmail.com> Link: https://patch.msgid.link/20260903-netcons_ipv6-v4-7-bdd183c844d3@gmail.com Signed-off-by: Jakub Kicinski <kuba@kernel.org>
-rw-r--r--Documentation/networking/netconsole.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/networking/netconsole.rst b/Documentation/networking/netconsole.rst
index 4ab5d7b05cf1..694bca4803d5 100644
--- a/Documentation/networking/netconsole.rst
+++ b/Documentation/networking/netconsole.rst
@@ -141,6 +141,11 @@ The interface exposes these parameters of a netconsole target to userspace:
transmit_errors Number of packet send errors (read-only)
=============== ================================= ============
+local_ip is optional: if it is left unset, netconsole derives a source
+address from the egress interface when the target is enabled. Writing any
+value to it, including 0.0.0.0, uses that value verbatim and disables the
+automatic selection.
+
The "enabled" attribute is also used to control whether the parameters of
a target can be updated or not -- you can modify the parameters of only
disabled targets (i.e. if "enabled" is 0).