summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Crichton <alex@alexcrichton.com>2016-01-20 16:39:37 -0800
committerAlex Crichton <alex@alexcrichton.com>2016-02-10 17:21:21 -0800
commit6d46b6fa5fc8cbb468e5ec0f9b72e2af8414d9ac (patch)
tree26b9cfb59b9700558b112e3edcd075e7f6dff3ba /README.md
parent379e92f27e6bba4ade704d993f8ce57d8a507e0b (diff)
downloadrust-libc-6d46b6fa5fc8cbb468e5ec0f9b72e2af8414d9ac.tar.gz
Add a default-on "use_std" feature
This adds a `use_std` Cargo feature which disables `#![no_std]` builds of libc, but is enabled by default. The library will currently continue to link to the standard library to maintain backwards compatibility with the 0.2 series and older Rust compilers for now, but this default can possible be changed in the future.
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 801b73d375..69ebadafcc 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,15 @@ Next, add this to your crate root:
extern crate libc;
```
+Currently libc by default links to the standard library, but if you would
+instead like to use libc in a `#![no_std]` situation or crate you can request
+this via:
+
+```toml
+[dependencies]
+libc = { version = "0.2", default-features = false }
+```
+
## What is libc?
The primary purpose of this crate is to provide all of the definitions necessary