Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 58e40308 authored by Johannes Schlumberger's avatar Johannes Schlumberger Committed by Herbert Xu
Browse files

[CRYPTO] doc: Fix typo in hash example 



there is a tiny bug in Documentation/crypto/api-intro.txt.
The file has the following example code:

struct scatterlist sg[2];
[...]
if (crypto_hash_digest(&desc, &sg, 2, result))

which does not match the declaration of crypto_hash_digest() in
include/linux/crypto.h.

(static inline int crypto_hash_digest(struct hash_desc *desc,
	struct scatterlist *sg, unsigned int nbytes, u8 *out)

The code in the example passes the address of a pointer (an array actually) as
the second argument, while the function expects the pointer itself.

I have attached a patch to fix this.

Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent f70ee5ec

Documentation/crypto/api-intro.txt

+1 −1
Original line number Original line Diff line number Diff line
@@ -60,7 +60,7 @@ Here's an example of how to use the API: 
	desc.tfm = tfm;

	desc.tfm = tfm;

	desc.flags = 0;

	desc.flags = 0;

	

	

	if (crypto_hash_digest(&desc, &sg, 2, result))

	if (crypto_hash_digest(&desc, sg, 2, result))

		fail();

		fail();

	

	

	crypto_free_hash(tfm);

	crypto_free_hash(tfm);