linux-kernel - [PATCH -next] fs: fix doc warnings in ioctl.c

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20210608024548.2753635-1-libaokun1@huawei.com>
Date:   Tue, 8 Jun 2021 10:45:48 +0800
From:   Baokun Li <libaokun1@...wei.com>
To:     <viro@...iv.linux.org.uk>, <linux-fsdevel@...r.kernel.org>,
        <linux-kernel@...r.kernel.org>
CC:     <weiyongjun1@...wei.com>, <yuehaibing@...wei.com>,
        <yangjihong1@...wei.com>, <yukuai3@...wei.com>,
        <libaokun1@...wei.com>
Subject: [PATCH -next] fs: fix doc warnings in ioctl.c

Fixes the following W=1 kernel build warning(s):

 fs/ioctl.c:1101: warning: Function parameter or
  member 'file' not described in 'compat_ptr_ioctl'
 fs/ioctl.c:1101: warning: Function parameter or
  member 'cmd' not described in 'compat_ptr_ioctl'
 fs/ioctl.c:1101: warning: Function parameter or
  member 'arg' not described in 'compat_ptr_ioctl'

Signed-off-by: Baokun Li <libaokun1@...wei.com>
---
 fs/ioctl.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/fs/ioctl.c b/fs/ioctl.c
index 1e2204fa9963..b0ef5089ff29 100644
--- a/fs/ioctl.c
+++ b/fs/ioctl.c
@@ -1076,7 +1076,9 @@ SYSCALL_DEFINE3(ioctl, unsigned int, fd, unsigned int, cmd, unsigned long, arg)
 #ifdef CONFIG_COMPAT
 /**
  * compat_ptr_ioctl - generic implementation of .compat_ioctl file operation
- *
+ * @file:	open file to invoke ioctl method on
+ * @cmd:	ioctl command to execute
+ * @arg:	command-specific argument for ioctl
  * This is not normally called as a function, but instead set in struct
  * file_operations as
  *
-- 
2.31.1