[PATCH 1/2] crypto: shash - remove excess kerneldoc members

[PATCH 1/2] crypto: shash - remove excess kerneldoc members

[Vegard Nossum]

Commit 42808e5dc602 ("crypto: hash - Count error stats differently")
moved some fields from 'struct shash_alg' into HASH_ALG_COMMON but
didn't remove the corresponding kerneldoc members, which results in
these warnings when running 'make htmldocs':

  ./include/crypto/hash.h:248: warning: Excess struct member 'digestsize' description in 'shash_alg'
  ./include/crypto/hash.h:248: warning: Excess struct member 'statesize' description in 'shash_alg'
  ./include/crypto/hash.h:248: warning: Excess struct member 'stat' description in 'shash_alg'
  ./include/crypto/hash.h:248: warning: Excess struct member 'base' description in 'shash_alg'

HASH_ALG_COMMON already has the documentation for all these fields.

Fixes: 42808e5dc602 ("crypto: hash - Count error stats differently")
Cc: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
 include/crypto/hash.h | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/include/crypto/hash.h b/include/crypto/hash.h
index c7bdbece27cc..5d61f576cfc8 100644
--- a/include/crypto/hash.h
+++ b/include/crypto/hash.h
@@ -212,13 +212,9 @@ struct shash_desc {
  *	      This is a counterpart to @init_tfm, used to remove
  *	      various changes set in @init_tfm.
  * @clone_tfm: Copy transform into new object, may allocate memory.
- * @digestsize: see struct ahash_alg
- * @statesize: see struct ahash_alg
  * @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
- * @stat: Statistics for hash algorithm.
- * @base: internally used
  * @halg: see struct hash_alg_common
  * @HASH_ALG_COMMON: see struct hash_alg_common
  */
-- 
2.34.1

[PATCH 2/2] crypto: skcipher - remove excess kerneldoc members

[Vegard Nossum]

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>
---
 include/crypto/skcipher.h | 16 ----------------
 1 file changed, 16 deletions(-)

diff --git a/include/crypto/skcipher.h b/include/crypto/skcipher.h
index ea18af48346b..8831fcf8f1da 100644
--- a/include/crypto/skcipher.h
+++ b/include/crypto/skcipher.h
@@ -108,16 +108,6 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
 
 /**
  * struct skcipher_alg - symmetric key cipher definition
- * @min_keysize: Minimum key size supported by the transformation. This is the
- *		 smallest key length supported by this transformation algorithm.
- *		 This must be set to one of the pre-defined values as this is
- *		 not hardware specific. Possible values for this field can be
- *		 found via git grep "_MIN_KEY_SIZE" include/crypto/
- * @max_keysize: Maximum key size supported by the transformation. This is the
- *		 largest key length supported by this transformation algorithm.
- *		 This must be set to one of the pre-defined values as this is
- *		 not hardware specific. Possible values for this field can be
- *		 found via git grep "_MAX_KEY_SIZE" include/crypto/
  * @setkey: Set key for the transformation. This function is used to either
  *	    program a supplied key into the hardware or store the key in the
  *	    transformation context for programming it later. Note that this
@@ -152,15 +142,9 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
  * @exit: Deinitialize the cryptographic transformation object. This is a
  *	  counterpart to @init, used to remove various changes set in
  *	  @init.
- * @ivsize: IV size applicable for transformation. The consumer must provide an
- *	    IV of exactly that size to perform the encrypt or decrypt operation.
- * @chunksize: Equal to the block size except for stream ciphers such as
- *	       CTR where it is set to the underlying block size.
  * @walksize: Equal to the chunk size except in cases where the algorithm is
  * 	      considerably more efficient if it can operate on multiple chunks
  * 	      in parallel. Should be a multiple of chunksize.
- * @stat: Statistics for cipher algorithm
- * @base: Definition of a generic crypto algorithm.
  * @co: see struct skcipher_alg_common
  *
  * All fields except @ivsize are mandatory and must be filled.
-- 
2.34.1

Re: [PATCH 2/2] crypto: skcipher - remove excess kerneldoc members

[Randy Dunlap]

On 12/23/23 00:34, Vegard Nossum wrote:
> 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>

Thanks.

> ---
>  include/crypto/skcipher.h | 16 ----------------
>  1 file changed, 16 deletions(-)
> 
> diff --git a/include/crypto/skcipher.h b/include/crypto/skcipher.h
> index ea18af48346b..8831fcf8f1da 100644
> --- a/include/crypto/skcipher.h
> +++ b/include/crypto/skcipher.h
> @@ -108,16 +108,6 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
>  
>  /**
>   * struct skcipher_alg - symmetric key cipher definition
> - * @min_keysize: Minimum key size supported by the transformation. This is the
> - *		 smallest key length supported by this transformation algorithm.
> - *		 This must be set to one of the pre-defined values as this is
> - *		 not hardware specific. Possible values for this field can be
> - *		 found via git grep "_MIN_KEY_SIZE" include/crypto/
> - * @max_keysize: Maximum key size supported by the transformation. This is the
> - *		 largest key length supported by this transformation algorithm.
> - *		 This must be set to one of the pre-defined values as this is
> - *		 not hardware specific. Possible values for this field can be
> - *		 found via git grep "_MAX_KEY_SIZE" include/crypto/
>   * @setkey: Set key for the transformation. This function is used to either
>   *	    program a supplied key into the hardware or store the key in the
>   *	    transformation context for programming it later. Note that this
> @@ -152,15 +142,9 @@ struct skcipher_alg_common SKCIPHER_ALG_COMMON;
>   * @exit: Deinitialize the cryptographic transformation object. This is a
>   *	  counterpart to @init, used to remove various changes set in
>   *	  @init.
> - * @ivsize: IV size applicable for transformation. The consumer must provide an
> - *	    IV of exactly that size to perform the encrypt or decrypt operation.
> - * @chunksize: Equal to the block size except for stream ciphers such as
> - *	       CTR where it is set to the underlying block size.
>   * @walksize: Equal to the chunk size except in cases where the algorithm is
>   * 	      considerably more efficient if it can operate on multiple chunks
>   * 	      in parallel. Should be a multiple of chunksize.
> - * @stat: Statistics for cipher algorithm
> - * @base: Definition of a generic crypto algorithm.
>   * @co: see struct skcipher_alg_common
>   *
>   * All fields except @ivsize are mandatory and must be filled.

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

Re: [PATCH 1/2] crypto: shash - remove excess kerneldoc members

[Randy Dunlap]

On 12/23/23 00:34, Vegard Nossum wrote:
> Commit 42808e5dc602 ("crypto: hash - Count error stats differently")
> moved some fields from 'struct shash_alg' into HASH_ALG_COMMON but
> didn't remove the corresponding kerneldoc members, which results in
> these warnings when running 'make htmldocs':
> 
>   ./include/crypto/hash.h:248: warning: Excess struct member 'digestsize' description in 'shash_alg'
>   ./include/crypto/hash.h:248: warning: Excess struct member 'statesize' description in 'shash_alg'
>   ./include/crypto/hash.h:248: warning: Excess struct member 'stat' description in 'shash_alg'
>   ./include/crypto/hash.h:248: warning: Excess struct member 'base' description in 'shash_alg'
> 
> HASH_ALG_COMMON already has the documentation for all these fields.
> 
> Fixes: 42808e5dc602 ("crypto: hash - Count error stats differently")
> 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>

Thanks.

> ---
>  include/crypto/hash.h | 4 ----
>  1 file changed, 4 deletions(-)
> 
> diff --git a/include/crypto/hash.h b/include/crypto/hash.h
> index c7bdbece27cc..5d61f576cfc8 100644
> --- a/include/crypto/hash.h
> +++ b/include/crypto/hash.h
> @@ -212,13 +212,9 @@ struct shash_desc {
>   *	      This is a counterpart to @init_tfm, used to remove
>   *	      various changes set in @init_tfm.
>   * @clone_tfm: Copy transform into new object, may allocate memory.
> - * @digestsize: see struct ahash_alg
> - * @statesize: see struct ahash_alg
>   * @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
> - * @stat: Statistics for hash algorithm.
> - * @base: internally used
>   * @halg: see struct hash_alg_common
>   * @HASH_ALG_COMMON: see struct hash_alg_common
>   */

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

Re: [PATCH 1/2] crypto: shash - remove excess kerneldoc members

[Herbert Xu]

On Sat, Dec 23, 2023 at 09:34:58AM +0100, Vegard Nossum wrote:
> Commit 42808e5dc602 ("crypto: hash - Count error stats differently")
> moved some fields from 'struct shash_alg' into HASH_ALG_COMMON but
> didn't remove the corresponding kerneldoc members, which results in
> these warnings when running 'make htmldocs':
> 
>   ./include/crypto/hash.h:248: warning: Excess struct member 'digestsize' description in 'shash_alg'
>   ./include/crypto/hash.h:248: warning: Excess struct member 'statesize' description in 'shash_alg'
>   ./include/crypto/hash.h:248: warning: Excess struct member 'stat' description in 'shash_alg'
>   ./include/crypto/hash.h:248: warning: Excess struct member 'base' description in 'shash_alg'
> 
> HASH_ALG_COMMON already has the documentation for all these fields.
> 
> Fixes: 42808e5dc602 ("crypto: hash - Count error stats differently")
> Cc: Randy Dunlap <rdunlap@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
> ---
>  include/crypto/hash.h | 4 ----
>  1 file changed, 4 deletions(-)

All applied.  Thanks.
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt