The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Liam Beguin <liambeguin@gmail.com>,
	Liam Beguin <liambeguin@gmail.com>,
	Randy Dunlap <rdunlap@infradead.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 1/3] math64: favor kernel-doc from header files
Date: Mon, 21 Nov 2022 14:32:46 -0700	[thread overview]
Message-ID: <87wn7o803l.fsf@meer.lwn.net> (raw)
In-Reply-To: <20221118182309.3824530-1-liambeguin@gmail.com>

Liam Beguin <liambeguin@gmail.com> writes:

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

I've applied the series, thanks.

jon

      parent reply	other threads:[~2022-11-21 21:33 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-18 18:23 [PATCH v2 1/3] math64: favor kernel-doc from header files Liam Beguin
2022-11-18 18:23 ` [PATCH v2 2/3] math64: add kernel-doc for DIV64_U64_ROUND_UP Liam Beguin
2022-11-18 18:23 ` [PATCH v2 3/3] math64: fix kernel-doc return value warnings Liam Beguin
2022-11-21 21:32 ` Jonathan Corbet [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=87wn7o803l.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=liambeguin@gmail.com \
    --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