Linux kernel staging patches
 help / color / mirror / Atom feed
From: Babanpreet Singh <bbnpreetsingh@gmail.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Ovidiu Panait <ovidiu.panait.oss@gmail.com>,
	Dan Carpenter <error27@gmail.com>,
	linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org,
	Babanpreet Singh <bbnpreetsingh@gmail.com>
Subject: [PATCH] staging: axis-fifo: Fix kernel-doc return value warnings
Date: Sun, 12 Jul 2026 21:41:15 +0000	[thread overview]
Message-ID: <20260712214115.7-1-bbnpreetsingh@gmail.com> (raw)

The kernel-doc comments for axis_fifo_read() and axis_fifo_write()
describe their return values as free text, which kernel-doc does not
recognize as a return section:

  $ scripts/kernel-doc -Wall -none drivers/staging/axis-fifo/axis-fifo.c
  Warning: drivers/staging/axis-fifo/axis-fifo.c:121 No description
  found for return value of 'axis_fifo_read'
  Warning: drivers/staging/axis-fifo/axis-fifo.c:214 No description
  found for return value of 'axis_fifo_write'

These warnings only show up in a direct kernel-doc invocation or a
W=2 build (-Wall is added to kernel-doc only when KBUILD_EXTRA_WARN
contains 2), which is why W=1 builds appear clean.

Convert the trailing "Returns ..." sentences into Return: sections so
kernel-doc recognizes the existing return value documentation. No
functional change.

Assisted-by: Claude:claude-sonnet-5
Signed-off-by: Babanpreet Singh <bbnpreetsingh@gmail.com>
---
 drivers/staging/axis-fifo/axis-fifo.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/staging/axis-fifo/axis-fifo.c b/drivers/staging/axis-fifo/axis-fifo.c
index 3aa2aa870ea9..7311e06312b0 100644
--- a/drivers/staging/axis-fifo/axis-fifo.c
+++ b/drivers/staging/axis-fifo/axis-fifo.c
@@ -114,7 +114,7 @@ static void reset_ip_core(struct axis_fifo *fifo)
  * operations must be executed atomically, in order and one after the other
  * without missing any.
  *
- * Returns the number of bytes read from the device or negative error code
+ * Return: The number of bytes read from the device or negative error code
  *	on failure.
  */
 static ssize_t axis_fifo_read(struct file *f, char __user *buf,
@@ -207,7 +207,7 @@ static ssize_t axis_fifo_read(struct file *f, char __user *buf,
  * we need to lock before checking if the device has available space to avoid
  * any concurrency issue.
  *
- * Returns the number of bytes written to the device or negative error code
+ * Return: The number of bytes written to the device or negative error code
  *	on failure.
  */
 static ssize_t axis_fifo_write(struct file *f, const char __user *buf,

base-commit: f4fb100039e96211609dfc44fb24b9e4a8a0f2f9
-- 
2.43.0


                 reply	other threads:[~2026-07-12 21:41 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20260712214115.7-1-bbnpreetsingh@gmail.com \
    --to=bbnpreetsingh@gmail.com \
    --cc=error27@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-staging@lists.linux.dev \
    --cc=ovidiu.panait.oss@gmail.com \
    /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