linux-kernel - Re: [PATCH 24/26] locking/atomic: scripts: generate kerneldoc comments

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

Message-ID: <ZHhxUc/cEt8uKNsl@FVFF77S0Q05N>
Date:   Thu, 1 Jun 2023 11:22:09 +0100
From:   Mark Rutland <mark.rutland@....com>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org,
        corbet@....net, linux-doc@...r.kernel.org, paulmck@...nel.org
Subject: Re: [PATCH 24/26] locking/atomic: scripts: generate kerneldoc
 comments

On Thu, Jun 01, 2023 at 08:41:29AM +0900, Akira Yokosawa wrote:
> [Keeping documentation folks in CC]
> 
> On 2023/05/30 21:42, Mark Rutland wrote:
> > Hi Akira,
> > 
> > On Fri, May 26, 2023 at 07:27:56PM +0900, Akira Yokosawa wrote:
> >> I think adding "~" to the substitution pattern added in [1] as follows
> >> should do the trick (not well tested):
> >>
> >> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> >> index 2486689ffc7b..eb70c1fd4e86 100755
> >> --- a/scripts/kernel-doc
> >> +++ b/scripts/kernel-doc
> >> @@ -64,7 +64,7 @@ my $type_constant = '\b``([^\`]+)``\b';
> >>  my $type_constant2 = '\%([-_\w]+)';
> >>  my $type_func = '(\w+)\(\)';
> >>  my $type_param = '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
> >> -my $type_param_ref = '([\!]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
> >> +my $type_param_ref = '([\!~]?)\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)';
> >>  my $type_fp_param = '\@(\w+)\(\)';  # Special RST handling for func ptr params
> >>  my $type_fp_param2 = '\@(\w+->\S+)\(\)';  # Special RST handling for structs with func ptr params
> >>  my $type_env = '(\$\w+)';
> > 
> > Are you happy to send this as a patch?
> 
> I'm afraid I am not at the moment.
> 
> The reason being I have never made changes in that 2500 line perl
> script.  Please consider the change above as a random suggestion from
> someone who don't/can't understand the script fully ...
> > 
> > I'd like to pick it into this series, so if you're happy to provide your
> > Signed-off-by tag here, I'm happy to go write the commit message and so on.
> 
> I you happen to know perl well and be confident the change won't have
> any side effect, I wouldn't mind if you go forward and make a patch
> on your own, maybe with my Suggested-by.  That patch should also have
> explicit Cc: tags to Jon and Mauro who are in the SOB chain of commit
> ee2aa7590398.

Sure; I'm happy to go try that, thanks for letting me know!

Mark.