linux-kernel - Re: [PATCH 5/9] docs: kdoc: coalesce the new-section handling

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20250622135053.349c3184@foz.lan>
Date: Sun, 22 Jun 2025 13:50:53 +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 5/9] docs: kdoc: coalesce the new-section handling

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

> Merge the duplicated code back into a single implementation.  Code movement
> only, no logic changes.
> 
> Signed-off-by: Jonathan Corbet <corbet@....net>

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

> ---
>  scripts/lib/kdoc/kdoc_parser.py | 49 +++++++++------------------------
>  1 file changed, 13 insertions(+), 36 deletions(-)
> 
> diff --git a/scripts/lib/kdoc/kdoc_parser.py b/scripts/lib/kdoc/kdoc_parser.py
> index 185ffe4e1469..a336d543e72b 100644
> --- a/scripts/lib/kdoc/kdoc_parser.py
> +++ b/scripts/lib/kdoc/kdoc_parser.py
> @@ -1310,10 +1310,10 @@ class KernelDoc:
>          else:
>              self.emit_msg(ln, f"Cannot find identifier on line:\n{line}")
>  
> -    def process_decl(self, ln, line):
> -        """
> -        STATE_DECLARATION: We've seen the beginning of a declaration
> -        """
> +    #
> +    # Helper function to determine if a new section is being started.
> +    #
> +    def is_new_section(self, ln, line):
>          if doc_sect.search(line):
>              self.entry.in_doc_sect = True
>              newsection = doc_sect.group(1)
> @@ -1346,6 +1346,14 @@ class KernelDoc:
>                  self.entry.contents += "\n"
>  
>              self.state = state.BODY
> +            return True
> +        return False
> +
> +    def process_decl(self, ln, line):
> +        """
> +        STATE_DECLARATION: We've seen the beginning of a declaration
> +        """
> +        if self.is_new_section(ln, line):
>              return
>  
>          if doc_end.search(line):
> @@ -1395,38 +1403,7 @@ class KernelDoc:
>          """
>          STATE_BODY: the bulk of a kerneldoc comment.
>          """
> -        if doc_sect.search(line):
> -            self.entry.in_doc_sect = True
> -            newsection = doc_sect.group(1)
> -
> -            if newsection.lower() in ["description", "context"]:
> -                newsection = newsection.title()
> -
> -            # Special case: @return is a section, not a param description
> -            if newsection.lower() in ["@return", "@returns",
> -                                      "return", "returns"]:
> -                newsection = "Return"
> -
> -            # Perl kernel-doc has a check here for contents before sections.
> -            # the logic there is always false, as in_doc_sect variable is
> -            # always true. So, just don't implement Wcontents_before_sections
> -
> -            # .title()
> -            newcontents = doc_sect.group(2)
> -            if not newcontents:
> -                newcontents = ""
> -
> -            if self.entry.contents.strip("\n"):
> -                self.dump_section()
> -
> -            self.entry.begin_section(ln, newsection)
> -            self.entry.leading_space = None
> -
> -            self.entry.contents = newcontents.lstrip()
> -            if self.entry.contents:
> -                self.entry.contents += "\n"
> -
> -            self.state = state.BODY
> +        if self.is_new_section(ln, line):
>              return
>  
>          if doc_end.search(line):



Thanks,
Mauro