linux-kernel - Re: kernel-doc comment with anonymous variable in anonymous union?

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <aT_XmzUSkbFMLHK4@gondor.apana.org.au>
Date: Mon, 15 Dec 2025 17:40:43 +0800
From: Herbert Xu <herbert@...dor.apana.org.au>
To: Bagas Sanjaya <bagasdotme@...il.com>
Cc: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Crypto <linux-crypto@...r.kernel.org>,
	Linux Documentation <linux-doc@...r.kernel.org>,
	Randy Dunlap <rdunlap@...radead.org>,
	"David S. Miller" <davem@...emloft.net>,
	Jonathan Corbet <corbet@....net>
Subject: Re: kernel-doc comment with anonymous variable in anonymous union?

On Mon, Dec 15, 2025 at 04:12:44PM +0700, Bagas Sanjaya wrote:
> Hi,
> 
> kernel-doc reports warning on include/crypto/skcipher.h:
> 
> WARNING: ./include/crypto/skcipher.h:166 struct member 'SKCIPHER_ALG_COMMON' not described in 'skcipher_alg'
> 
> skciper_alg struct is defined as:
> 
> struct skcipher_alg {
> 	int (*setkey)(struct crypto_skcipher *tfm, const u8 *key,
> 	              unsigned int keylen);
> 	int (*encrypt)(struct skcipher_request *req);
> 	int (*decrypt)(struct skcipher_request *req);
> 	int (*export)(struct skcipher_request *req, void *out);
> 	int (*import)(struct skcipher_request *req, const void *in);
> 	int (*init)(struct crypto_skcipher *tfm);
> 	void (*exit)(struct crypto_skcipher *tfm);
> 
> 	unsigned int walksize;
> 
> 	union {
> 		struct SKCIPHER_ALG_COMMON;
> 		struct skcipher_alg_common co;
> 	};
> };
> 
> Note the first member in the union, which is an anonymous (i.e. unnamed) variable.
> 
> What can I do on it? Should the offending member be deleted?

You could either add a comment about SKCIPHER_ALG_COMMON, or
fix up all the code that uses it by adding "co."

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