linux-kernel - [PATCH v2] fs: namei: fix two excess parameter description warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <HK0PR01MB2801A4C374BC28C8C98BA7EDF80E9@HK0PR01MB2801.apcprd01.prod.exchangelabs.com>
Date:   Fri, 25 Nov 2022 23:46:03 +0530
From:   Kushagra Verma <kushagra765@...look.com>
To:     Alexander Viro <viro@...iv.linux.org.uk>,
        linux-fsdevel@...r.kernel.org, linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>
Subject: [PATCH v2] fs: namei: fix two excess parameter description warnings

While building the kernel documentation, two excess parameter description
warnings appear:
	./fs/namei.c:3589: warning: Excess function parameter 'dentry'
	description in 'vfs_tmpfile'
	./fs/namei.c:3589: warning: Excess function parameter 'open_flag'
	description in 'vfs_tmpfile'

Fix these warnings by changing 'dentry' to 'parentpath' in the parameter
description and 'open_flag' to 'file' and change 'file' parameter's
description accordingly.

Tested-by: Randy Dunlap <rdunlap@...radead.org>
Signed-off-by: Kushagra Verma <kushagra765@...look.com>
---
v1 -> v2: Add Randy Dunlap's Tested-by tag

 fs/namei.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/fs/namei.c b/fs/namei.c
index 578c2110df02..8e77e194fed5 100644
--- a/fs/namei.c
+++ b/fs/namei.c
@@ -3571,9 +3571,9 @@ static int do_open(struct nameidata *nd,
 /**
  * vfs_tmpfile - create tmpfile
  * @mnt_userns:	user namespace of the mount the inode was found from
- * @dentry:	pointer to dentry of the base directory
+ * @parentpath:	pointer to dentry of the base directory
  * @mode:	mode of the new tmpfile
- * @open_flag:	flags
+ * @file:	file information
  *
  * Create a temporary file.
  *
-- 
2.38.1