Skip to content

Commit

Permalink
scripts: kernel-doc: Remove workaround for @param... syntax
Browse files Browse the repository at this point in the history
Commit 43756e3 ("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>
Link: https://lore.kernel.org/r/20230129150435.1510400-1-j.neuschaefer@gmx.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
  • Loading branch information
neuschaefer authored and Jonathan Corbet committed Jan 31, 2023
1 parent 19a1261 commit 3bdd9f0
Showing 1 changed file with 0 additions and 11 deletions.
11 changes: 0 additions & 11 deletions scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 3bdd9f0

Please sign in to comment.