ecryptfs: ecryptfs_kernel.h: clean up kernel-doc comments

Browse source

- 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 <rdunlap@infradead.org>
Signed-off-by: Tyler Hicks <code@tyhicks.com>

...

This commit is contained in:

Randy Dunlap 2026-07-21 17:08:12 -07:00 • committed by Tyler Hicks

parent 21a6287ae2

commit f81cb44f9a

1 changed files with 6 additions and 6 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

12

fs/ecryptfs/ecryptfs_kernel.h

View file