diff mbox series

[v3,1/9] ima: Fix documentation-related warnings in ima_main.c

Message ID 20220302111404.193900-2-roberto.sassu@huawei.com
State Accepted
Commit bae60eefb95ca8f2abebaf157d4815ce8fbb0e75
Headers show
Series bpf-lsm: Extend interoperability with IMA | expand

Commit Message

Roberto Sassu March 2, 2022, 11:13 a.m. UTC 
Fix the following warnings in ima_main.c, displayed with W=n make argument:

security/integrity/ima/ima_main.c:432: warning: Function parameter or
                          member 'vma' not described in 'ima_file_mprotect'
security/integrity/ima/ima_main.c:636: warning: Function parameter or
                  member 'inode' not described in 'ima_post_create_tmpfile'
security/integrity/ima/ima_main.c:636: warning: Excess function parameter
                            'file' description in 'ima_post_create_tmpfile'
security/integrity/ima/ima_main.c:843: warning: Function parameter or
                     member 'load_id' not described in 'ima_post_load_data'
security/integrity/ima/ima_main.c:843: warning: Excess function parameter
                                   'id' description in 'ima_post_load_data'

Also, fix some style issues in the description of ima_post_create_tmpfile()
and ima_post_path_mknod().

Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Roberto Sassu <roberto.sassu@huawei.com>
---
 security/integrity/ima/ima_main.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

Comments

Mimi Zohar March 6, 2022, 7:24 p.m. UTC | #1 
On Wed, 2022-03-02 at 12:13 +0100, Roberto Sassu wrote:
> Fix the following warnings in ima_main.c, displayed with W=n make argument:
> 
> security/integrity/ima/ima_main.c:432: warning: Function parameter or
>                           member 'vma' not described in 'ima_file_mprotect'
> security/integrity/ima/ima_main.c:636: warning: Function parameter or
>                   member 'inode' not described in 'ima_post_create_tmpfile'
> security/integrity/ima/ima_main.c:636: warning: Excess function parameter
>                             'file' description in 'ima_post_create_tmpfile'
> security/integrity/ima/ima_main.c:843: warning: Function parameter or
>                      member 'load_id' not described in 'ima_post_load_data'
> security/integrity/ima/ima_main.c:843: warning: Excess function parameter
>                                    'id' description in 'ima_post_load_data'
> 
> Also, fix some style issues in the description of ima_post_create_tmpfile()
> and ima_post_path_mknod().
> 
> Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>
> Signed-off-by: Roberto Sassu <roberto.sassu@huawei.com>

Reviewed-by: Mimi Zohar <zohar@linux.ibm.com>
diff mbox series

Patch

diff --git a/security/integrity/ima/ima_main.c b/security/integrity/ima/ima_main.c
index 8c6e4514d494..946ba8a12eab 100644
--- a/security/integrity/ima/ima_main.c
+++ b/security/integrity/ima/ima_main.c
@@ -418,6 +418,7 @@  int ima_file_mmap(struct file *file, unsigned long prot)
 
 /**
  * ima_file_mprotect - based on policy, limit mprotect change
+ * @vma: vm_area_struct protection is set to
  * @prot: contains the protection that will be applied by the kernel.
  *
  * Files can be mmap'ed read/write and later changed to execute to circumvent
@@ -610,8 +611,8 @@  EXPORT_SYMBOL_GPL(ima_inode_hash);
 
 /**
  * ima_post_create_tmpfile - mark newly created tmpfile as new
- * @mnt_userns:	user namespace of the mount the inode was found from
- * @file : newly created tmpfile
+ * @mnt_userns: user namespace of the mount the inode was found from
+ * @inode: inode of the newly created tmpfile
  *
  * No measuring, appraising or auditing of newly created tmpfiles is needed.
  * Skip calling process_measurement(), but indicate which newly, created
@@ -643,7 +644,7 @@  void ima_post_create_tmpfile(struct user_namespace *mnt_userns,
 
 /**
  * ima_post_path_mknod - mark as a new inode
- * @mnt_userns:	user namespace of the mount the inode was found from
+ * @mnt_userns: user namespace of the mount the inode was found from
  * @dentry: newly created dentry
  *
  * Mark files created via the mknodat syscall as new, so that the
@@ -814,8 +815,8 @@  int ima_load_data(enum kernel_load_data_id id, bool contents)
  * ima_post_load_data - appraise decision based on policy
  * @buf: pointer to in memory file contents
  * @size: size of in memory file contents
- * @id: kernel load data caller identifier
- * @description: @id-specific description of contents
+ * @load_id: kernel load data caller identifier
+ * @description: @load_id-specific description of contents
  *
  * Measure/appraise/audit in memory buffer based on policy.  Policy rules
  * are written in terms of a policy identifier.