From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Jiri Slaby <jirislaby@kernel.org>,
Paul Fulghum <paulkf@microgate.com>,
Michael Callahan <callahan@maths.ox.ac.uk>,
Al Longyear <longyear@netcom.com>,
Paul Mackerras <Paul.Mackerras@cs.anu.edu.au>
Subject: [PATCH 08/11] tty: n_hdlc: Fix a little doc-rot in n_hdlc_tty_read()
Date: Thu, 20 May 2021 13:19:03 +0100 [thread overview]
Message-ID: <20210520121906.3468725-9-lee.jones@linaro.org> (raw)
In-Reply-To: <20210520121906.3468725-1-lee.jones@linaro.org>
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>
---
drivers/tty/n_hdlc.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/drivers/tty/n_hdlc.c b/drivers/tty/n_hdlc.c
index d899ee4e0116f..580a37b3fe1b9 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.
*/
--
2.31.1
next prev parent reply other threads:[~2021-05-20 12:55 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-20 12:18 [PATCH 00/11] Rid W=1 warnings from TTY Lee Jones
2021-05-20 12:18 ` [PATCH 01/11] tty: vt: selection: Correct misspelled function sel_loadlut() Lee Jones
2021-05-20 12:18 ` [PATCH 02/11] tty: serdev: core: Fix misspelled function name __serdev_device_driver_register() Lee Jones
2021-05-20 12:18 ` [PATCH 03/11] tty: tty_io: Fix a few kernel-doc related misdemeanours Lee Jones
2021-05-20 12:18 ` [PATCH 04/11] tty: n_tty: Fix some misdocumented functions Lee Jones
2021-05-20 12:19 ` [PATCH 05/11] tty: tty_buffer: Fix incorrectly documented function __tty_buffer_request_room() Lee Jones
2021-05-20 12:19 ` [PATCH 06/11] tty: tty_jobctrl: Fix 2 incorrectly documented functions Lee Jones
2021-05-20 12:19 ` [PATCH 07/11] tty: pty: Fix incorrectly named function pty_resize() Lee Jones
2021-05-20 12:19 ` Lee Jones [this message]
2021-05-20 12:19 ` [PATCH 09/11] tty: serial: st-asc: Demote a kernel-doc formatting abuse Lee Jones
2021-05-20 12:19 ` [PATCH 10/11] tty: n_gsm: Fix function naming and provide missing param descriptions Lee Jones
2021-05-20 12:19 ` [PATCH 11/11] tty: serial: xilinx_uartps: Fix documentation for cdns_uart_clk_notifier_cb() Lee Jones
2021-05-20 12:21 ` Michal Simek
2021-05-20 15:07 ` [PATCH 00/11] Rid W=1 warnings from TTY Greg Kroah-Hartman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210520121906.3468725-9-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=Paul.Mackerras@cs.anu.edu.au \
--cc=callahan@maths.ox.ac.uk \
--cc=gregkh@linuxfoundation.org \
--cc=jirislaby@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=longyear@netcom.com \
--cc=paulkf@microgate.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®