[PATCH 04/11] tty: n_tty: Fix some misdocumented functions

From: Lee Jones
Date: Thu May 20 2021 - 08:54:25 EST


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: Function parameter or member 'kbuf' not described in 'n_tty_read'
drivers/tty/n_tty.c:2132: warning: Function parameter or member 'cookie' not described in 'n_tty_read'
drivers/tty/n_tty.c:2132: warning: Function parameter or member 'offset' not described in 'n_tty_read'
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>
---
drivers/tty/n_tty.c | 10 +++++-----
drivers/tty/tty_io.c | 2 +-
2 files changed, 6 insertions(+), 6 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
@@ -596,7 +596,7 @@ static ssize_t process_output_block(struct tty_struct *tty,
}

/**
- * process_echoes - write pending echo characters
+ * __process_echoes - write pending echo characters
* @tty: terminal device
*
* Write previously buffered echo (and other ldisc-generated)
@@ -1092,7 +1092,7 @@ static void eraser(unsigned char c, struct tty_struct *tty)
}

/**
- * isig - handle the ISIG optio
+ * __isig - handle the ISIG optio
* @sig: signal
* @tty: terminal
*
@@ -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
* @tty: terminal device
* @c: character
*
@@ -2042,11 +2042,11 @@ static int job_control(struct tty_struct *tty, struct file *file)
}


-/**
+/*
* 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
diff --git a/drivers/tty/tty_io.c b/drivers/tty/tty_io.c
index defea9cc20ce9..7431c9e0c2bfe 100644
--- a/drivers/tty/tty_io.c
+++ b/drivers/tty/tty_io.c
@@ -1090,7 +1090,7 @@ void tty_write_message(struct tty_struct *tty, char *msg)


/*
- * tty_write - write method for tty device file
+ * file_tty_write - write method for tty device file
* @file: tty file pointer
*
* Write data to a tty device via the line discipline.
--
2.31.1