Skip to content

Commit 37634f3

Browse files
committed
core: Update libc docs to clarify usage
1 parent 8e9fd72 commit 37634f3

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

src/libcore/libc.rs

+13-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,19 @@
99
// except according to those terms.
1010

1111
/*!
12-
* Bindings for libc.
12+
* Bindings for the C standard library and other platform libraries
13+
*
14+
* This module contains bindings to the C standard library,
15+
* organized into modules by their defining standard.
16+
* Additionally, it contains some assorted platform-specific definitions.
17+
* For convenience, most functions and types are reexported from `core::libc`,
18+
* so `pub use core::libc::*` will import the available
19+
* C bindings as appropriate for the target platform. The exact
20+
* set of functions available are platform specific.
21+
*
22+
* *Note* Rustdoc does not indicate reexports currently. Also, because these
23+
* definitions are platform-specific, some may not
24+
* appear in the generated documentation.
1325
*
1426
* We consider the following specs reasonably normative with respect
1527
* to interoperating with the C standard library (libc/msvcrt):

0 commit comments

Comments
 (0)