diff options
| author | Brian Anderson <banderson@mozilla.com> | 2013-04-01 12:10:51 -0700 |
|---|---|---|
| committer | Brian Anderson <banderson@mozilla.com> | 2013-04-01 14:29:09 -0700 |
| commit | 37634f3363fa871b72d181920caa2ec23eb63135 (patch) | |
| tree | 879b2af9f22119b8c28f33017e0c5bdca8afd4f4 /src | |
| parent | 8e9fd72d05d5baa1005eedb6511e2577e363549a (diff) | |
core: Update libc docs to clarify usage
Diffstat (limited to 'src')
| -rw-r--r-- | src/libcore/libc.rs | 14 |
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): |