Thread (33 messages) 33 messages, 3 authors, 2020-12-08

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

From: Randy Dunlap <hidden>
Date: 2020-12-07 16:45:02
Also in: dri-devel, linux-fbdev

On 12/7/20 12:16 AM, Thomas Zimmermann wrote:
Hi

Am 06.12.20 um 20:37 schrieb Randy Dunlap:
quoted
On 12/6/20 11:02 AM, Sam Ravnborg wrote:
quoted
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.
quoted
quoted
Signed-off-by: Sam Ravnborg <redacted>
Cc: Lee Jones <redacted>
Cc: Sam Ravnborg <redacted>
Cc: Randy Dunlap <redacted>
Cc: Bartlomiej Zolnierkiewicz <redacted>
Cc: Daniel Vetter <redacted>
Cc: "Alexander A. Klimov" <redacted>
---
  drivers/video/fbdev/core/fb_notify.c | 10 ++++++++++
  drivers/video/fbdev/core/fbmon.c     |  2 +-
  2 files changed, 11 insertions(+), 1 deletion(-)

-- 
~Randy


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help