[PATCH] ecryptfs: ecryptfs_kernel.h: clean up kernel-doc comments
Randy Dunlap <[email protected]> Tue, 21 Jul 2026 17:08:12 -0700
| Newsgroups | org.kernel.vger.ecryptfs,org.kernel.vger.linux-fsdevel |
|---|---|
| Message-ID | <[email protected]> |
- 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 Signed-off-by: Randy Dunlap <[email protected]> --- Cc: Tyler Hicks <[email protected]> Cc: [email protected] fs/ecryptfs/ecryptfs_kernel.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) --- linux-next-20260720.orig/fs/ecryptfs/ecryptfs_kernel.h +++ linux-next-20260720/fs/ecryptfs/ecryptfs_kernel.h @@ -1,5 +1,5 @@ /* SPDX-License-Identifier: GPL-2.0-or-later */ -/** +/* * eCryptfs: Linux filesystem encryption layer * Kernel declarations. * @@ -204,7 +204,7 @@ struct ecryptfs_filename { char dentry_name[ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN + 1]; }; -/** +/* * This is the primary struct associated with each encrypted file. * * TODO: cache align/pack? @@ -255,7 +255,8 @@ struct ecryptfs_inode_info { }; /** - * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint + * struct ecryptfs_global_auth_tok - A key used to encrypt all new files + * under the mountpoint * @flags: Status flags * @mount_crypt_stat_list: These auth_toks hang off the mount-wide * cryptographic context. Every time a new @@ -263,7 +264,6 @@ struct ecryptfs_inode_info { * the auth_toks on that list to the set of * auth_toks on the inode's crypt_stat * @global_auth_tok_key: The key from the user's keyring for the sig - * @global_auth_tok: The key contents * @sig: The key identifier * * ecryptfs_global_auth_tok structs refer to authentication token keys @@ -283,7 +283,7 @@ struct ecryptfs_global_auth_tok { }; /** - * ecryptfs_key_tfm - Persistent key tfm + * struct ecryptfs_key_tfm - Persistent key tfm * @key_tfm: crypto API handle to the key * @key_size: Key size in bytes * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is @@ -306,7 +306,7 @@ struct ecryptfs_key_tfm { extern struct mutex key_tfm_list_mutex; -/** +/* * This struct is to enable a mount-wide passphrase/salt combo. This * is more or less a stopgap to provide similar functionality to other * crypto filesystems like EncFS or CFS until full policy support is