superrob1500
/
mirror-linux
mirror of https://github.com/torvalds/linux
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
master
Mauro Carvalho Chehab 2026-01-19 13:05:03 +01:00 committed by Jonathan Corbet
parent 32e9a42440
commit 35c0f975ef
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
tools/docs/kernel-doc
View File

@ -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()