|author||Alan <firstname.lastname@example.org>||2007-05-08 00:24:21 -0700|
|committer||Linus Torvalds <email@example.com>||2007-05-08 11:14:59 -0700|
tty: Clarify documentation of ->write()
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 <firstname.lastname@example.org> Signed-off-by: Andrew Morton <email@example.com> Signed-off-by: Linus Torvalds <firstname.lastname@example.org>
Diffstat (limited to 'Documentation')
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/tty.txt b/Documentation/tty.txt
index 5f799e612e0..048a8762cfb 100644
@@ -108,7 +108,9 @@ hardware driver through the function pointers within the tty->driver
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