mathieu/granite-rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

core: Update libc docs to clarify usage

Browse source
This commit is contained in:
Brian Anderson 2013-04-01 12:10:51 -07:00
parent 8e9fd72d05
commit 37634f3363
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/libcore/libc.rs
View file

@ -9,7 +9,19 @@
// except according to those terms. // 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 * We consider the following specs reasonably normative with respect
* to interoperating with the C standard library (libc/msvcrt): * to interoperating with the C standard library (libc/msvcrt):