Re: [PATCH 10/10] misc: pti: Fix documentation for bit-rotted function pti_tty_driver_write()

From: Arnd Bergmann
Date: Fri Jun 26 2020 - 10:40:33 EST


On Fri, Jun 26, 2020 at 3:05 PM Lee Jones <lee.jones@xxxxxxxxxx> wrote:
>
> 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@xxxxxxxxxxxxxxx>
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>

Acked-by: Arnd Bergmann <arnd@xxxxxxxx>