random: Fix vgetrandom_opaque_params kernel-doc

[PATCH] random: Fix vgetrandom_opaque_params kernel-doc

Posted by Karl Mehltretter 2 weeks, 2 days ago

struct vgetrandom_opaque_params contains size_of_opaque_state, but its
kernel-doc describes size_per_opaque_state. This leaves the real member
undescribed and adds a nonexistent member to the generated
documentation.

Use the member's actual name.

Fixes: 4ad10a5f5f78 ("random: introduce generic vDSO getrandom() implementation")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 include/uapi/linux/random.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/uapi/linux/random.h b/include/uapi/linux/random.h
index 1dd047ec98a1..ef6614d9c704 100644
--- a/include/uapi/linux/random.h
+++ b/include/uapi/linux/random.h
@@ -58,7 +58,7 @@ struct rand_pool_info {
 /**
  * struct vgetrandom_opaque_params - arguments for allocating memory for vgetrandom
  *
- * @size_per_opaque_state:	Size of each state that is to be passed to vgetrandom().
+ * @size_of_opaque_state:	Size of each state passed to vgetrandom().
  * @mmap_prot:			Value of the prot argument in mmap(2).
  * @mmap_flags:			Value of the flags argument in mmap(2).
  * @reserved:			Reserved for future use.

base-commit: 893e11787f78e43b534e252249ac3fff4d1333f8
-- 
2.53.0

Re: [PATCH] random: Fix vgetrandom_opaque_params kernel-doc

Posted by Jason A. Donenfeld 1 week, 2 days ago

On Wed, Sep 09, 2026 at 08:37:44AM +0200, Karl Mehltretter wrote:
> struct vgetrandom_opaque_params contains size_of_opaque_state, but its
> kernel-doc describes size_per_opaque_state. This leaves the real member
> undescribed and adds a nonexistent member to the generated
> documentation.
> 
> Use the member's actual name.

Applied. Thank you.