[PATCH] hwrng: hw_random.h: avoid kernel-doc warnings

Randy Dunlap posted 1 patch 3 weeks, 5 days ago
include/linux/hw_random.h |    2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] hwrng: hw_random.h: avoid kernel-doc warnings
Posted by Randy Dunlap 3 weeks, 5 days ago
Mark internal fields as "private:" so that kernel-doc comments
are not needed for them, eliminating kernel-doc warnings:

Warning: include/linux/hw_random.h:54 struct member 'list' not described
 in 'hwrng'
Warning: include/linux/hw_random.h:54 struct member 'ref' not described
 in 'hwrng'
Warning: include/linux/hw_random.h:54 struct member 'cleanup_work' not
 described in 'hwrng'
Warning: include/linux/hw_random.h:54 struct member 'cleanup_done' not
 described in 'hwrng'
Warning: include/linux/hw_random.h:54 struct member 'dying' not described
 in 'hwrng'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Olivia Mackall <olivia@selenic.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: linux-crypto@vger.kernel.org

 include/linux/hw_random.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20260311.orig/include/linux/hw_random.h
+++ linux-next-20260311/include/linux/hw_random.h
@@ -46,7 +46,7 @@ struct hwrng {
 	unsigned long priv;
 	unsigned short quality;
 
-	/* internal. */
+	/* private: internal. */
 	struct list_head list;
 	struct kref ref;
 	struct work_struct cleanup_work;
Re: [PATCH] hwrng: hw_random.h: avoid kernel-doc warnings
Posted by Herbert Xu 2 weeks, 3 days ago
On Wed, Mar 11, 2026 at 10:13:23PM -0700, Randy Dunlap wrote:
> Mark internal fields as "private:" so that kernel-doc comments
> are not needed for them, eliminating kernel-doc warnings:
> 
> Warning: include/linux/hw_random.h:54 struct member 'list' not described
>  in 'hwrng'
> Warning: include/linux/hw_random.h:54 struct member 'ref' not described
>  in 'hwrng'
> Warning: include/linux/hw_random.h:54 struct member 'cleanup_work' not
>  described in 'hwrng'
> Warning: include/linux/hw_random.h:54 struct member 'cleanup_done' not
>  described in 'hwrng'
> Warning: include/linux/hw_random.h:54 struct member 'dying' not described
>  in 'hwrng'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Olivia Mackall <olivia@selenic.com>
> Cc: Herbert Xu <herbert@gondor.apana.org.au>
> Cc: linux-crypto@vger.kernel.org
> 
>  include/linux/hw_random.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Patch applied.  Thanks.
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt