[RESEND] fs: fix posix_acl.c kernel-doc warnings
diff mbox series

Message ID 29b0dc46-1f28-a4e5-b1d0-ba2b65629779@infradead.org
State New
Headers show
Series
  • [RESEND] fs: fix posix_acl.c kernel-doc warnings
Related show

Commit Message

Randy Dunlap Dec. 9, 2019, 4:30 a.m. UTC
From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warnings in fs/posix_acl.c.
Also fix one typo (setgit -> setgid).

../fs/posix_acl.c:647: warning: Function parameter or member 'inode' not described in 'posix_acl_update_mode'
../fs/posix_acl.c:647: warning: Function parameter or member 'mode_p' not described in 'posix_acl_update_mode'
../fs/posix_acl.c:647: warning: Function parameter or member 'acl' not described in 'posix_acl_update_mode'

Fixes: 073931017b49d ("posix_acl: Clear SGID bit when setting file permissions")

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jan Kara <jack@suse.cz>
Cc: Andreas Gruenbacher <agruenba@redhat.com>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: linux-fsdevel@vger.kernel.org
Acked-by: Andreas Gruenbacher <agruenba@redhat.com>
Reviewed-by: Jan Kara <jack@suse.cz>
---
v2: change *acl to *@acl

 fs/posix_acl.c |    7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Patch
diff mbox series

--- linux-next-20191209.orig/fs/posix_acl.c
+++ linux-next-20191209/fs/posix_acl.c
@@ -631,12 +631,15 @@  EXPORT_SYMBOL_GPL(posix_acl_create);
 
 /**
  * posix_acl_update_mode  -  update mode in set_acl
+ * @inode: target inode
+ * @mode_p: mode (pointer) for update
+ * @acl: acl pointer
  *
  * Update the file mode when setting an ACL: compute the new file permission
  * bits based on the ACL.  In addition, if the ACL is equivalent to the new
- * file mode, set *acl to NULL to indicate that no ACL should be set.
+ * file mode, set *@acl to NULL to indicate that no ACL should be set.
  *
- * As with chmod, clear the setgit bit if the caller is not in the owning group
+ * As with chmod, clear the setgid bit if the caller is not in the owning group
  * or capable of CAP_FSETID (see inode_change_ok).
  *
  * Called from set_acl inode operations.