From: Ovidiu Panait <ovidiu.panait.oss@gmail.com>
Date: Wed, 30 Apr 2025 11:59:53 +0000 (+0300)
Subject: crypto: rng - fix documentation for crypto_rng_alg()
X-Git-Tag: v6.16-rc1~206^2~92
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=63ff962c058a0b32a6c512a9fcd5aae11ebcb7e1;p=thirdparty%2Fkernel%2Flinux.git

crypto: rng - fix documentation for crypto_rng_alg()

Current documentation states that crypto_rng_alg() returns the cra_name of
the rng algorithm, but it actually returns a 'struct rng_alg' pointer from
a RNG handle.

Update documentation to reflect this.

Signed-off-by: Ovidiu Panait <ovidiu.panait.oss@gmail.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
---

diff --git a/include/crypto/rng.h b/include/crypto/rng.h
index 5ac4388f50e13..f8224cc390f8d 100644
--- a/include/crypto/rng.h
+++ b/include/crypto/rng.h
@@ -102,12 +102,10 @@ static inline struct rng_alg *__crypto_rng_alg(struct crypto_alg *alg)
 }
 
 /**
- * crypto_rng_alg - obtain name of RNG
- * @tfm: cipher handle
- *
- * Return the generic name (cra_name) of the initialized random number generator
+ * crypto_rng_alg() - obtain 'struct rng_alg' pointer from RNG handle
+ * @tfm: RNG handle
  *
- * Return: generic name string
+ * Return: Pointer to 'struct rng_alg', derived from @tfm RNG handle
  */
 static inline struct rng_alg *crypto_rng_alg(struct crypto_rng *tfm)
 {