Skip to contentSkip to conversation

crypto: Documentation - document uncovered member variables

PATCH In review Stephan Mueller 2 participants 2 messages Nov 14, 2014 – Nov 17, 2014 Crypto API

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 crypto: Documentation - document uncovered member variables

Fix documentation typo for shash_alg->descsize.

Add documentation for initially uncovered member variables.

---
 include/crypto/hash.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
include/crypto/hash.h +6 -1
index 3d66e8b..98abda9 100644
@@ -38,6 +38,10 @@ struct crypto_ahash;
  *	       will save the partial state of the transformation into it. On the
  *	       other side, the @import function will load the state from a
  *	       buffer of this size as well.
+ * @base: Start of data structure of cipher algorithm. The common data
+ *	  structure of crypto_alg contains information common to all ciphers.
+ *	  The hash_alg_common data structure now adds the hash-specific
+ *	  information.
  */
 struct hash_alg_common {
 	unsigned int digestsize;
@@ -114,6 +118,7 @@ struct ahash_request {
  *	    entire state of the ongoing transformation from a provided block of
  *	    data so the transformation can continue from this point onward. No
  *	    data processing happens at this point.
+ * @halg: see struct hash_alg_common
  */
 struct ahash_alg {
 	int (*init)(struct ahash_request *req);
@@ -153,7 +158,7 @@ struct shash_desc {
  * @setkey: see struct ahash_alg
  * @digestsize: see struct ahash_alg
  * @statesize: see struct ahash_alg
- * @dedcsize: Size of the operational state for the message digest. This state
+ * @descsize: Size of the operational state for the message digest. This state
  * 	      size is the memory size that needs to be allocated for
  *	      shash_desc.__ctx
  * @base: internally used
Signature · 1 line
2.1.0
maintainer
#1 lore raw
Quoted 5 lines · Stephan Mueller

Fix documentation typo for shash_alg->descsize.

Add documentation for initially uncovered member variables.

Patch applied.

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt