Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Thu, 17 Nov 2022 12:23:28 -0500
From:   Liam Beguin <liambeguin@gmail.com>
To:     Randy Dunlap <rdunlap@infradead.org>
Cc:     corbet@lwn.net, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH v1 1/2] math64: favor kernel-doc from header files
Message-ID: <Y3ZuECdzBqUjAUlN@shaak>
References: <20221117023510.2338176-1-liambeguin@gmail.com>
 <e2948e8b-6e00-abbb-0948-017e7fd584f6@infradead.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <e2948e8b-6e00-abbb-0948-017e7fd584f6@infradead.org>
Precedence: bulk

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