linux.git/scripts/lib, branch v6.18.21 Clone of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git scripts: kdoc_parser.py: warn about Python version only once 2026-01-02T11:56:39+00:00 Mauro Carvalho Chehab mchehab+huawei@kernel.org 2025-09-18T11:54:55+00:00 ab665eb9997198408b915724df6954156260bfd3 [ Upstream commit ade9b9576e2f000fb2ef0ac3bcd26e1167fd813b ] 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> Signed-off-by: Sasha Levin <sashal@kernel.org> 
[ Upstream commit ade9b9576e2f000fb2ef0ac3bcd26e1167fd813b ]

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>
Signed-off-by: Sasha Levin <sashal@kernel.org>
docs: kdoc: a few more dump_typedef() tweaks 2025-09-18T16:19:54+00:00 Jonathan Corbet corbet@lwn.net 2025-09-08T23:12:14+00:00 c01878437739f86851da76235f394346c6bd8ce3 Merge "typedef" into the typedef_type pattern rather than repeating it later, and add some comments. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
Merge "typedef" into the typedef_type pattern rather than repeating it
later, and add some comments.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: remove redundant comment stripping in dump_typedef() 2025-09-18T16:19:54+00:00 Jonathan Corbet corbet@lwn.net 2025-09-08T22:49:58+00:00 00fa9bc4e93cb336575a5f2c1da90d2443ff14c8 By the time we get here, comments have long since been stripped out; there is no need to do it again. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
By the time we get here, comments have long since been stripped out; there
is no need to do it again.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: remove some dead code in dump_typedef() 2025-09-18T16:19:53+00:00 Jonathan Corbet corbet@lwn.net 2025-09-08T22:32:10+00:00 999a642d7e7d4241cc7dba942a13c67d0685284b The regex in this block of code makes no sense, and a quick test shows that it never matches anything; simply delete the code. No output changes. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
The regex in this block of code makes no sense, and a quick test shows that
it never matches anything; simply delete the code.

No output changes.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: final dump_function() cleanups 2025-09-18T16:19:53+00:00 Jonathan Corbet corbet@lwn.net 2025-09-08T22:21:28+00:00 3dff54410e56ddee2dad8824ea77e60cd5b16d5b Add some more comments to dump_function(), add some comments, and trim out an unneeded duplicate output_declaration() call. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
Add some more comments to dump_function(), add some comments, and trim out
an unneeded duplicate output_declaration() call.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: consolidate some of the macro-processing logic 2025-09-18T16:19:53+00:00 Jonathan Corbet corbet@lwn.net 2025-09-08T22:01:15+00:00 370f430527ecd35938ad94167e45fc784f6e4d95 The logic to handle macros is split in dump_function(); bring it all together into a single place and add a comment saying what's going on. Remove the unneeded is_define_proto variable, and tighten up the code a bit. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
The logic to handle macros is split in dump_function(); bring it all
together into a single place and add a comment saying what's going on.
Remove the unneeded is_define_proto variable, and tighten up the code
a bit.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: Simplify the dump_function() prototype regexes 2025-09-18T16:19:53+00:00 Jonathan Corbet corbet@lwn.net 2025-09-08T19:22:42+00:00 ff1f2af341b72bd5b6b5d432da55faf2f6d24cfe The regexes for the parsing of function prototypes were more complicated than they needed to be and difficult to understand -- at least, I spent a fair amount of time bashing my head against them. Simplify them, and add some documentation comments as well. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
The regexes for the parsing of function prototypes were more complicated
than they needed to be and difficult to understand -- at least, I spent a
fair amount of time bashing my head against them.  Simplify them, and add
some documentation comments as well.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: remove a useless empty capture group 2025-09-18T16:19:53+00:00 Jonathan Corbet corbet@lwn.net 2025-09-05T22:30:48+00:00 08b5228cf455d46a23bfb341766563d1a48e3c8f The is_define_proto case in dump_function() uses a regex with an empty capture group - () - that has no use; just take it out. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
The is_define_proto case in dump_function() uses a regex with an empty
capture group - () - that has no use; just take it out.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: kdoc: remove a couple of spurious regex characters 2025-09-18T16:19:53+00:00 Jonathan Corbet corbet@lwn.net 2025-09-05T21:53:05+00:00 fee63c8f10c2fe77f618f9955c2f5521ff9cc622 The "name" regex in dump_function() includes both the tilde and colon characters, but neither has any place in function prototypes. Remove the characters, after which the regex simplifies to "\w+" No output changes. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
The "name" regex in dump_function() includes both the tilde and colon
characters, but neither has any place in function prototypes.  Remove the
characters, after which the regex simplifies to "\w+"

No output changes.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
doc: kdoc: unify transform handling 2025-09-18T16:19:53+00:00 Jonathan Corbet corbet@lwn.net 2025-09-04T22:49:52+00:00 a2752f8c631201e189f501fc4d320354efa3e72e Both functions and structs are passed through a set of regex-based transforms, but the two were structured differently, despite being the same thing. Create a utility function to apply transformations and use it in both cases. Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
Both functions and structs are passed through a set of regex-based
transforms, but the two were structured differently, despite being the same
thing.  Create a utility function to apply transformations and use it in
both cases.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>