admin/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2025-12-07 20:06:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

scripts: kdoc_parser.py: warn about Python version only once

Browse Source 
When running kernel-doc over multiple documents, it emits
one error message per file with is not what we want:

	$ python3.6 scripts/kernel-doc.py . --none
	...
	Warning: ./include/trace/events/swiotlb.h:0 Python 3.7 or later is required for correct results
	Warning: ./include/trace/events/iommu.h:0 Python 3.7 or later is required for correct results
	Warning: ./include/trace/events/sock.h:0 Python 3.7 or later is required for correct results
	...

Change the logic to warn it only once at the library:

	$ python3.6 scripts/kernel-doc.py . --none
	Warning: Python 3.7 or later is required for correct results
	Warning: ./include/cxl/features.h:0 Python 3.7 or later is required for correct results

When running from command line, it warns twice, but that sounds
ok.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Message-ID: <68e54cf8b1201d1f683aad9bc710a99421910356.1758196090.git.mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab
2025-09-18 13:54:55 +02:00
committed by Jonathan Corbet
parent 104e0a682e
commit ade9b9576e
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
scripts/lib/kdoc/kdoc_parser.py
View File

@@ -350,6 +350,7 @@ class KernelEntry:
self.section = SECTION_DEFAULT self.section = SECTION_DEFAULT
self._contents = [] self._contents = []
python_warning = False
class KernelDoc: class KernelDoc:
""" """
@@ -383,9 +384,13 @@ class KernelDoc:
# We need Python 3.7 for its "dicts remember the insertion # We need Python 3.7 for its "dicts remember the insertion
# order" guarantee # order" guarantee
# #
if sys.version_info.major == 3 and sys.version_info.minor < 7: global python_warning
if (not python_warning and
sys.version_info.major == 3 and sys.version_info.minor < 7):
self.emit_msg(0, self.emit_msg(0,
'Python 3.7 or later is required for correct results') 'Python 3.7 or later is required for correct results')
python_warning = True
def emit_msg(self, ln, msg, warning=True): def emit_msg(self, ln, msg, warning=True):
"""Emit a message""" """Emit a message"""