nix-rust / nix

Rust friendly bindings to *nix APIs
MIT License
2.67k stars 667 forks source link

docs: document we don't alias for ONLY 1 OS[skip ci] #2346

Closed SteveLauC closed 7 months ago

SteveLauC commented 7 months ago

What does this PR do

While reviewing #2314, I found that it is easy for contributors to accidentally use cfg aliases that are ONLY for 1 operation system, this is something we don't like (see #2236 and clippy::mismatched_target_os ), so let's document this.

Checklist: