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: <ada70afe-64d5-ccab-242e-9a3c3c85e6c4@gmail.com>
Date:   Tue, 27 Sep 2022 11:53:38 +0900
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.11.0
Subject: Re: [PATCH] overflow: Fix kern-doc markup for functions
Content-Language: en-US
To:     Kees Cook <keescook@chromium.org>,
        Matthew Wilcox <willy@infradead.org>
Cc:     Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org,
        linux-hardening@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20220926194713.1806917-1-keescook@chromium.org>
 <YzIUS/+H2YA7RBvA@casper.infradead.org> <202209261408.59F78C0D@keescook>
From:   Akira Yokosawa <akiyks@gmail.com>
In-Reply-To: <202209261408.59F78C0D@keescook>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

Hi,

Somehow Kees added me in Cc:, so let me comment.  :-)

On Mon, 26 Sep 2022 14:09:10 -0700, Kees Cook wrote:
> On Mon, Sep 26, 2022 at 10:06:19PM +0100, Matthew Wilcox wrote:
>> On Mon, Sep 26, 2022 at 12:47:13PM -0700, Kees Cook wrote:
>>> -/** check_add_overflow() - Calculate addition with overflow checking
>>> +/**
>>> + * check_add_overflow - Calculate addition with overflow checking
>>>   *
>>>   * @a: first addend
>>>   * @b: second addend
>>
>> Why did you remove the ()?  And why didn't you delete the blank line?
>> According to our documentation, the canonical form is:
>>
>>   /**
>>    * function_name() - Brief description of function.
>>    * @arg1: Describe the first argument.
>>    * @arg2: Describe the second argument.
>>    *        One can provide multiple line descriptions
>>    *        for arguments.

Matthew, you call it the "canonical form", my take is more of a "template
that is known to work".

>>
>> I don't usually complain about people getting that wrong, but when
>> people correct it to be wrong ...

I'd say "wrong" if "./scripts/kernel-doc -v -none include/linux/overflow.h"
complained or the resulting reST doc didn't rendered properly, but that's
not the case here.

> 
> Hunh, everywhere I'd looked didn't have the "()" (which seems
> redundant). The blank line was entirely aesthetics for me. If it's
> supposed to be without a blank, I can fix it up everwhere.

So, I think this is more of a territory of preference or consistency
rather than that of correctness.  Those extra blank lines can be confusing
as most people expect it in front of description part.

get_maintainer.pl says Kees is the sole maintainer of overflow.h, so
it's his call, I guess.

        Thanks, Akira
>