2023-01-29 15:04:47

by Jonathan Neuschäfer

[permalink] [raw]
Subject: [PATCH] scripts: kernel-doc: Remove workaround for @param... syntax

Commit 43756e347f21 ("scripts/kernel-doc: Add support for named variable
macro arguments") improved how named variable macro arguments are
handled, and changed how they are documented in kerneldoc comments
from "@param...", to "@param", deprecating the old syntax.

All users of the old syntax have since been converted, so this commit
finally removes support for it.

The output of "make htmldocs" is the same with and without this commit.

Signed-off-by: Jonathan Neuschäfer <[email protected]>
---
scripts/kernel-doc | 11 -----------
1 file changed, 11 deletions(-)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 54b0893cae666..5cf38abdaf9da 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -2079,17 +2079,6 @@ sub process_name($$) {
sub process_body($$) {
my $file = shift;

- # Until all named variable macro parameters are
- # documented using the bare name (`x`) rather than with
- # dots (`x...`), strip the dots:
- if ($section =~ /\w\.\.\.$/) {
- $section =~ s/\.\.\.$//;
-
- if ($verbose) {
- emit_warning("${file}:$.", "Variable macro arguments should be documented without dots\n");
- }
- }
-
if ($state == STATE_BODY_WITH_BLANK_LINE && /^\s*\*\s?\S/) {
dump_section($file, $section, $contents);
$section = $section_default;
--
2.39.0



2023-01-31 20:56:44

by Jonathan Corbet

[permalink] [raw]
Subject: Re: [PATCH] scripts: kernel-doc: Remove workaround for @param... syntax

Jonathan Neuschäfer <[email protected]> writes:

> Commit 43756e347f21 ("scripts/kernel-doc: Add support for named variable
> macro arguments") improved how named variable macro arguments are
> handled, and changed how they are documented in kerneldoc comments
> from "@param...", to "@param", deprecating the old syntax.
>
> All users of the old syntax have since been converted, so this commit
> finally removes support for it.
>
> The output of "make htmldocs" is the same with and without this commit.
>
> Signed-off-by: Jonathan Neuschäfer <[email protected]>
> ---
> scripts/kernel-doc | 11 -----------
> 1 file changed, 11 deletions(-)

Applied, thanks.

jon