mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Herbert Xu <herbert@gondor.apana.org.au>
To: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Linux Crypto List <linux-crypto@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: [PATCH] crypto: hash - Fix kdoc errors about HASH_ALG_COMMON
Date: Tue, 14 Mar 2023 13:02:39 +0800	[thread overview]
Message-ID: <ZA//781k0UXRIKdW@gondor.apana.org.au> (raw)
In-Reply-To: <20230314141947.18574ae8@canb.auug.org.au>

On Tue, Mar 14, 2023 at 02:19:47PM +1100, Stephen Rothwell wrote:
> Hi all,
> 
> After merging the crypto tree, today's linux-next build (htmldocs)
> produced these warnings:
> 
> 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_ALG_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!
> 
> Introduced by commit
> 
>   0e4e6d7094df ("crypto: hash - Count error stats differently")

Thanks for the report Stephen.  I hope this patch makes them go
away:

---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 <sfr@canb.auug.org.au>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

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
 
-/**
+/*
  * 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);
-- 
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

      reply	other threads:[~2023-03-14  5:02 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-14  3:19 linux-next: build warnings after merge of the crypto tree Stephen Rothwell
2023-03-14  5:02 ` Herbert Xu [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ZA//781k0UXRIKdW@gondor.apana.org.au \
    --to=herbert@gondor.apana.org.au \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®