Skip to content

Commit

Permalink
tty: Clarify documentation of ->write()
Browse files Browse the repository at this point in the history
The tty driver write method is different to the usual fops device write
methods as the buffer is already in kernel space. Clarify the docs since
someone writing a driver made that mistake.

Signed-off-by: Alan Cox <alan@redhat.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
  • Loading branch information
Alan authored and Linus Torvalds committed May 8, 2007
1 parent 3972b7f commit 6309ed7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Documentation/tty.txt
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,9 @@ hardware driver through the function pointers within the tty->driver
structure:

write() Write a block of characters to the tty device.
Returns the number of characters accepted.
Returns the number of characters accepted. The
character buffer passed to this method is already
in kernel space.

put_char() Queues a character for writing to the tty device.
If there is no room in the queue, the character is
Expand Down

0 comments on commit 6309ed7

Please sign in to comment.