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@xxxxxxxxxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Signed-off-by: Vegard Nossum <vegard.nossum@xxxxxxxxxx>

Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

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