Skip to contentSkip to conversation

tty: fix tty_ldisc_receive_buf() documentation

PATCH In review Johan Hovold 2 participants 3 messages Nov 3, 2017 – Nov 6, 2017 TTY layer and serial drivers

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tty: fix tty_ldisc_receive_buf() documentation

The tty_ldisc_receive_buf() helper returns the number of bytes processed so drop the bogus "not" from the kernel doc comment.

Fixes 8d082cd300ab ("tty: Unify receive_buf() code paths")
---
 drivers/tty/tty_buffer.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/tty/tty_buffer.c +1 -1
index f8eba1c5412f..677fa99b7747 100644
@@ -446,7 +446,7 @@ EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
  *	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)
Signature · 1 line
2.15.0
Reviewed-by on v1 1/1
#1 lore raw

Hi,

Quoted 6 lines · Johan Hovold

The tty_ldisc_receive_buf() helper returns the number of bytes processed so drop the bogus "not" from the kernel doc comment.

Fixes 8d082cd300ab ("tty: Unify receive_buf() code paths")

---

-- Sebastian

Quoted 19 lines
 drivers/tty/tty_buffer.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/tty/tty_buffer.c +1 -1
index f8eba1c5412f..677fa99b7747 100644
@@ -446,7 +446,7 @@ EXPORT_SYMBOL_GPL(tty_prepare_flip_string);
  *	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)
Signature · 1 line
2.15.0
#2 lore raw
Quoted 11 lines · Sebastian Reichel

Hi,

Quoted 6 lines · Johan Hovold

The tty_ldisc_receive_buf() helper returns the number of bytes processed so drop the bogus "not" from the kernel doc comment.

Fixes 8d082cd300ab ("tty: Unify receive_buf() code paths")

---

Thanks for the review. Greg already picked this one up for next though.

Johan