openharmony/third_party_rust_nix
1
0
Fork 0
mirror of https://gitee.com/openharmony/third_party_rust_nix synced 2024-11-23 15:30:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
8e91b28b64
third_party_rust_nix/README.md

106 lines
3.5 KiB
Markdown
Raw Normal View History

Epoll, rename to nix, misc cleanup
2014-08-17 01:45:34 +00:00
# Rust bindings to *nix APIs
Initial commit
2014-08-07 20:02:28 +00:00
add Cirrus CI badge to readme
2020-10-12 15:06:18 +00:00
[![Cirrus Build Status](https://api.cirrus-ci.com/github/nix-rust/nix.svg)](https://cirrus-ci.com/github/nix-rust/nix)
Fix crates.io badge
2021-08-14 06:10:42 +00:00
[![crates.io](https://img.shields.io/crates/v/nix.svg)](https://crates.io/crates/nix)
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
Add link to release documentation
2016-12-03 13:36:47 +00:00
[Documentation (Releases)](https://docs.rs/nix/)
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
Nix seeks to provide friendly bindings to various *nix platform APIs (Linux, Darwin,
Update README
2015-02-21 00:24:42 +00:00
...). The goal is to not provide a 100% unified interface, but to unify
what can be while still providing platform specific APIs.
Epoll, rename to nix, misc cleanup
2014-08-17 01:45:34 +00:00
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
For many system APIs, Nix provides a safe alternative to the unsafe APIs
exposed by the [libc crate](https://github.com/rust-lang/libc). This is done by
wrapping the libc functionality with types/abstractions that enforce legal/safe
usage.
Update README
2015-05-28 22:17:49 +00:00
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
As an example of what Nix provides, examine the differences between what is
exposed by libc and nix for the
Use https instead of http
2021-05-14 04:37:16 +00:00
[gethostname](https://man7.org/linux/man-pages/man2/gethostname.2.html) system
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
call:
Update README
2015-05-28 22:17:49 +00:00
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
```rust,ignore
// libc api (unsafe, requires handling return code/errno)
pub unsafe extern fn gethostname(name: *mut c_char, len: size_t) -> c_int;
Change gethostname to return an OsString
2022-06-25 01:29:07 +00:00
// nix api (returns a nix::Result<OsString>)
pub fn gethostname() -> Result<OsString>;
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
```
Initial commit
2014-08-07 20:02:28 +00:00
List supported targets in the README
2017-04-15 19:12:33 +00:00
## Supported Platforms
Switch to two tiers of supported platforms
2017-04-17 22:16:22 +00:00
nix target support consists of two tiers. While nix attempts to support all
platforms supported by [libc](https://github.com/rust-lang/libc), only some
platforms are actively supported due to either technical or manpower
Fix typo in README
2017-12-24 19:54:34 +00:00
limitations. Support for platforms is split into three tiers:
List supported targets in the README
2017-04-15 19:12:33 +00:00
Switch to two tiers of supported platforms
2017-04-17 22:16:22 +00:00
* Tier 1 - Builds and tests for this target are run in CI. Failures of either
block the inclusion of new code.
* Tier 2 - Builds for this target are run in CI. Failures during the build
blocks the inclusion of new code. Tests may be run, but failures
in tests don't block the inclusion of new code.
Add all Android targets as Tier 3 platforms
2017-06-30 17:25:57 +00:00
* Tier 3 - Builds for this target are run in CI. Failures during the build
*do not* block the inclusion of new code. Testing may be run, but
failures in tests don't block the inclusion of new code.
List supported targets in the README
2017-04-15 19:12:33 +00:00
Enable libc extra_traits feature Also bump Rust requirement to 1.25 which is a requirement of that feature
2019-03-10 15:23:52 +00:00
The following targets are supported by `nix`:
List supported targets in the README
2017-04-15 19:12:33 +00:00
Tier 1:
* aarch64-unknown-linux-gnu
* arm-unknown-linux-gnueabi
Alphabetize Tier 1 supported platforms
2017-07-09 18:28:34 +00:00
* armv7-unknown-linux-gnueabihf
Promote i686-unknown-freebsd to Tier1 in the README We effectively made it Tier1 back in ec6fe0629df87d8355cbdba8b7a0855934a5ac9e, but never updated the README.
2017-10-14 23:57:59 +00:00
* i686-unknown-freebsd
Alphabetize Tier 1 supported platforms
2017-07-09 18:28:34 +00:00
* i686-unknown-linux-gnu
* i686-unknown-linux-musl
* mips-unknown-linux-gnu
Disable failing tests on mips64 These are assumed to be QEMU issues, as they also fail on mips.
2017-07-09 20:19:41 +00:00
* mips64-unknown-linux-gnuabi64
* mips64el-unknown-linux-gnuabi64
Alphabetize Tier 1 supported platforms
2017-07-09 18:28:34 +00:00
* mipsel-unknown-linux-gnu
doc: Add powerpc64 as tier 1
2017-06-19 22:02:12 +00:00
* powerpc64le-unknown-linux-gnu
Alphabetize Tier 1 supported platforms
2017-07-09 18:28:34 +00:00
* x86_64-apple-darwin
* x86_64-unknown-freebsd
* x86_64-unknown-linux-gnu
Fix x86_64 Linux/musl tests Seems that pretty much all aio tests fail on x64 musl builds.
2017-04-18 00:34:02 +00:00
* x86_64-unknown-linux-musl
List supported targets in the README
2017-04-15 19:12:33 +00:00
Tier 2:
Add support for aarch64-apple-darwin Replace 'OSX' language with 'macOS', to match Rust's language.
2022-01-30 05:25:29 +00:00
* aarch64-apple-darwin
Enable termios on iOS and move it to Tier 2
2017-07-04 17:40:23 +00:00
* aarch64-apple-ios
Make Android a Tier 2 target
2017-07-03 23:07:21 +00:00
* aarch64-linux-android
* arm-linux-androideabi
Upgrade to Bitflags 1.0 The libc_bitflags! macro was replaced with a non-recursive one supporting only public structs. I could not figure out how to make the old macro work with the upgrade, so I reworked part of the bitflags! macro directly to suit our needs, much as the original recursive macro was made. There are no uses of this macro for non-public structs, so this is not a problem for internal code.
2017-11-22 06:27:15 +00:00
* arm-unknown-linux-musleabi
Make Android a Tier 2 target
2017-07-03 23:07:21 +00:00
* armv7-linux-androideabi
Upgrade to Bitflags 1.0 The libc_bitflags! macro was replaced with a non-recursive one supporting only public structs. I could not figure out how to make the old macro work with the upgrade, so I reworked part of the bitflags! macro directly to suit our needs, much as the original recursive macro was made. There are no uses of this macro for non-public structs, so this is not a problem for internal code.
2017-11-22 06:27:15 +00:00
* i686-linux-android
Downgrade powerpc/Linux/Gnu to Tier 2
2017-07-19 03:24:48 +00:00
* powerpc-unknown-linux-gnu
Move Tier 3s to Tier 2
2017-07-09 19:13:32 +00:00
* s390x-unknown-linux-gnu
Enable termios on iOS and move it to Tier 2
2017-07-04 17:40:23 +00:00
* x86_64-apple-ios
Upgrade to Bitflags 1.0 The libc_bitflags! macro was replaced with a non-recursive one supporting only public structs. I could not figure out how to make the old macro work with the upgrade, so I reworked part of the bitflags! macro directly to suit our needs, much as the original recursive macro was made. There are no uses of this macro for non-public structs, so this is not a problem for internal code.
2017-11-22 06:27:15 +00:00
* x86_64-linux-android
Mark x86_64-unknown-illumos as Tier 2
2021-08-23 23:22:07 +00:00
* x86_64-unknown-illumos
Enable termios on iOS and move it to Tier 2
2017-07-04 17:40:23 +00:00
* x86_64-unknown-netbsd
Specify Rust minimum version requirements
2017-02-24 19:09:38 +00:00
Add Redox to Tier 3
2020-05-20 02:48:11 +00:00
Tier 3:
uclibc support
2021-12-07 21:57:52 +00:00
* armv7-unknown-linux-uclibceabihf
Add fuchsia support Allow nix to compile on Fuchsia by conditionally avoiding libc functionality that does not exist for Fuchsia.
2020-08-05 17:25:03 +00:00
* x86_64-fuchsia
Check Dragonfly BSD and OpenBSD in CI Build, but don't test, for these operating systems. Thanks to @rtzoeller for the tip. Also, fix the OpenBSD build.
2021-09-04 22:25:52 +00:00
* x86_64-unknown-dragonfly
add haiku support * enabled as much functionality and defines that match updated libc definitions for haiku
2022-04-23 04:56:51 +00:00
* x86_64-unknown-haiku
Bump caps to 0.5.1. Add x32 to CI for cross-builds and Tier 3 list in README
2021-02-13 08:30:39 +00:00
* x86_64-unknown-linux-gnux32
Check Dragonfly BSD and OpenBSD in CI Build, but don't test, for these operating systems. Thanks to @rtzoeller for the tip. Also, fix the OpenBSD build.
2021-09-04 22:25:52 +00:00
* x86_64-unknown-openbsd
* x86_64-unknown-redox
Add Redox to Tier 3
2020-05-20 02:48:11 +00:00
[skip ci] Change release procedure to use cargo-release Remove the example Cargo.toml entry from README.md because it's obvious, and it creates extra work at release time.
2021-09-29 03:16:42 +00:00
## Minimum Supported Rust Version (MSRV)
Update README
2015-02-21 00:24:42 +00:00
Raise the MSRV to 1.56.1 in anticipation of the next release And fix some documentation lints warned about by the newer rustdoc.
2022-08-11 23:29:31 +00:00
nix is supported on Rust 1.56.1 and higher. Its MSRV will not be
[skip ci] Change release procedure to use cargo-release Remove the example Cargo.toml entry from README.md because it's obvious, and it creates extra work at release time.
2021-09-29 03:16:42 +00:00
changed in the future without bumping the major or minor version.
Update README
2015-02-21 00:24:42 +00:00
Add introduction/constants/enumeration/uninitialized to CONVENTIONS.
2016-02-27 12:02:25 +00:00
## Contributing
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
Contributions are very welcome. Please See [CONTRIBUTING](CONTRIBUTING.md) for
additional details.
Add gitter link to README
2017-06-03 19:17:19 +00:00
Feel free to join us in [the nix-rust/nix](https://gitter.im/nix-rust/nix) channel on Gitter to
discuss `nix` development.
docs: update readme to be a bit more useful This started out as a small change to update the readme to include an updated pointer to the documentation on gh-pages and ended with a bit of an overhaul in order to provide better information for people just checking out nix for the first time. Signed-off-by: Paul Osborne <osbpau@gmail.com>
2016-07-10 06:27:13 +00:00
## License
Nix is licensed under the MIT license. See [LICENSE](LICENSE) for more details.
Reference in New Issue Copy Permalink