* [PATCH] partitions: aix: fix kernel-doc
@ 2026-10-21 11:07 Manuel Ebner
2026-11-03 10:00 ` Christoph Hellwig
0 siblings, 1 reply; 2+ messages in thread
From: Manuel Ebner @ 2026-10-21 11:07 UTC (permalink / raw)
To: Jens Axboe; +Cc: Manuel Ebner, linux-block, linux-kernel
Add ':' to fix:
$ ./scripts/kernel-doc --none block/partitions/aix.c
Warning: block/partitions/aix.c:80 function parameter 'state' not described in 'read_lba'
Warning: block/partitions/aix.c:80 function parameter 'lba' not described in 'read_lba'
Warning: block/partitions/aix.c:80 function parameter 'buffer' not described in 'read_lba'
Warning: block/partitions/aix.c:80 function parameter 'count' not described in 'read_lba'
Warning: block/partitions/aix.c:113 function parameter 'state' not described in 'alloc_pvd'
Warning: block/partitions/aix.c:113 function parameter 'lba' not described in 'alloc_pvd'
Warning: block/partitions/aix.c:138 function parameter 'state' not described in 'alloc_lvn'
Warning: block/partitions/aix.c:138 function parameter 'lba' not described in 'alloc_lvn'
Signed-off-by: Manuel Ebner <manuelebnerli@mailbox.org>
---
block/partitions/aix.c | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/block/partitions/aix.c b/block/partitions/aix.c
index 689837deb..adea48f4a 100644
--- a/block/partitions/aix.c
+++ b/block/partitions/aix.c
@@ -68,10 +68,10 @@ struct pvd {
/**
* read_lba(): Read bytes from disk, starting at given LBA
- * @state
- * @lba
- * @buffer
- * @count
+ * @state:
+ * @lba:
+ * @buffer:
+ * @count:
*
* Description: Reads @count bytes from @state->disk into @buffer.
* Returns number of bytes read on success, 0 on error.
@@ -103,8 +103,8 @@ static size_t read_lba(struct parsed_partitions *state, u64 lba, u8 *buffer,
/**
* alloc_pvd(): reads physical volume descriptor
- * @state
- * @lba
+ * @state:
+ * @lba:
*
* Description: Returns pvd on success, NULL on error.
* Allocates space for pvd and fill it with disk blocks at @lba
@@ -128,8 +128,8 @@ static struct pvd *alloc_pvd(struct parsed_partitions *state, u32 lba)
/**
* alloc_lvn(): reads logical volume names
- * @state
- * @lba
+ * @state:
+ * @lba:
*
* Description: Returns lvn on success, NULL on error.
* Allocates space for lvn and fill it with disk blocks at @lba
--
2.55.0
^ permalink raw reply [flat|nested] 2+ messages in thread* Re: [PATCH] partitions: aix: fix kernel-doc
2026-10-21 11:07 [PATCH] partitions: aix: fix kernel-doc Manuel Ebner
@ 2026-11-03 10:00 ` Christoph Hellwig
0 siblings, 0 replies; 2+ messages in thread
From: Christoph Hellwig @ 2026-11-03 10:00 UTC (permalink / raw)
To: Manuel Ebner; +Cc: Jens Axboe, linux-block, linux-kernel
On Wed, Oct 21, 2026 at 01:07:10PM +0200, Manuel Ebner wrote:
> /**
> * read_lba(): Read bytes from disk, starting at given LBA
> - * @state
> - * @lba
> - * @buffer
> - * @count
> + * @state:
> + * @lba:
> + * @buffer:
> + * @count:
> *
> * Description: Reads @count bytes from @state->disk into @buffer.
> * Returns number of bytes read on success, 0 on error.
All these stub kernel docs for static functions aren't exactly helpful.
Please turn them ito normal comments where they make sense, or otherwise
just remove them entirely.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-11-03 10:00 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-10-21 11:07 [PATCH] partitions: aix: fix kernel-doc Manuel Ebner
2026-11-03 10:00 ` Christoph Hellwig
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®