Re: [PATCH v2 1/1] tty: n_tty: Fix some misdocumented functions

From: Jiri Slaby
Date: Thu May 27 2021 - 02:30:24 EST


On 26. 05. 21, 10:31, Lee Jones wrote:
Fixes the following W=1 kernel build warning(s):

drivers/tty/n_tty.c:623: warning: expecting prototype for process_echoes(). Prototype was for __process_echoes() instead
drivers/tty/n_tty.c:1109: warning: expecting prototype for isig(). Prototype was for __isig() instead
drivers/tty/n_tty.c:1268: warning: expecting prototype for n_tty_receive_char(). Prototype was for n_tty_receive_char_special() instead
drivers/tty/n_tty.c:2132: warning: Excess function parameter 'buf' description in 'n_tty_read'

Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
Cc: Jiri Slaby <jirislaby@xxxxxxxxxx>
Cc: "Andrew J. Kroll" <ag784@xxxxxxxxxxxxxxxxxxx>
Cc: processes-Sapan Bhatia <sapan@xxxxxxxxxxxx>
Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
---

v2: Rebased

drivers/tty/n_tty.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/tty/n_tty.c b/drivers/tty/n_tty.c
index 0ec93f1a61f5d..56d3b43d8a3a4 100644
--- a/drivers/tty/n_tty.c
+++ b/drivers/tty/n_tty.c
...
@@ -1248,7 +1248,7 @@ n_tty_receive_signal_char(struct tty_struct *tty, int signal, unsigned char c)
}
/**
- * n_tty_receive_char - perform processing
+ * n_tty_receive_char_special - perform processing

No, please move the doc to the function in this case instead.

* @tty: terminal device
* @c: character
*
@@ -2042,11 +2042,11 @@ static int job_control(struct tty_struct *tty, struct file *file)
}
-/**
+/*

Why this?

* n_tty_read - read function for tty
* @tty: tty device
* @file: file object
- * @buf: userspace buffer pointer
+ * @kbuf: userspace buffer pointer
* @nr: size of I/O
*
* Perform reads for the line discipline. We are guaranteed that the


thanks,
--
js
suse labs