linux-serial.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Geert Uytterhoeven <geert+renesas@glider.be>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jiri Slaby <jslaby@suse.com>, Jonathan Corbet <corbet@lwn.net>,
	Peter Hurley <peter@hurleysoftware.com>,
	Russell King <rmk@arm.linux.org.uk>
Cc: linux-serial@vger.kernel.org, linux-doc@vger.kernel.org,
	Geert Uytterhoeven <geert+renesas@glider.be>
Subject: [PATCH 1/4] serial: doc: Re-add paragraph documenting uart_console_write()
Date: Thu, 14 Apr 2016 11:08:08 +0200	[thread overview]
Message-ID: <1460624891-8389-2-git-send-email-geert+renesas@glider.be> (raw)
In-Reply-To: <1460624891-8389-1-git-send-email-geert+renesas@glider.be>

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>
---
 Documentation/serial/driver | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/serial/driver b/Documentation/serial/driver
index 65de49a4b39e5baf..03369d076ca20a98 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
 -------
-- 
1.9.1


  reply	other threads:[~2016-04-14  9:08 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-14  9:08 [PATCH 0/4] serial: doc: Low Level Serial API Documentation Improvements (take two) Geert Uytterhoeven
2016-04-14  9:08 ` Geert Uytterhoeven [this message]
2016-04-14  9:08 ` [PATCH 2/4] serial: doc: .(un)throttle() depends on hardware assisted flow control Geert Uytterhoeven
2016-04-14  9:08 ` [PATCH 3/4] serial: doc: .(un)throttle() are serialized by the tty layer Geert Uytterhoeven
2016-04-14  9:08 ` [PATCH 4/4] serial: doc: .break_ctl() may sleep Geert Uytterhoeven
2016-04-15 22:01   ` Jonathan Corbet
2016-04-15 22:31     ` Peter Hurley
2016-04-15 22:41       ` Jonathan Corbet
2016-04-15 23:07         ` Peter Hurley
2016-04-16 16:47           ` Jonathan Corbet
2016-04-18  8:24             ` Geert Uytterhoeven

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1460624891-8389-2-git-send-email-geert+renesas@glider.be \
    --to=geert+renesas@glider.be \
    --cc=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=jslaby@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-serial@vger.kernel.org \
    --cc=peter@hurleysoftware.com \
    --cc=rmk@arm.linux.org.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).