Skip to contentSkip to conversation

crypto: add missing kernel-doc for anonymous union members

PATCH In review Kit Dallege 2 participants 2 messages Mar 15 – Mar 21 Crypto API

lore
Share & tools
lore

Kit Dallege

author
#0 lore raw

PATCH 1/5 crypto: add missing kernel-doc for anonymous union members

Document the anonymous SKCIPHER_ALG_COMMON and COMP_ALG_COMMON struct members in skcipher_alg, scomp_alg, and acomp_alg, following the existing pattern used by HASH_ALG_COMMON in shash_alg.

This fixes the following kernel-doc warnings:

include/crypto/skcipher.h:166: struct member 'SKCIPHER_ALG_COMMON' not described in 'skcipher_alg' include/crypto/internal/scompress.h:39: struct member 'COMP_ALG_COMMON' not described in 'scomp_alg' include/crypto/internal/acompress.h:55: struct member 'COMP_ALG_COMMON' not described in 'acomp_alg'

Signed-off-by Kit Dallege <[email protected]>
---
 include/crypto/internal/acompress.h | 1 +
 include/crypto/internal/scompress.h | 1 +
 include/crypto/skcipher.h           | 1 +
 3 files changed, 3 insertions(+)
include/crypto/internal/acompress.h +1 -0
index 9a3f28baa804..9cd37df32dc4 100644
@@ -42,6 +42,7 @@
  *
  * @base:	Common crypto API algorithm data structure
  * @calg:	Cmonn algorithm data structure shared with scomp
+ * @COMP_ALG_COMMON: see struct comp_alg_common
  */
 struct acomp_alg {
 	int (*compress)(struct acomp_req *req);
include/crypto/internal/scompress.h +1 -0
index 6a2c5f2e90f9..13a0851a995b 100644
@@ -22,6 +22,7 @@ struct crypto_scomp {
  * @decompress:	Function performs a de-compress operation
  * @streams:	Per-cpu memory for algorithm
  * @calg:	Cmonn algorithm data structure shared with acomp
+ * @COMP_ALG_COMMON: see struct comp_alg_common
  */
 struct scomp_alg {
 	int (*compress)(struct crypto_scomp *tfm, const u8 *src,
include/crypto/skcipher.h +1 -0
index 9e5853464345..4efe2ca8c4d1 100644
@@ -145,6 +145,7 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
  * 	      considerably more efficient if it can operate on multiple chunks
  * 	      in parallel. Should be a multiple of chunksize.
  * @co: see struct skcipher_alg_common
+ * @SKCIPHER_ALG_COMMON: see struct skcipher_alg_common
  *
  * All fields except @ivsize are mandatory and must be filled.
  */
Signature · 1 line
2.53.0
maintainer
#1 lore raw
Quoted 10 lines · Kit Dallege

Document the anonymous SKCIPHER_ALG_COMMON and COMP_ALG_COMMON struct members in skcipher_alg, scomp_alg, and acomp_alg, following the existing pattern used by HASH_ALG_COMMON in shash_alg.

This fixes the following kernel-doc warnings:

include/crypto/skcipher.h:166: struct member 'SKCIPHER_ALG_COMMON' not described in 'skcipher_alg' include/crypto/internal/scompress.h:39: struct member 'COMP_ALG_COMMON' not described in 'scomp_alg' include/crypto/internal/acompress.h:55: struct member 'COMP_ALG_COMMON' not described in 'acomp_alg'

Quoted 6 lines
Signed-off-by Kit Dallege <[email protected]>
---
 include/crypto/internal/acompress.h | 1 +
 include/crypto/internal/scompress.h | 1 +
 include/crypto/skcipher.h           | 1 +
 3 files changed, 3 insertions(+)

Patch applied. Thanks.

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