From: Liam Beguin <liambeguin@gmail.com>
To: Liam Beguin <liambeguin@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 3/3] math64: fix kernel-doc return value warnings
Date: Fri, 18 Nov 2022 13:23:09 -0500 [thread overview]
Message-ID: <20221118182309.3824530-3-liambeguin@gmail.com> (raw)
In-Reply-To: <20221118182309.3824530-1-liambeguin@gmail.com>
Fix the following kernel-doc warnings by adding a description for return
values of div_[us]64.
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'
Signed-off-by: Liam Beguin <liambeguin@gmail.com>
---
include/linux/math64.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/linux/math64.h b/include/linux/math64.h
index cf3b0099674a..8958f4c005c1 100644
--- a/include/linux/math64.h
+++ b/include/linux/math64.h
@@ -120,6 +120,8 @@ extern s64 div64_s64(s64 dividend, s64 divisor);
* This is the most common 64bit divide and should be used if possible,
* as many 32bit archs can optimize this variant better than a full 64bit
* divide.
+ *
+ * Return: dividend / divisor
*/
#ifndef div_u64
static inline u64 div_u64(u64 dividend, u32 divisor)
@@ -133,6 +135,8 @@ static inline u64 div_u64(u64 dividend, u32 divisor)
* div_s64 - signed 64bit divide with 32bit divisor
* @dividend: signed 64bit dividend
* @divisor: signed 32bit divisor
+ *
+ * Return: dividend / divisor
*/
#ifndef div_s64
static inline s64 div_s64(s64 dividend, s32 divisor)
--
2.37.1.223.g6a475b71f8c4
next prev parent reply other threads:[~2022-11-18 18:24 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 ` Liam Beguin [this message]
2022-11-21 21:32 ` [PATCH v2 1/3] math64: favor kernel-doc from header files Jonathan Corbet
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=20221118182309.3824530-3-liambeguin@gmail.com \
--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;
as well as URLs for NNTP newsgroup(s).