From 37634f3363fa871b72d181920caa2ec23eb63135 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Mon, 1 Apr 2013 12:10:51 -0700 Subject: [PATCH] core: Update libc docs to clarify usage --- src/libcore/libc.rs | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/src/libcore/libc.rs b/src/libcore/libc.rs index 79bb375d360c..fdb82a7303be 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):