Re: [PATCH] ecryptfs: ecryptfs_kernel.h: clean up kernel-doc comments
Tyler Hicks <[email protected]> Wed, 22 Jul 2026 20:01:02 -0500
| Newsgroups | org.kernel.vger.ecryptfs,org.kernel.vger.linux-fsdevel |
|---|---|
| Message-ID | <178476842590.100088.4245942333108072614.b4-ty@b4> |
On Tue, 21 Jul 2026 17:08:12 -0700, Randy Dunlap wrote:
> - don't use "/**" for non-kernel-doc comments
> - use the struct keyword when describing structs
> - delete one Excess struct member
>
> to prevent the following warnings:
>
> Warning: ./fs/ecryptfs/ecryptfs_kernel.h:14 cannot understand function
> prototype: 'ECRYPTFS_KERNEL_H'
> Warning: ./fs/ecryptfs/ecryptfs_kernel.h:207 This comment starts with
> '/**', but isn't a kernel-doc comment.
> * This is the primary struct associated with each encrypted file.
> Warning: ./fs/ecryptfs/ecryptfs_kernel.h:275 cannot understand function
> prototype: 'struct ecryptfs_global_auth_tok'
> Warning: fs/ecryptfs/ecryptfs_kernel.h:283 Excess struct member
> 'global_auth_tok' description in 'ecryptfs_global_auth_tok'
> Warning: ./fs/ecryptfs/ecryptfs_kernel.h:298 cannot understand function
> prototype: 'struct ecryptfs_key_tfm'
> Warning: ./fs/ecryptfs/ecryptfs_kernel.h:309 This comment starts with
> '/**', but isn't a kernel-doc comment.
> * This struct is to enable a mount-wide passphrase/salt combo. This
>
> [...]
Thank you! This has been applied to the next branch of the tyhicks/ecryptfs.git tree.
You can find a direct link below but please be aware that the commit hash is
unstable and, therefore, the URL may not be valid in the future.
[1/1] ecryptfs: ecryptfs_kernel.h: clean up kernel-doc comments
https://git.kernel.org/tyhicks/ecryptfs/c/f81cb44f9a4b88d73ee5dec4a1ccdb0232fd2e3f
Tyler