2018-01-04 00:11:14

by Samuel Thibault

[permalink] [raw]
Subject: tty: Fix comment for value returned by tty_ldisc_receive_buf

tty_ldisc_receive_buf actually returns the number of bytes processed by
receive_buf or receive_buf2.

Signed-off-by: Samuel Thibault <[email protected]>

---
drivers/tty/tty_buffer.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

--- a/drivers/tty/tty_buffer.c
+++ b/drivers/tty/tty_buffer.c
@@ -420,7 +420,7 @@ EXPORT_SYMBOL_GPL(tty_prepare_flip_strin
* Callers other than flush_to_ldisc() need to exclude the kworker
* from concurrent use of the line discipline, see paste_selection().
*
- * Returns the number of bytes not processed
+ * Returns the number of bytes processed
*/
int tty_ldisc_receive_buf(struct tty_ldisc *ld, const unsigned char *p,
char *f, int count)


2018-01-04 14:51:04

by Johan Hovold

[permalink] [raw]
Subject: Re: tty: Fix comment for value returned by tty_ldisc_receive_buf

On Thu, Jan 04, 2018 at 01:04:53AM +0100, Samuel Thibault wrote:
> tty_ldisc_receive_buf actually returns the number of bytes processed by
> receive_buf or receive_buf2.
>
> Signed-off-by: Samuel Thibault <[email protected]>
>
> ---
> drivers/tty/tty_buffer.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- a/drivers/tty/tty_buffer.c
> +++ b/drivers/tty/tty_buffer.c
> @@ -420,7 +420,7 @@ EXPORT_SYMBOL_GPL(tty_prepare_flip_strin
> * Callers other than flush_to_ldisc() need to exclude the kworker
> * from concurrent use of the line discipline, see paste_selection().
> *
> - * Returns the number of bytes not processed
> + * Returns the number of bytes processed
> */
> int tty_ldisc_receive_buf(struct tty_ldisc *ld, const unsigned char *p,
> char *f, int count)

This has already been fixed by commit e7e51dcf3b8a ("tty: fix
tty_ldisc_receive_buf() documentation").

Thanks,
Johan