crypto: doc - Document remaining members in struct crypto_alg
diff mbox

Message ID 152106575282.18613.11776196133273563770.stgit@taos
State Accepted
Delegated to: Herbert Xu
Headers show

Commit Message

Gary R Hook March 14, 2018, 10:15 p.m. UTC
Add missing comments for union members ablkcipher, blkcipher,
cipher, and compress. This silences complaints when building
the htmldocs.

Fixes: 0d7f488f0305a (crypto: doc - cipher data structures)
Signed-off-by: Gary R Hook <gary.hook@amd.com>
---
 include/linux/crypto.h |    8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Herbert Xu March 23, 2018, 4:03 p.m. UTC | #1
On Wed, Mar 14, 2018 at 05:15:52PM -0500, Gary R Hook wrote:
> Add missing comments for union members ablkcipher, blkcipher,
> cipher, and compress. This silences complaints when building
> the htmldocs.
> 
> Fixes: 0d7f488f0305a (crypto: doc - cipher data structures)
> Signed-off-by: Gary R Hook <gary.hook@amd.com>

Patch applied.  Thanks.

Patch
diff mbox

diff --git a/include/linux/crypto.h b/include/linux/crypto.h
index 7e6e84cf6383..6eb06101089f 100644
--- a/include/linux/crypto.h
+++ b/include/linux/crypto.h
@@ -435,6 +435,14 @@  struct compress_alg {
  * @cra_exit: Deinitialize the cryptographic transformation object. This is a
  *	      counterpart to @cra_init, used to remove various changes set in
  *	      @cra_init.
+ * @cra_u.ablkcipher: Union member which contains an asynchronous block cipher
+ *		      definition. See @struct @ablkcipher_alg.
+ * @cra_u.blkcipher: Union member which contains a synchronous block cipher
+ * 		     definition See @struct @blkcipher_alg.
+ * @cra_u.cipher: Union member which contains a single-block symmetric cipher
+ *		  definition. See @struct @cipher_alg.
+ * @cra_u.compress: Union member which contains a (de)compression algorithm.
+ *		    See @struct @compress_alg.
  * @cra_module: Owner of this transformation implementation. Set to THIS_MODULE
  * @cra_list: internally used
  * @cra_users: internally used