summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2026-01-19 13:05:03 +0100
committerJonathan Corbet <corbet@lwn.net>2026-01-20 15:31:06 -0700
commit35c0f975ef4a96cb488bcb5fca6e852fc347bc49 (patch)
tree30cbb4ff94dde7193169a844196ed6263e985d79 /tools
parent32e9a42440a230b14c438099bc5fccb5012a638a (diff)
docs: kdoc: improve description of MsgFormatter
The description there is quite vague. Make it clearer. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <94269990e2d665bec08a1b6f4d28d84939cb9d83.1768823489.git.mchehab+huawei@kernel.org>
Diffstat (limited to 'tools')
-rwxr-xr-xtools/docs/kernel-doc5
1 files changed, 4 insertions, 1 deletions
diff --git a/tools/docs/kernel-doc b/tools/docs/kernel-doc
index 902397804e80..aed09f9a54dd 100755
--- a/tools/docs/kernel-doc
+++ b/tools/docs/kernel-doc
@@ -182,7 +182,10 @@ return 0 if there are issues at kernel-doc markups;
"""
class MsgFormatter(logging.Formatter):
- """Helper class to format warnings in a similar way to kernel-doc.pl."""
+ """
+ Helper class to capitalize errors and warnings, the same way
+ the venerable (now retired) kernel-doc.pl used to do.
+ """
def format(self, record):
record.levelname = record.levelname.capitalize()