staging: axis-fifo: Fix kernel-doc return value warnings

Browse source

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>
Link: https://patch.msgid.link/20260712214115.7-1-bbnpreetsingh@gmail.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

...

This commit is contained in:

Babanpreet Singh 2026-07-12 21:41:15 +00:00 • committed by Greg Kroah-Hartman

parent 33da57cc4a

commit 4d239034ab

1 changed files with 2 additions and 2 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

4

drivers/staging/axis-fifo/axis-fifo.c

View file