]> www.infradead.org Git - nvme.git/commitdiff
ipe: policy_fs: fix kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Sat, 11 Jan 2025 06:33:18 +0000 (22:33 -0800)
committerFan Wu <wufan@kernel.org>
Mon, 24 Mar 2025 20:36:00 +0000 (13:36 -0700)
Use the "struct" keyword in kernel-doc when describing struct
ipefs_file. Add kernel-doc for the struct members also.

Don't use kernel-doc notation for 'policy_subdir'. kernel-doc does
not support documentation comments for data definitions.

This eliminates multiple kernel-doc warnings:

security/ipe/policy_fs.c:21: warning: cannot understand function prototype: 'struct ipefs_file '
security/ipe/policy_fs.c:407: warning: cannot understand function prototype: 'const struct ipefs_file policy_subdir[] = '

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Fan Wu <wufan@kernel.org>
Cc: Paul Moore <paul@paul-moore.com>
Cc: James Morris <jmorris@namei.org>
Cc: Serge E. Hallyn <serge@hallyn.com>
Cc: linux-security-module@vger.kernel.org
Signed-off-by: Fan Wu <wufan@kernel.org>
security/ipe/policy_fs.c

index 3bcd8cbd09dff320883873087cfd0eb17d6720a2..4cb4dd7f523637fc6ead9bfe684831be9e869497 100644 (file)
 #define MAX_VERSION_SIZE ARRAY_SIZE("65535.65535.65535")
 
 /**
- * ipefs_file - defines a file in securityfs.
+ * struct ipefs_file - defines a file in securityfs.
+ *
+ * @name: file name inside the policy subdirectory
+ * @access: file permissions
+ * @fops: &file_operations specific to this file
  */
 struct ipefs_file {
        const char *name;
@@ -401,7 +405,7 @@ static const struct file_operations delete_fops = {
        .write = delete_policy,
 };
 
-/**
+/*
  * policy_subdir - files under a policy subdirectory
  */
 static const struct ipefs_file policy_subdir[] = {