[PATCH] fs/open.c: Fix W=1 kernel doc warnings

[PATCH] fs/open.c: Fix W=1 kernel doc warnings

[Anuradha Weeraman]

fs/open.c: In functions 'setattr_vfsuid' and 'setattr_vfsgid':
 warning: Function parameter or member 'attr' not described
 - Fix warning by removing kernel-doc for these as they are static
   inline functions and not required to be exposed via kernel-doc.

fs/open.c:
 warning: Excess function parameter 'opened' description in 'finish_open'
 warning: Excess function parameter 'cred' description in 'vfs_open'
 - Fix by removing the parameters from the kernel-doc as they are no
   longer required by the function.

Signed-off-by: Anuradha Weeraman <anuradha@debian.org>
---
 fs/open.c | 12 ++----------
 1 file changed, 2 insertions(+), 10 deletions(-)

diff --git a/fs/open.c b/fs/open.c
index 4401a73d4032..fd8fa5936b51 100644
--- a/fs/open.c
+++ b/fs/open.c
@@ -700,10 +700,7 @@ SYSCALL_DEFINE2(chmod, const char __user *, filename, umode_t, mode)
 	return do_fchmodat(AT_FDCWD, filename, mode);
 }
 
-/**
- * setattr_vfsuid - check and set ia_fsuid attribute
- * @kuid: new inode owner
- *
+/*
  * Check whether @kuid is valid and if so generate and set vfsuid_t in
  * ia_vfsuid.
  *
@@ -718,10 +715,7 @@ static inline bool setattr_vfsuid(struct iattr *attr, kuid_t kuid)
 	return true;
 }
 
-/**
- * setattr_vfsgid - check and set ia_fsgid attribute
- * @kgid: new inode owner
- *
+/*
  * Check whether @kgid is valid and if so generate and set vfsgid_t in
  * ia_vfsgid.
  *
@@ -989,7 +983,6 @@ static int do_dentry_open(struct file *f,
  * @file: file pointer
  * @dentry: pointer to dentry
  * @open: open callback
- * @opened: state of open
  *
  * This can be used to finish opening a file passed to i_op->atomic_open().
  *
@@ -1043,7 +1036,6 @@ EXPORT_SYMBOL(file_path);
  * vfs_open - open the file at the given path
  * @path: path to open
  * @file: newly allocated file with f_flag initialized
- * @cred: credentials to use
  */
 int vfs_open(const struct path *path, struct file *file)
 {
-- 
2.39.2

Re: [PATCH] fs/open.c: Fix W=1 kernel doc warnings

[Christian Brauner]

On Sat, 06 May 2023 23:59:27 +0530, Anuradha Weeraman wrote:
> fs/open.c: In functions 'setattr_vfsuid' and 'setattr_vfsgid':
>  warning: Function parameter or member 'attr' not described
>  - Fix warning by removing kernel-doc for these as they are static
>    inline functions and not required to be exposed via kernel-doc.
> 
> fs/open.c:
>  warning: Excess function parameter 'opened' description in 'finish_open'
>  warning: Excess function parameter 'cred' description in 'vfs_open'
>  - Fix by removing the parameters from the kernel-doc as they are no
>    longer required by the function.
> 
> [...]

Applied to the vfs.misc branch of the vfs/vfs.git tree.
Patches in the vfs.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.misc

[1/1] fs/open.c: Fix W=1 kernel doc warnings
      https://git.kernel.org/vfs/vfs/c/1c4f10518c3a