[PATCH] lib: Correct comment of prandom_seed

[PATCH] lib: Correct comment of prandom_seed

[Philippe Mazenauer]

Variable 'entropy' was wrongly documented as 'seed', changed comment to
reflect actual variable name.

../lib/random32.c:179: warning: Function parameter or member 'entropy' not described in 'prandom_seed'
../lib/random32.c:179: warning: Excess function parameter 'seed' description in 'prandom_seed'

Signed-off-by: Philippe Mazenauer <philippe.mazenauer@outlook.de>
---
 lib/random32.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lib/random32.c b/lib/random32.c
index 4aaa76404d56..763b920a6206 100644
--- a/lib/random32.c
+++ b/lib/random32.c
@@ -171,9 +171,9 @@ static void prandom_seed_early(struct rnd_state *state, u32 seed,
 
 /**
  *	prandom_seed - add entropy to pseudo random number generator
- *	@seed: seed value
+ *	@entropy: entropy value
  *
- *	Add some additional seeding to the prandom pool.
+ *	Add some additional entropy to the prandom pool.
  */
 void prandom_seed(u32 entropy)
 {
-- 
2.17.1

Re: [PATCH] lib: Correct comment of prandom_seed

[Lee Jones]

On Fri, 17 May 2019, Philippe Mazenauer wrote:

> Variable 'entropy' was wrongly documented as 'seed', changed comment to
> reflect actual variable name.
> 
> ../lib/random32.c:179: warning: Function parameter or member 'entropy' not described in 'prandom_seed'
> ../lib/random32.c:179: warning: Excess function parameter 'seed' description in 'prandom_seed'
> 
> Signed-off-by: Philippe Mazenauer <philippe.mazenauer@outlook.de>
> ---
>  lib/random32.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Looks reasonable:

Acked-by: Lee Jones <lee.jones@linaro.org>

-- 
Lee Jones [李琼斯]
Linaro Services Technical Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog

Re: [PATCH] lib: Correct comment of prandom_seed

[David Miller]

From: Philippe Mazenauer <philippe.mazenauer@outlook.de>
Date: Fri, 17 May 2019 10:44:44 +0000

> Variable 'entropy' was wrongly documented as 'seed', changed comment to
> reflect actual variable name.
> 
> ../lib/random32.c:179: warning: Function parameter or member 'entropy' not described in 'prandom_seed'
> ../lib/random32.c:179: warning: Excess function parameter 'seed' description in 'prandom_seed'
> 
> Signed-off-by: Philippe Mazenauer <philippe.mazenauer@outlook.de>

Applied.