diff mbox series

scripts: kernel-doc: Remove workaround for @param... syntax

Message ID 20230129150435.1510400-1-j.neuschaefer@gmx.net
State New
Headers
Series scripts: kernel-doc: Remove workaround for @param... syntax |

Commit Message

Jonathan Neuschäfer Jan. 29, 2023, 3:04 p.m. UTC 
  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 <j.neuschaefer@gmx.net>
---
 scripts/kernel-doc | 11 -----------
 1 file changed, 11 deletions(-)

--
2.39.0

Comments

Jonathan Corbet Jan. 31, 2023, 8:55 p.m. UTC | #1 
Jonathan Neuschäfer <j.neuschaefer@gmx.net> 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 <j.neuschaefer@gmx.net>
> ---
>  scripts/kernel-doc | 11 -----------
>  1 file changed, 11 deletions(-)

Applied, thanks.

jon
diff mbox series

Patch

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;