summaryrefslogtreecommitdiff
path: root/Documentation/serial/driver
diff options
context:
space:
mode:
authorGeert Uytterhoeven <geert+renesas@glider.be>2016-04-14 11:08:08 +0200
committerJonathan Corbet <corbet@lwn.net>2016-04-15 15:59:01 -0600
commitd124fd3bb36ceb40438f10c897ce642386b74b72 (patch)
treef4acbe26e65204ebf6daaab2d9789edb712f17fe /Documentation/serial/driver
parent63f8e8d2a575ef62e5b705516b491a98a60517ff (diff)
serial: doc: Re-add paragraph documenting uart_console_write()
Commit 834392a7d92677ff ("serial: doc: Un-document non-existing uart_write_console()") removed a paragraph about a helper function that seemed to never exist. Peter Hurley pointed out that the function does exist, but is called differently. Re-add the paragraph, with the function name corrected. Fixes: 834392a7d92677ff ("serial: doc: Un-document non-existing uart_write_console()") Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/serial/driver')
-rw-r--r--Documentation/serial/driver5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/serial/driver b/Documentation/serial/driver
index 65de49a4b39e..03369d076ca2 100644
--- a/Documentation/serial/driver
+++ b/Documentation/serial/driver
@@ -28,6 +28,11 @@ The serial core provides a few helper functions. This includes identifing
the correct port structure (via uart_get_console) and decoding command line
arguments (uart_parse_options).
+There is also a helper function (uart_console_write) which performs a
+character by character write, translating newlines to CRLF sequences.
+Driver writers are recommended to use this function rather than implementing
+their own version.
+
Locking
-------