[PATCH v3 02/13] video: fbdev: core: Fix kernel-doc warnings in fbmon + fb_notify

[Randy Dunlap]

On 12/6/20 12:52 PM, Sam Ravnborg wrote:
> Hi Randy.
> 
> On Sun, Dec 06, 2020 at 11:37:17AM -0800, Randy Dunlap wrote:
>> On 12/6/20 11:02 AM, Sam Ravnborg wrote:
>>> Fix kernel-doc warnings reported when using W=1
>>>
>>> v2:
>>>   - Improve subject (Lee)
>>>
>>> v3:
>>>   - Add RETURNS documentation (Thomas)
>>
>> Hi Sam,
>>
>> Yes, RETURNS: will work. It just looks like any kernel-doc section name,
>> such as Context: or Note:.
>> However, the documented format for return info is "Return:".
>> (see Documentation/doc-guide/kernel-doc.rst)
> OK, like this?

Yes. LGTM.

Acked-by: Randy Dunlap <rdunlap at infradead.org>

> I did not fix any existing uses of RETURNS, thats for another patch.
> 
> 	Sam
> 
> commit 03b7c3ecf7cb51b5429ca0ef58a32bb4dc486610
> Author: Sam Ravnborg <sam at ravnborg.org>
> Date:   Sat Nov 28 23:40:49 2020 +0100
> 
>     video: fbdev: core: Fix kernel-doc warnings in fbmon + fb_notify
>     
>     Fix kernel-doc warnings reported when using W=1
>     
>     v2:
>       - Improve subject (Lee)
>     
>     v3:
>       - Add RETURNS documentation (Thomas)
>     
>     v4:
>       - Use Return: not RETURNS (Randy)
>     
>     Signed-off-by: Sam Ravnborg <sam at ravnborg.org>
>     Cc: Lee Jones <lee.jones at linaro.org>
>     Cc: Sam Ravnborg <sam at ravnborg.org>
>     Cc: Randy Dunlap <rdunlap at infradead.org>
>     Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie at samsung.com>
>     Cc: Daniel Vetter <daniel.vetter at ffwll.ch>
>     Cc: "Alexander A. Klimov" <grandmaster at al2klimov.de>


-- 
~Randy