linux-kernel - [PATCH] scripts: kernel-doc: Remove workaround for @param... syntax

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20230129150435.1510400-1-j.neuschaefer@gmx.net>
Date:   Sun, 29 Jan 2023 16:04:35 +0100
From:   Jonathan Neuschäfer <j.neuschaefer@....net>
To:     linux-doc@...r.kernel.org
Cc:     Jonathan Neuschäfer <j.neuschaefer@....net>,
        Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org
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 <j.neuschaefer@....net>
---
 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