lsm: move the kernfs hook comments to security/security.c
authorPaul Moore <paul@paul-moore.com>
Fri, 10 Feb 2023 18:20:33 +0000 (13:20 -0500)
committerPaul Moore <paul@paul-moore.com>
Mon, 6 Mar 2023 18:41:07 +0000 (13:41 -0500)
This patch relocates the LSM hook function comments to the function
definitions, in keeping with the current kernel conventions.  This
should make the hook descriptions more easily discoverable and easier
to maintain.

While formatting changes have been done to better fit the kernel-doc
style, content changes have been kept to a minimum and limited to
text which was obviously incorrect and/or outdated.  It is expected
the future patches will improve the quality of the function header
comments.

Acked-by: Casey Schaufler <casey@schaufler-ca.com>
Signed-off-by: Paul Moore <paul@paul-moore.com>
include/linux/lsm_hooks.h
security/security.c

index 3cdd58424796b5d3445292f671e1bddb1fcfc280..c953f6c356f22c2b6d8766a223a53ada20a56e7d 100644 (file)
 /**
  * union security_list_options - Linux Security Module hook function list
  *
- * Security hooks for kernfs node operations
- *
- * @kernfs_init_security:
- *     Initialize the security context of a newly created kernfs node based
- *     on its own and its parent's attributes.
- *     @kn_dir the parent kernfs node.
- *     @kn the new child kernfs node.
- *     Return 0 if permission is granted.
- *
  * Security hooks for file operations
  *
  * @file_permission:
index bd35854f956a5fc5d88e016198c6eaabf19b08a4..b070a24157ecb227285842da7ba263f68bf0d459 100644 (file)
@@ -2344,6 +2344,16 @@ int security_inode_copy_up_xattr(const char *name)
 }
 EXPORT_SYMBOL(security_inode_copy_up_xattr);
 
+/**
+ * security_kernfs_init_security() - Init LSM context for a kernfs node
+ * @kn_dir: parent kernfs node
+ * @kn: the kernfs node to initialize
+ *
+ * Initialize the security context of a newly created kernfs node based on its
+ * own and its parent's attributes.
+ *
+ * Return: Returns 0 if permission is granted.
+ */
 int security_kernfs_init_security(struct kernfs_node *kn_dir,
                                  struct kernfs_node *kn)
 {