summaryrefslogtreecommitdiff
path: root/Documentation/tty.txt
diff options
context:
space:
mode:
authorAlan <alan@lxorguk.ukuu.org.uk>2007-05-08 11:24:21 +0400
committerLinus Torvalds <torvalds@woody.linux-foundation.org>2007-05-08 22:14:59 +0400
commit6309ed7cb2b0671b0db9386abc6307ec3108bbaa (patch)
treeb310c894dc328348b82b6fce109a686ff55abe2c /Documentation/tty.txt
parent3972b7f67bf1a352a4a4c350b2245d759a41ea06 (diff)
downloadlinux-6309ed7cb2b0671b0db9386abc6307ec3108bbaa.tar.xz
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 <alan@redhat.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation/tty.txt')
-rw-r--r--Documentation/tty.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/tty.txt b/Documentation/tty.txt
index 5f799e612e03..048a8762cfb5 100644
--- a/Documentation/tty.txt
+++ b/Documentation/tty.txt
@@ -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