misc: pti: Fix documentation for bit-rotted function pti_tty_driver_write()
authorLee Jones <lee.jones@linaro.org>
Fri, 26 Jun 2020 13:05:25 +0000 (14:05 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 29 Jun 2020 16:45:53 +0000 (18:45 +0200)
commitba2104c24aba1fa7e19d53f08c985526a6786d8b
tree9ad4145c30069713e62003ada7fa8fd0d0a23919
parent9eea2a499fa86b0822d27f3cd34c4554c6a9c2e6
misc: pti: Fix documentation for bit-rotted function pti_tty_driver_write()

The API has moved on since the original function header was
authored.  This changes brings the function's documentation
back into line with reality, complete descriptions of the
latest arguments to be used.

Squashes the following W=1 kernel build warnings:

 drivers/misc/pti.c:510: warning: Function parameter or member 'tty' not described in 'pti_tty_driver_wr
 drivers/misc/pti.c:510: warning: Function parameter or member 'buf' not described in 'pti_tty_driver_wr
 drivers/misc/pti.c:510: warning: Excess function parameter 'filp' description in 'pti_tty_driver_write'
 drivers/misc/pti.c:510: warning: Excess function parameter 'data' description in 'pti_tty_driver_write'

Cc: J Freyensee <james_p_freyensee@linux.intel.com>
Acked-by: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200626130525.389469-11-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/misc/pti.c