Commit 58e40308f329275ccf556312a9cd788522f7c224

Authored by Johannes Schlumberger
Committed by Herbert Xu
1 parent f70ee5ec8f

[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: Herbert Xu <herbert@gondor.apana.org.au>

Showing 1 changed file with 1 additions and 1 deletions Side-by-side Diff

Documentation/crypto/api-intro.txt
... ... @@ -60,7 +60,7 @@
60 60 desc.tfm = tfm;
61 61 desc.flags = 0;
62 62  
63   - if (crypto_hash_digest(&desc, &sg, 2, result))
  63 + if (crypto_hash_digest(&desc, sg, 2, result))
64 64 fail();
65 65  
66 66 crypto_free_hash(tfm);