From: Breno Leitao Date: Fri, 14 Mar 2025 17:58:50 +0000 (-0700) Subject: docs: netconsole: document release feature X-Git-Tag: v6.15-rc1~160^2~65^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=56ad890de2cd42cece7975aa8e8fb6bd909a909f;p=thirdparty%2Fkernel%2Flinux.git docs: netconsole: document release feature Add documentation explaining the kernel release auto-population feature in netconsole. This feature appends kernel version information to the userdata dictionary in every message sent when enabled via the `release_enabled` file in the configfs hierarchy. Signed-off-by: Breno Leitao Reviewed-by: Simon Horman Link: https://patch.msgid.link/20250314-netcons_release-v1-6-07979c4b86af@debian.org Signed-off-by: Paolo Abeni --- diff --git a/Documentation/networking/netconsole.rst b/Documentation/networking/netconsole.rst index ec740ba127976..a0076b542e9c7 100644 --- a/Documentation/networking/netconsole.rst +++ b/Documentation/networking/netconsole.rst @@ -272,6 +272,31 @@ Example:: In this example, the message was generated while "echo" was the current scheduled process. +Kernel release auto population in userdata +------------------------------------------ + +Within the netconsole configfs hierarchy, there is a file named `release_enabled` +located in the `userdata` directory. This file controls the kernel release +(version) auto-population feature, which appends the kernel release information +to userdata dictionary in every message sent. + +To enable the release auto-population:: + + echo 1 > /sys/kernel/config/netconsole/target1/userdata/release_enabled + +Example:: + + echo "This is a message" > /dev/kmsg + 12,607,22085407756,-;This is a message + release=6.14.0-rc6-01219-g3c027fbd941d + +.. note:: + + This feature provides the same data as the "release prepend" feature. + However, in this case, the release information is appended to the userdata + dictionary rather than being included in the message header. + + CPU number auto population in userdata --------------------------------------