Skip to content

Add a caveats section for conditional compilation #1195

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.

Sign up for GitHub

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

Closed
wants to merge 5 commits into from
Closed

Add a caveats section for conditional compilation #1195

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5f876e9
Add a caveats section for conditional compilation
yoav-lavi Apr 19, 2022
b0de193
Update conditional-compilation.md
yoav-lavi Apr 19, 2022
595803f
Update conditional-compilation.md
yoav-lavi Apr 19, 2022
b6c994d
Update conditional-compilation.md
yoav-lavi Apr 19, 2022
22a75b5
Update conditional-compilation.md
yoav-lavi Apr 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/conditional-compilation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,14 @@ let machine_kind = if cfg!(unix) {
println!("I'm running on a {} machine!", machine_kind);
```

## Caveats

Conditional compilation, be it features or targets, require an exponential number of configurations and test cases to be properly covered. By default, testing, linting, Miri, docs and others will only run on the default set of features and for the current platform.

Having a CI job per target can help with linting, testing and building for all targets. There are also some tools that accept a `--target` flag for cross compilation.

For feature coverage, there are certain tools like [cargo-hack](https://github.com/taiki-e/cargo-hack) and [cargo-all-features](https://github.com/frewsxcv/cargo-all-features) that allow you to test all combinations of features which can help reduce the amount of configuraton needed.

[IDENTIFIER]: identifiers.md
[RAW_STRING_LITERAL]: tokens.md#raw-string-literals
[STRING_LITERAL]: tokens.md#string-literals
Expand Down