From nobody Wed Feb 11 14:23:14 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id D71DDC74A5B for ; Tue, 14 Mar 2023 05:02:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229621AbjCNFCv (ORCPT ); Tue, 14 Mar 2023 01:02:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60388 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229486AbjCNFCt (ORCPT ); Tue, 14 Mar 2023 01:02:49 -0400 Received: from 167-179-156-38.a7b39c.syd.nbn.aussiebb.net (167-179-156-38.a7b39c.syd.nbn.aussiebb.net [167.179.156.38]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0F90B6F4A2; Mon, 13 Mar 2023 22:02:46 -0700 (PDT) Received: from loth.rohan.me.apana.org.au ([192.168.167.2]) by formenos.hmeau.com with smtp (Exim 4.94.2 #2 (Debian)) id 1pbwo3-003zBJ-Lv; Tue, 14 Mar 2023 13:02:40 +0800 Received: by loth.rohan.me.apana.org.au (sSMTP sendmail emulation); Tue, 14 Mar 2023 13:02:39 +0800 Date: Tue, 14 Mar 2023 13:02:39 +0800 From: Herbert Xu To: Stephen Rothwell Cc: Linux Crypto List , Linux Kernel Mailing List , Linux Next Mailing List Subject: [PATCH] crypto: hash - Fix kdoc errors about HASH_ALG_COMMON Message-ID: References: <20230314141947.18574ae8@canb.auug.org.au> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20230314141947.18574ae8@canb.auug.org.au> Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" On Tue, Mar 14, 2023 at 02:19:47PM +1100, Stephen Rothwell wrote: > Hi all, >=20 > After merging the crypto tree, today's linux-next build (htmldocs) > produced these warnings: >=20 > include/crypto/hash.h:69: error: Cannot parse struct or union! > include/crypto/hash.h:69: error: Cannot parse struct or union! > include/crypto/hash.h:245: warning: Function parameter or member 'HASH_AL= G_COMMON' not described in 'shash_alg' > include/crypto/hash.h:69: error: Cannot parse struct or union! > include/crypto/hash.h:69: error: Cannot parse struct or union! > include/crypto/hash.h:69: error: Cannot parse struct or union! > include/crypto/hash.h:69: error: Cannot parse struct or union! > include/crypto/hash.h:69: error: Cannot parse struct or union! > include/crypto/hash.h:69: error: Cannot parse struct or union! >=20 > Introduced by commit >=20 > 0e4e6d7094df ("crypto: hash - Count error stats differently") Thanks for the report Stephen. I hope this patch makes them go away: Reported-by: Stephen Rothwell ---8<--- The HASH_ALG_COMMON macro cannot be parsed by kdoc so mark it as a normal comment instead of kdoc. Also add HASH_ALG_COMMON as a structure member of shash_alg. Fixes: 0e4e6d7094df ("crypto: hash - Count error stats differently") Reported-by: Stephen Rothwell Signed-off-by: Herbert Xu diff --git a/include/crypto/hash.h b/include/crypto/hash.h index 2aa61e7679db..1ed674ba8429 100644 --- a/include/crypto/hash.h +++ b/include/crypto/hash.h @@ -41,7 +41,7 @@ struct crypto_istat_hash { #define HASH_ALG_COMMON_STAT #endif =20 -/** +/* * struct hash_alg_common - define properties of message digest * @stat: Statistics for hash algorithm. * @digestsize: Size of the result of the transformation. A buffer of this= size @@ -219,6 +219,7 @@ struct shash_desc { * @stat: Statistics for hash algorithm. * @base: internally used * @halg: see struct hash_alg_common + * @HASH_ALG_COMMON: see struct hash_alg_common */ struct shash_alg { int (*init)(struct shash_desc *desc); --=20 Email: Herbert Xu Home Page: http://gondor.apana.org.au/~herbert/ PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt