about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/libcore/libc.rs14
1 files changed, 13 insertions, 1 deletions
diff --git a/src/libcore/libc.rs b/src/libcore/libc.rs
index 79bb375d360..fdb82a7303b 100644
--- a/src/libcore/libc.rs
+++ b/src/libcore/libc.rs
@@ -9,7 +9,19 @@
 // except according to those terms.
 
 /*!
-* Bindings for libc.
+* Bindings for the C standard library and other platform libraries
+*
+* This module contains bindings to the C standard library,
+* organized into modules by their defining standard.
+* Additionally, it contains some assorted platform-specific definitions.
+* For convenience, most functions and types are reexported from `core::libc`,
+* so `pub use core::libc::*` will import the available
+* C bindings as appropriate for the target platform. The exact
+* set of functions available are platform specific.
+*
+* *Note* Rustdoc does not indicate reexports currently. Also, because these
+* definitions are platform-specific, some may not
+* appear in the generated documentation.
 *
 * We consider the following specs reasonably normative with respect
 * to interoperating with the C standard library (libc/msvcrt):