Skip to content

Commit

Permalink
ipe: policy_fs: fix kernel-doc warnings
Browse files Browse the repository at this point in the history
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 <[email protected]>
Cc: Fan Wu <[email protected]>
Cc: Paul Moore <[email protected]>
Cc: James Morris <[email protected]>
Cc: Serge E. Hallyn <[email protected]>
Cc: [email protected]
Signed-off-by: Fan Wu <[email protected]>
  • Loading branch information
rddunlap authored and jxwufan committed Jan 20, 2025
1 parent 5bc55a3 commit aefadf0
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions security/ipe/policy_fs.c
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@
#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;
Expand Down Expand Up @@ -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[] = {
Expand Down

0 comments on commit aefadf0

Please sign in to comment.