[PATCH] tty: Clarify documentation of ->write()
Date: Wed Feb 21 2007 - 10:13:44 EST
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@xxxxxxxxxx>
diff -u --new-file --recursive --exclude-from /usr/src/exclude linux.vanilla-2.6.20-mm2/Documentation/tty.txt linux-2.6.20-mm2/Documentation/tty.txt
--- linux.vanilla-2.6.20-mm2/Documentation/tty.txt 2007-02-20 12:32:28.000000000 +0000
+++ linux-2.6.20-mm2/Documentation/tty.txt 2007-02-21 14:56:36.521024464 +0000
@@ -108,7 +108,9 @@
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
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/