public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
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
Date: Thu, 17 Nov 2022 12:23:28 -0500	[thread overview]
Message-ID: <Y3ZuECdzBqUjAUlN@shaak> (raw)
In-Reply-To: <e2948e8b-6e00-abbb-0948-017e7fd584f6@infradead.org>

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

      reply	other threads:[~2022-11-17 17:23 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-17  2:35 [PATCH v1 1/2] math64: favor kernel-doc from header files Liam Beguin
2022-11-17  2:35 ` [PATCH v1 2/2] math64: add kernel-doc for DIV64_U64_ROUND_UP Liam Beguin
2022-11-17 17:02   ` Randy Dunlap
2022-11-17 17:01 ` [PATCH v1 1/2] math64: favor kernel-doc from header files Randy Dunlap
2022-11-17 17:23   ` Liam Beguin [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=Y3ZuECdzBqUjAUlN@shaak \
    --to=liambeguin@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox