linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] scripts: kernel-doc: Remove workaround for @param... syntax
@ 2023-01-29 15:04 Jonathan Neuschäfer
  2023-01-31 20:55 ` Jonathan Corbet
  0 siblings, 1 reply; 2+ messages in thread
From: Jonathan Neuschäfer @ 2023-01-29 15:04 UTC (permalink / raw)
  To: linux-doc; +Cc: Jonathan Neuschäfer, Jonathan Corbet, linux-kernel

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(-)

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


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] scripts: kernel-doc: Remove workaround for @param... syntax
  2023-01-29 15:04 [PATCH] scripts: kernel-doc: Remove workaround for @param... syntax Jonathan Neuschäfer
@ 2023-01-31 20:55 ` Jonathan Corbet
  0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2023-01-31 20:55 UTC (permalink / raw)
  To: Jonathan Neuschäfer, linux-doc
  Cc: Jonathan Neuschäfer, linux-kernel

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-01-31 20:56 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-29 15:04 [PATCH] scripts: kernel-doc: Remove workaround for @param... syntax Jonathan Neuschäfer
2023-01-31 20:55 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).