net/core: Document all dev_ioctl() arguments
authorBart Van Assche <bvanassche@acm.org>
Mon, 25 Mar 2019 16:17:20 +0000 (09:17 -0700)
committerDavid S. Miller <davem@davemloft.net>
Wed, 27 Mar 2019 20:49:43 +0000 (13:49 -0700)
This patch avoids that the following warnings are reported when building
with W=1:

net/core/dev_ioctl.c:378: warning: Function parameter or member 'ifr' not described in 'dev_ioctl'
net/core/dev_ioctl.c:378: warning: Function parameter or member 'need_copyout' not described in 'dev_ioctl'
net/core/dev_ioctl.c:378: warning: Excess function parameter 'arg' description in 'dev_ioctl'

Cc: Al Viro <viro@zeniv.linux.org.uk>
Fixes: 44c02a2c3dc5 ("dev_ioctl(): move copyin/copyout to callers") # v4.16.
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
net/core/dev_ioctl.c

index 31380fd5a4e2ace4736384c3f182381768e3e0d5..5163d900bb4fb1057e273ed667e9457f05b33c93 100644 (file)
@@ -366,7 +366,8 @@ EXPORT_SYMBOL(dev_load);
  *     dev_ioctl       -       network device ioctl
  *     @net: the applicable net namespace
  *     @cmd: command to issue
- *     @arg: pointer to a struct ifreq in user space
+ *     @ifr: pointer to a struct ifreq in user space
+ *     @need_copyout: whether or not copy_to_user() should be called
  *
  *     Issue ioctl functions to devices. This is normally called by the
  *     user space syscall interfaces but can sometimes be useful for