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

[Randy Dunlap]

On 12/7/20 12:16 AM, Thomas Zimmermann wrote:
> Hi
> 
> Am 06.12.20 um 20:37 schrieb Randy Dunlap:
>> 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)
> 
> Thanks for the note. I asked for RETURNS: because the rest of the file appears to be using it. Returns: is certainly the better alternative. I didn't know there was a difference.
> 
> Best regards
> Thomas
> 

I'm not insisting on using Return:
It can stay the same as the rest of the file IMO.

>>
>>
>>> 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>
>>> ---
>>>   drivers/video/fbdev/core/fb_notify.c | 10 ++++++++++
>>>   drivers/video/fbdev/core/fbmon.c     |  2 +-
>>>   2 files changed, 11 insertions(+), 1 deletion(-)


-- 
~Randy