From 4bfaa43eed7ea88fa581c875f5d1c1c801d64e5f Mon Sep 17 00:00:00 2001
From: Mike Hommey <mh@glandium.org>
Date: Tue, 12 Jul 2016 14:37:04 +0900
Subject: [PATCH] doc: Mention that writeln! and println! always use LF

Fixes #34697
---
 src/libcore/macros.rs | 2 ++
 src/libstd/macros.rs  | 4 +++-
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/libcore/macros.rs b/src/libcore/macros.rs
index 376d2792c445c..43868d124a22e 100644
--- a/src/libcore/macros.rs
+++ b/src/libcore/macros.rs
@@ -238,6 +238,8 @@ macro_rules! write {
 }
 
 /// Use the `format!` syntax to write data into a buffer, appending a newline.
+/// On all platforms, the newline is the LINE FEED character (`\n`/`U+000A`)
+/// alone (no additional CARRIAGE RETURN (`\r`/`U+000D`).
 ///
 /// This macro is typically used with a buffer of `&mut `[`Write`][write].
 ///
diff --git a/src/libstd/macros.rs b/src/libstd/macros.rs
index 26cf8a3199d1b..6f0f6ecab5ba8 100644
--- a/src/libstd/macros.rs
+++ b/src/libstd/macros.rs
@@ -98,7 +98,9 @@ macro_rules! print {
     ($($arg:tt)*) => ($crate::io::_print(format_args!($($arg)*)));
 }
 
-/// Macro for printing to the standard output, with a newline.
+/// Macro for printing to the standard output, with a newline. On all
+/// platforms, the newline is the LINE FEED character (`\n`/`U+000A`) alone
+/// (no additional CARRIAGE RETURN (`\r`/`U+000D`).
 ///
 /// Use the `format!` syntax to write data to the standard output.
 /// See `std::fmt` for more information.