linux-kernel - Re: [PATCH] backlight: ili922x: fix kernel-doc warnings & notation

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

Date:   Mon, 15 Nov 2021 18:25:08 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Daniel Thompson <daniel.thompson@...aro.org>
Cc:     linux-kernel@...r.kernel.org, kernel test robot <lkp@...el.com>,
        Lee Jones <lee.jones@...aro.org>,
        Jingoo Han <jingoohan1@...il.com>,
        dri-devel@...ts.freedesktop.org, Stefano Babic <sbabic@...x.de>,
        Anatolij Gustschin <agust@...x.de>
Subject: Re: [PATCH] backlight: ili922x: fix kernel-doc warnings & notation

On 11/15/21 3:38 AM, Daniel Thompson wrote:

> 
> Thanks for the fixes. Just a could of quibbles about full
> stops/periods.
> 
> 
>> ---
>>   drivers/video/backlight/ili922x.c |   29 ++++++++++++++++++----------
>>   1 file changed, 19 insertions(+), 10 deletions(-)
>>
>> --- linux-next-20211102.orig/drivers/video/backlight/ili922x.c
>> +++ linux-next-20211102/drivers/video/backlight/ili922x.c

>>   /**
>> - * CHECK_FREQ_REG(spi_device s, spi_transfer x) - Check the frequency
>> - *	for the SPI transfer. According to the datasheet, the controller
>> - *	accept higher frequency for the GRAM transfer, but it requires
>> + * CHECK_FREQ_REG() - Check the frequency for the SPI transfer
>> + *	According to the datasheet, the controller
>> + *	accepts higher frequency for the GRAM transfer, but it requires
> 
> Also missing the full stop/period in the first sentence of the summary.
> 
> Note that here the missing full stop does not benefit from a new line to
> conceal it and we will generate bad text as a result.
> 
>    Check the frequency for the SPI transfer According to the data
>    sheet, the controller accepts...

Got it. I'll send a v2.

Thanks.
-- 
~Randy