Commit ef80f77b authored May 20, 2021 by Lee Jones Committed by Greg Kroah-Hartman May 20, 2021

tty: n_hdlc: Fix a little doc-rot in n_hdlc_tty_read()

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

drivers/tty/n_hdlc.c:421: warning: Function parameter or member 'kbuf' not described in 'n_hdlc_tty_read'
drivers/tty/n_hdlc.c:421: warning: Function parameter or member 'cookie' not described in 'n_hdlc_tty_read'
drivers/tty/n_hdlc.c:421: warning: Function parameter or member 'offset' not described in 'n_hdlc_tty_read'
drivers/tty/n_hdlc.c:421: warning: Excess function parameter 'buf' description in 'n_hdlc_tty_read'

Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jiri Slaby <jirislaby@kernel.org>
Cc: Paul Fulghum <paulkf@microgate.com>
Cc: Michael Callahan <callahan@maths.ox.ac.uk>
Cc: Al Longyear <longyear@netcom.com>
Cc: Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20210520121906.3468725-9-lee.jones@linaro.org

Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

parent 6ef6785d

drivers/tty/n_hdlc.c

+3 −1

Original line number	Diff line number	Diff line
		@@ -411,8 +411,10 @@ static void n_hdlc_tty_receive(struct tty_struct tty, const __u8 data,
		* n_hdlc_tty_read - Called to retrieve one frame of data (if available)
		* @tty: pointer to tty instance data
		* @file: pointer to open file object
		* @buf: pointer to returned data buffer
		* @kbuf: pointer to returned data buffer
		* @nr: size of returned data buffer
		* @cookie: stored rbuf from previous run
		* @offset: offset into the data buffer
		*
		* Returns the number of bytes returned or error code.
		*/