From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 27AA8C77B7A for ; Thu, 1 Jun 2023 10:26:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232661AbjFAK0A (ORCPT ); Thu, 1 Jun 2023 06:26:00 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58992 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234110AbjFAKZT (ORCPT ); Thu, 1 Jun 2023 06:25:19 -0400 Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 14F48173A; Thu, 1 Jun 2023 03:23:22 -0700 (PDT) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id AABC5169C; Thu, 1 Jun 2023 03:22:58 -0700 (PDT) Received: from FVFF77S0Q05N (unknown [10.57.22.50]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 2BF283F663; Thu, 1 Jun 2023 03:22:12 -0700 (PDT) Date: Thu, 1 Jun 2023 11:22:09 +0100 From: Mark Rutland To: Akira Yokosawa Cc: Randy Dunlap , linux-kernel@vger.kernel.org, corbet@lwn.net, linux-doc@vger.kernel.org, paulmck@kernel.org Subject: Re: [PATCH 24/26] locking/atomic: scripts: generate kerneldoc comments Message-ID: References: <20230522122429.1915021-1-mark.rutland@arm.com> <20230522122429.1915021-25-mark.rutland@arm.com> <96d6930b-78b1-4b4c-63e3-c385a764d6e3@gmail.com> <20230524141152.GL4253@hirez.programming.kicks-ass.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org 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.