Skip to content

Commit 56ad890

Browse files
leitaoPaolo Abeni
authored andcommitted
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 <[email protected]> Reviewed-by: Simon Horman <[email protected]> Link: https://patch.msgid.link/[email protected] Signed-off-by: Paolo Abeni <[email protected]>
1 parent 4b73dc8 commit 56ad890

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

Documentation/networking/netconsole.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,31 @@ Example::
272272
In this example, the message was generated while "echo" was the current
273273
scheduled process.
274274

275+
Kernel release auto population in userdata
276+
------------------------------------------
277+
278+
Within the netconsole configfs hierarchy, there is a file named `release_enabled`
279+
located in the `userdata` directory. This file controls the kernel release
280+
(version) auto-population feature, which appends the kernel release information
281+
to userdata dictionary in every message sent.
282+
283+
To enable the release auto-population::
284+
285+
echo 1 > /sys/kernel/config/netconsole/target1/userdata/release_enabled
286+
287+
Example::
288+
289+
echo "This is a message" > /dev/kmsg
290+
12,607,22085407756,-;This is a message
291+
release=6.14.0-rc6-01219-g3c027fbd941d
292+
293+
.. note::
294+
295+
This feature provides the same data as the "release prepend" feature.
296+
However, in this case, the release information is appended to the userdata
297+
dictionary rather than being included in the message header.
298+
299+
275300
CPU number auto population in userdata
276301
--------------------------------------
277302

0 commit comments

Comments
 (0)