about summary refs log tree commit diff
path: root/src/libstd/io
diff options
context:
space:
mode:
authorNathan <nathanrsizemore@gmail.com>2015-11-30 21:23:19 -0500
committerNathan <nathanrsizemore@gmail.com>2016-01-02 00:27:16 -0500
commit3e9d5fea48f616c1052d38e67b18e98624210867 (patch)
tree724e38596f789d0271be4062e9a2da484ef679c5 /src/libstd/io
parent66e842b6de633dd1099992782d1175c366ee27f7 (diff)
Adjusted heading and created dedicated section in std::io docs
Diffstat (limited to 'src/libstd/io')
-rw-r--r--src/libstd/io/mod.rs9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index 8ac46bf51f1..b5ba6ff54c0 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -238,6 +238,15 @@
 //!
 //! [result]: type.Result.html
 //! [try]: ../macro.try!.html
+//!
+//! ## Platform-specific behavior
+//!
+//! Many I/O functions throughout the standard library are documented to indicate
+//! what various library or syscalls they are delegated to. This is done to help
+//! applications both understand what's happening under the hood as well as investigate
+//! any possibly unclear semantics. Note, however, that this is informative, not a binding
+//! contract. The implementation of many of these functions are subject to change over
+//! time and may call fewer or more syscalls/library functions.
 
 #![stable(feature = "rust1", since = "1.0.0")]