Skip to content

Commit 863b037

Browse files
Jonathan Woollett-Lightluminitavoicu
Jonathan Woollett-Light
authored andcommitted
Clarifying unix-like support
Added `build.rs` to produce a compile error when attempting to build on a non-Unix-like system, and clarified support in `readme.md`. Signed-off-by: Jonathan Woollett-Light <[email protected]>
1 parent a730d86 commit 863b037

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# micro-http
22

3-
This is a minimal implementation of the
3+
This is a minimal implementation of the
44
[HTTP/1.0](https://tools.ietf.org/html/rfc1945) and
55
[HTTP/1.1](https://www.ietf.org/rfc/rfc2616.txt) protocols. This HTTP
66
implementation is stateless thus it does not support chunking or compression.
77

88
The micro-http implementation is used in production by Firecracker.
99

10+
As micro-http uses [`std::os::unix`](https://doc.rust-lang.org/std/os/unix/index.html) this crates only supports Unix-like targets.
11+
1012
## Contributing
1113

1214
To contribute to micro-http, checkout the

build.rs

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
fn main() {
2+
#[cfg(not(target_family = "unix"))]
3+
std::compile_error!("This crate only supports Unix-like targets");
4+
}

0 commit comments

Comments
 (0)