Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Mar 25, 2024

Conversation

SteveLauC
Copy link
Member

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:

  • I have read CONTRIBUTING.md
  • I have written necessary tests and rustdoc comments
  • A change log has been added if this PR modifies nix's API

@SteveLauC SteveLauC merged commit 5b1b695 into nix-rust:master Mar 25, 2024
2 checks passed
@SteveLauC SteveLauC deleted the docs/cfg_alias branch March 25, 2024 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant