Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <c9399722-b2df-52ee-cefe-338b118aeb1e@infradead.org>
Date:   Thu, 25 May 2023 21:51:37 -0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.11.0
Subject: Re: [PATCH 24/26] locking/atomic: scripts: generate kerneldoc
 comments
Content-Language: en-US
To:     Akira Yokosawa <akiyks@gmail.com>,
        Peter Zijlstra <peterz@infradead.org>
Cc:     Mark Rutland <mark.rutland@arm.com>, linux-kernel@vger.kernel.org,
        boqun.feng@gmail.com, corbet@lwn.net, keescook@chromium.org,
        linux-arch@vger.kernel.org, linux@armlinux.org.uk,
        linux-doc@vger.kernel.org, paulmck@kernel.org,
        sstabellini@kernel.org, will@kernel.org
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>
 <e76c924a-762c-061d-02b8-13be884ab344@gmail.com>
From:   Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <e76c924a-762c-061d-02b8-13be884ab344@gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

Hi Akira,

On 5/25/23 20:17, Akira Yokosawa wrote:
> On Wed, 24 May 2023 16:11:52 +0200, Peter Zijlstra wrote:
>> On Wed, May 24, 2023 at 11:03:58PM +0900, Akira Yokosawa wrote:
>>
>>>> * All ops are described as an expression using their usual C operator.
>>>>   For example:
>>>>
>>>>   andnot: "Atomically updates @v to (@v & ~@i)"
>>>
>>> The kernel-doc script converts "~@i" into reST source of "~**i**",
>>> where the emphasis of i is not recognized by Sphinx.
>>>
>>> For the "@" to work as expected, please say "~(@i)" or "~ @i".
>>> My preference is the former.
>>
>> And here we start :-/ making the actual comment less readable because
>> retarded tooling.
>>
>>>>   inc:    "Atomically updates @v to (@v + 1)"
>>>>
>>>>   Which may be clearer to non-naative English speakers, and allows all
>>>                             non-native
>>>
>>>>   the operations to be described in the same style.
>>>>
>>>> * All conditional ops have their condition described as an expression
>>>>   using the usual C operators. For example:
>>>>
>>>>   add_unless: "If (@v != @u), atomically updates @v to (@v + @i)"
>>>>   cmpxchg:    "If (@v == @old), atomically updates @v to @new"
>>>>
>>>>   Which may be clearer to non-naative English speakers, and allows all
>>>
>>> Ditto.
>>
>> How about we just keep it as is, and all the rst and html weenies learn
>> to use a text editor to read code comments?
> 
> :-) :-) :-)
> 
> It turns out that kernel-doc is aware of !@var [1].
> Similar tricks can be added for ~@var.
> So let's keep it as is!
> 
> I'll ask documentation forks for updating kernel-doc when this change
> is merged eventually.

What do you mean by that?
What needs to be updated and how?


> [1]: ee2aa7590398 ("scripts: kernel-doc: accept negation like !@var")

thanks.
-- 
~Randy