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

Sam Ravnborg sam at ravnborg.org
Mon Dec 7 12:12:57 EST 2020


Hi Randy,
> >>
> >> 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.

fb_notify.c contains only the three functions modified in this patch.

So it is consistent within this file, but other fbdev/core/ files uses
RETURNS. git grep shows 5 hits only.

So we will stick with the documented practice here.

	Sam



More information about the linux-arm-kernel mailing list