From: Breno Leitao <leitao@debian.org>
To: Breno Leitao <leitao@debian.org>,
Andrew Lunn <andrew+netdev@lunn.ch>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>,
Paolo Abeni <pabeni@redhat.com>, Shuah Khan <shuah@kernel.org>,
Simon Horman <horms@kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-kselftest@vger.kernel.org, linux-doc@vger.kernel.org,
Manu Bretelle <chantr4@gmail.com>,
kernel-team@meta.com
Subject: [PATCH net-next 6/6] docs: netconsole: document release feature
Date: Fri, 14 Mar 2025 10:58:50 -0700 [thread overview]
Message-ID: <20250314-netcons_release-v1-6-07979c4b86af@debian.org> (raw)
In-Reply-To: <20250314-netcons_release-v1-0-07979c4b86af@debian.org>
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>
---
Documentation/networking/netconsole.rst | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
diff --git a/Documentation/networking/netconsole.rst b/Documentation/networking/netconsole.rst
index ae82a6337a8d8..44f5a441cf813 100644
--- a/Documentation/networking/netconsole.rst
+++ b/Documentation/networking/netconsole.rst
@@ -268,6 +268,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
--------------------------------------
--
2.47.1
next prev parent reply other threads:[~2025-03-14 18:00 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-14 17:58 [PATCH net-next 0/6] netconsole: Add support for userdata release Breno Leitao
2025-03-14 17:58 ` [PATCH net-next 1/6] netconsole: introduce 'release' as a new sysdata field Breno Leitao
2025-03-19 15:40 ` Simon Horman
2025-03-14 17:58 ` [PATCH net-next 2/6] netconsole: implement configfs for release_enabled Breno Leitao
2025-03-19 15:40 ` Simon Horman
2025-03-14 17:58 ` [PATCH net-next 3/6] netconsole: add 'sysdata' suffix to related functions Breno Leitao
2025-03-19 15:41 ` Simon Horman
2025-03-14 17:58 ` [PATCH net-next 4/6] netconsole: append release to sysdata Breno Leitao
2025-03-19 15:41 ` Simon Horman
2025-03-14 17:58 ` [PATCH net-next 5/6] selftests: netconsole: Add tests for 'release' feature in sysdata Breno Leitao
2025-03-19 15:41 ` Simon Horman
2025-03-14 17:58 ` Breno Leitao [this message]
2025-03-19 15:42 ` [PATCH net-next 6/6] docs: netconsole: document release feature Simon Horman
2025-03-21 18:10 ` [PATCH net-next 0/6] netconsole: Add support for userdata release patchwork-bot+netdevbpf
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250314-netcons_release-v1-6-07979c4b86af@debian.org \
--to=leitao@debian.org \
--cc=andrew+netdev@lunn.ch \
--cc=chantr4@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=horms@kernel.org \
--cc=kernel-team@meta.com \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=shuah@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).