mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] hwrng: hw_random.h: avoid kernel-doc warnings
@ 2026-03-12  5:13 Randy Dunlap
  2026-03-21  8:49 ` Herbert Xu
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2026-03-12  5:13 UTC (permalink / raw)
  To: linux-kernel; +Cc: Randy Dunlap, Olivia Mackall, Herbert Xu, linux-crypto

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;

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] hwrng: hw_random.h: avoid kernel-doc warnings
  2026-03-12  5:13 [PATCH] hwrng: hw_random.h: avoid kernel-doc warnings Randy Dunlap
@ 2026-03-21  8:49 ` Herbert Xu
  0 siblings, 0 replies; 2+ messages in thread
From: Herbert Xu @ 2026-03-21  8:49 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: linux-kernel, Olivia Mackall, linux-crypto

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-03-21  8:49 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-03-12  5:13 [PATCH] hwrng: hw_random.h: avoid kernel-doc warnings Randy Dunlap
2026-03-21  8:49 ` Herbert Xu

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®