Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

crypto: skcipher - remove excess kerneldoc members

Commit 31865c4c4db2 ("crypto: skcipher - Add lskcipher") moved some
fields from 'struct skcipher_alg' into SKCIPHER_ALG_COMMON but didn't
remove the corresponding kerneldoc members, which results in these
warnings when running 'make htmldocs':

./include/crypto/skcipher.h:182: warning: Excess struct member 'min_keysize' description in 'skcipher_alg'
./include/crypto/skcipher.h:182: warning: Excess struct member 'max_keysize' description in 'skcipher_alg'
./include/crypto/skcipher.h:182: warning: Excess struct member 'ivsize' description in 'skcipher_alg'
./include/crypto/skcipher.h:182: warning: Excess struct member 'chunksize' description in 'skcipher_alg'
./include/crypto/skcipher.h:182: warning: Excess struct member 'stat' description in 'skcipher_alg'
./include/crypto/skcipher.h:182: warning: Excess struct member 'base' description in 'skcipher_alg'

SKCIPHER_ALG_COMMON already has the documentation for all these fields.

Fixes: 31865c4c4db2 ("crypto: skcipher - Add lskcipher")
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

authored by

Vegard Nossum and committed by
Herbert Xu
069579d0 b590563e

-16
-16
include/crypto/skcipher.h
··· 121 121 122 122 /** 123 123 * struct skcipher_alg - symmetric key cipher definition 124 - * @min_keysize: Minimum key size supported by the transformation. This is the 125 - * smallest key length supported by this transformation algorithm. 126 - * This must be set to one of the pre-defined values as this is 127 - * not hardware specific. Possible values for this field can be 128 - * found via git grep "_MIN_KEY_SIZE" include/crypto/ 129 - * @max_keysize: Maximum key size supported by the transformation. This is the 130 - * largest key length supported by this transformation algorithm. 131 - * This must be set to one of the pre-defined values as this is 132 - * not hardware specific. Possible values for this field can be 133 - * found via git grep "_MAX_KEY_SIZE" include/crypto/ 134 124 * @setkey: Set key for the transformation. This function is used to either 135 125 * program a supplied key into the hardware or store the key in the 136 126 * transformation context for programming it later. Note that this ··· 166 176 * @exit: Deinitialize the cryptographic transformation object. This is a 167 177 * counterpart to @init, used to remove various changes set in 168 178 * @init. 169 - * @ivsize: IV size applicable for transformation. The consumer must provide an 170 - * IV of exactly that size to perform the encrypt or decrypt operation. 171 - * @chunksize: Equal to the block size except for stream ciphers such as 172 - * CTR where it is set to the underlying block size. 173 179 * @walksize: Equal to the chunk size except in cases where the algorithm is 174 180 * considerably more efficient if it can operate on multiple chunks 175 181 * in parallel. Should be a multiple of chunksize. 176 - * @stat: Statistics for cipher algorithm 177 - * @base: Definition of a generic crypto algorithm. 178 182 * @co: see struct skcipher_alg_common 179 183 * 180 184 * All fields except @ivsize are mandatory and must be filled.