Skip to content

Commit a37d708

Browse files
committed
Add a list of support OSs
1 parent 0bed986 commit a37d708

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,44 @@ See the [API documentation] for more.
1919

2020
[API documentation]: https://docs.rs/socket2
2121

22+
# OS support
23+
24+
Socket2 attempts to support the same OS/architectures as Rust does, see
25+
https://doc.rust-lang.org/nightly/rustc/platform-support.html. However this is
26+
not always possible, below is current list of support OSs.
27+
28+
*If your favorite OS is not on the list consider contributing it! See [issue
29+
#78].*
30+
31+
[issue #78]: https://github.com/rust-lang/socket2/issues/78
32+
33+
### Tier 1
34+
35+
These OSs are tested with each commit in the CI and must always pass the tests.
36+
All functions/types/etc., excluding ones behind the `all` feature, must work on
37+
these OSs.
38+
39+
* Linux
40+
* macOS
41+
* Windows
42+
43+
### Tier 2
44+
45+
These OSs are currently build in the CI, but not tested. Not all
46+
functions/types/etc. may work on these OSs, even ones **not** behind the `all`
47+
feature flag.
48+
49+
* Redox
50+
51+
### Tier 3
52+
53+
Theses OSs are supported, but are not checked in the CI.
54+
55+
* Android
56+
* FreeBSD
57+
* iOS
58+
* NetBSD
59+
2260
# License
2361

2462
This project is licensed under either of

0 commit comments

Comments
 (0)