serial: doc: Re-add paragraph documenting uart_console_write()
authorGeert Uytterhoeven <geert+renesas@glider.be>
Thu, 14 Apr 2016 09:08:08 +0000 (11:08 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 15 Apr 2016 21:59:01 +0000 (15:59 -0600)
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>
Documentation/serial/driver

index 65de49a4b39e5baff983dd61509d9e5030e7df03..03369d076ca20a9872d6e1fa18b0729e712aa166 100644 (file)
@@ -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
 -------