linux-kernel - Re: [PATCH 8/9] docs: kdoc: Add some comments to process

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-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250622135342.182edcb4@foz.lan>
Date: Sun, 22 Jun 2025 13:53:42 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, Akira Yokosawa
 <akiyks@...il.com>
Subject: Re: [PATCH 8/9] docs: kdoc: Add some comments to process_decl()

Em Sat, 21 Jun 2025 14:35:11 -0600
Jonathan Corbet <corbet@....net> escreveu:

> Now that the function can actually fit into a human brain, add a few
> comments.  While I was at it, I switched to the trim_whitespace() helper
> rather than open-coding it.
> 
> Signed-off-by: Jonathan Corbet <corbet@....net>

LGTM.
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

> ---
>  scripts/lib/kdoc/kdoc_parser.py | 30 ++++++++++++++++--------------
>  1 file changed, 16 insertions(+), 14 deletions(-)
> 
> diff --git a/scripts/lib/kdoc/kdoc_parser.py b/scripts/lib/kdoc/kdoc_parser.py
> index f7a5b85a8ed7..a6ee8bac378d 100644
> --- a/scripts/lib/kdoc/kdoc_parser.py
> +++ b/scripts/lib/kdoc/kdoc_parser.py
> @@ -1377,26 +1377,28 @@ class KernelDoc:
>          """
>          if self.is_new_section(ln, line) or self.is_comment_end(ln, line):
>              return
> -
> +        #
> +        # Look for anything with the " * " line beginning.
> +        #
>          if doc_content.search(line):
>              cont = doc_content.group(1)
> -
> +            #
> +            # A blank line means that we have moved out of the declaration
> +            # part of the comment (without any "special section" parameter
> +            # descriptions).
> +            #
>              if cont == "":
>                  self.state = state.BODY
>                  self.entry.contents += "\n"  # needed?
> -
> +            #
> +            # Otherwise we have more of the declaration section to soak up.
> +            #
>              else:
> -                # Continued declaration purpose
> -                self.entry.declaration_purpose = self.entry.declaration_purpose.rstrip()
> -                self.entry.declaration_purpose += " " + cont
> -
> -                r = KernRe(r"\s+")
> -                self.entry.declaration_purpose = r.sub(' ',
> -                                                       self.entry.declaration_purpose)
> -            return
> -
> -        # Unknown line, ignore
> -        self.emit_msg(ln, f"bad line: {line}")
> +                self.entry.declaration_purpose = \
> +                    trim_whitespace(self.entry.declaration_purpose + ' ' + cont)
> +        else:
> +            # Unknown line, ignore
> +            self.emit_msg(ln, f"bad line: {line}")
>  
>  
>      def process_special(self, ln, line):



Thanks,
Mauro