diff options
| author |   Breno Leitao <leitao@debian.org> | 2025-03-14 10:58:50 -0700 |
|---|---|---|
| committer |   Paolo Abeni <pabeni@redhat.com> | 2025-03-21 18:59:25 +0100 |
| commit | 56ad890de2cd42cece7975aa8e8fb6bd909a909f (patch) | |
| tree | ab0cdbb075f3f47717817129c159bdbbe8fc5667 | |
| parent | selftests: netconsole: Add tests for 'release' feature in sysdata (diff) | |
| download | wireguard-linux-56ad890de2cd42cece7975aa8e8fb6bd909a909f.tar.xz wireguard-linux-56ad890de2cd42cece7975aa8e8fb6bd909a909f.zip | |
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 <leitao@debian.org>
Reviewed-by: Simon Horman <horms@kernel.org>
Link: https://patch.msgid.link/20250314-netcons_release-v1-6-07979c4b86af@debian.org
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
| -rw-r--r-- | Documentation/networking/netconsole.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/Documentation/networking/netconsole.rst b/Documentation/networking/netconsole.rst index ec740ba12797..a0076b542e9c 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 -------------------------------------- |