lkml.org 
[lkml]   [2022]   [Nov]   [17]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v1 1/2] math64: favor kernel-doc from header files
Hi Randy,

On Thu, Nov 17, 2022 at 09:01:11AM -0800, Randy Dunlap wrote:
> Hi--
>
> On 11/16/22 18:35, Liam Beguin wrote:
> > Fix the kernel-doc markings for div64 functions to point to the header
> > file instead of the lib/ directory. This avoids having implementation
> > specific comments in generic documentation. Furthermore, given that
> > some kernel-doc comments are identical, drop them from lib/math64 and
> > only keep there comments that add implementation details.
> >
> > Signed-off-by: Liam Beguin <liambeguin@gmail.com>
>
> LGTM.
>
> Could you also fix these 2 warnings?
>
> math64.h:126: warning: No description found for return value of 'div_u64'
> math64.h:139: warning: No description found for return value of 'div_s64'
>

Sure, I'll look into that!

Cheers,
Liam

> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>
>
> Thanks.
>
> > ---
> > Documentation/core-api/kernel-api.rst | 3 ---
> > include/linux/math64.h | 12 ++++++------
> > lib/math/div64.c | 15 ++-------------
> > 3 files changed, 8 insertions(+), 22 deletions(-)
>
> --
> ~Randy

\
 
 \ /
  Last update: 2022-11-17 18:24    [W:0.075 / U:0.544 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site