diff options
| author |   Lukas Bulwahn <lukas.bulwahn@gmail.com> | 2021-01-15 13:03:42 +0100 |
|---|---|---|
| committer |   Paul Moore <paul@paul-moore.com> | 2021-01-15 12:17:25 -0500 |
| commit | 365982aba1f264dba26f0908700d62bfa046918c (patch) | |
| tree | fc3875466e7f1456a5263ab8ef541959662e35cb /fs/anon_inodes.c | |
| parent | userfaultfd: use secure anon inodes for userfaultfd (diff) | |
| download | linux-dev-365982aba1f264dba26f0908700d62bfa046918c.tar.xz linux-dev-365982aba1f264dba26f0908700d62bfa046918c.zip | |
fs: anon_inodes: rephrase to appropriate kernel-doc
Commit e7e832ce6fa7 ("fs: add LSM-supporting anon-inode interface") adds
more kerneldoc description, but also a few new warnings on
anon_inode_getfd_secure() due to missing parameter descriptions.
Rephrase to appropriate kernel-doc for anon_inode_getfd_secure().
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Signed-off-by: Paul Moore <paul@paul-moore.com>
Diffstat (limited to 'fs/anon_inodes.c')
| -rw-r--r-- | fs/anon_inodes.c | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/fs/anon_inodes.c b/fs/anon_inodes.c index 023337d65a03..a280156138ed 100644 --- a/fs/anon_inodes.c +++ b/fs/anon_inodes.c @@ -202,13 +202,20 @@ int anon_inode_getfd(const char *name, const struct file_operations *fops, EXPORT_SYMBOL_GPL(anon_inode_getfd); /** - * Like anon_inode_getfd(), but creates a new !S_PRIVATE anon inode rather than - * reuse the singleton anon inode, and calls the inode_init_security_anon() LSM - * hook. This allows the inode to have its own security context and for a LSM - * to reject creation of the inode. An optional @context_inode argument is - * also added to provide the logical relationship with the new inode. The LSM - * may use @context_inode in inode_init_security_anon(), but a reference to it - * is not held. + * anon_inode_getfd_secure - Like anon_inode_getfd(), but creates a new + * !S_PRIVATE anon inode rather than reuse the singleton anon inode, and calls + * the inode_init_security_anon() LSM hook. This allows the inode to have its + * own security context and for a LSM to reject creation of the inode. + * + * @name: [in] name of the "class" of the new file + * @fops: [in] file operations for the new file + * @priv: [in] private data for the new file (will be file's private_data) + * @flags: [in] flags + * @context_inode: + * [in] the logical relationship with the new inode (optional) + * + * The LSM may use @context_inode in inode_init_security_anon(), but a + * reference to it is not held. */ int anon_inode_getfd_secure(const char *name, const struct file_operations *fops, void *priv, int flags, |