Received-SPF: pass (google.com: domain of linux-crypto+bounces-985-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Message-ID: <7d7fab4f-71e0-4bc2-b622-c2048c32b3f6@infradead.org>
Date: Sat, 23 Dec 2023 09:45:44 -0800
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH 1/2] crypto: shash - remove excess kerneldoc members
To: Vegard Nossum <vegard.nossum@oracle.com>,
 Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>, linux-crypto@vger.kernel.org,
 linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
 Jonathan Corbet <corbet@lwn.net>
References: <20231223083459.3025561-1-vegard.nossum@oracle.com>
Content-Language: en-US
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <20231223083459.3025561-1-vegard.nossum@oracle.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit


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