Skip to content

Commit

Permalink
Merge pull request #1369 from riking/patch
Browse files Browse the repository at this point in the history
Document the ordering behavior of crate cfgs
  • Loading branch information
ehuss authored Jun 22, 2023
2 parents da57c4a + 3319e0e commit 5ca365e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/conditional-compilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,12 @@ It is written as `cfg`, `(`, a configuration predicate, and finally `)`.
If the predicate is true, the thing is rewritten to not have the `cfg` attribute
on it. If the predicate is false, the thing is removed from the source code.

When a crate-level `cfg` has a false predicate, the behavior is slightly
different: any crate attributes preceding the `cfg` are kept, and any crate
attributes following the `cfg` are removed. This allows `#![no_std]` and
`#![no_core]` crates to avoid linking `std`/`core` even if a `#![cfg(...)]` has
removed the entire crate.

Some examples on functions:

```rust
Expand Down

0 comments on commit 5ca365e

Please sign in to comment.