aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/tty/n_hdlc.c
diff options
context:
space:
mode:
authorLee Jones <lee.jones@linaro.org>2021-05-20 13:19:03 +0100
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2021-05-20 17:06:17 +0200
commitef80f77ba29ec824e249d15b63d6a1cddd7eebd2 (patch)
treef6785eb3cc28f4a04cd4c89f66f765a0a2314209 /drivers/tty/n_hdlc.c
parenttty: tty_jobctrl: Fix 2 incorrectly documented functions (diff)
downloadlinux-dev-ef80f77ba29ec824e249d15b63d6a1cddd7eebd2.tar.xz
linux-dev-ef80f77ba29ec824e249d15b63d6a1cddd7eebd2.zip
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>
Diffstat (limited to '')
-rw-r--r--drivers/tty/n_hdlc.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/drivers/tty/n_hdlc.c b/drivers/tty/n_hdlc.c
index d899ee4e0116..580a37b3fe1b 100644
--- a/drivers/tty/n_hdlc.c
+++ b/drivers/tty/n_hdlc.c
@@ -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.
*/