Skip to content

Commit

Permalink
Document virality of feature(rustc_private)
Browse files Browse the repository at this point in the history
Since 9cb1998 this feature is viral.
  • Loading branch information
tamird committed Dec 28, 2024
1 parent 8b3f7ac commit 35e5c7d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/doc/unstable-book/src/language-features/rustc-private.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ The tracking issue for this feature is: [#27812]

------------------------

This feature allows access to unstable internal compiler crates.
This feature allows access to unstable internal compiler crates such as `rustc_driver`.

Additionally it changes the linking behavior of crates which have this feature enabled. It will prevent linking to a dylib if there's a static variant of it already statically linked into another dylib dependency. This is required to successfully link to `rustc_driver`.
The presence of this feature changes the way the linkage format for dylibs is calculated in a way
that is necessary for linking against dylibs that statically link `std` (such as `rustc_driver`).
This makes this feature "viral" in linkage; its use in a given crate makes its use required in
dependent crates which link to it (including integration tests, which are built as separate crates).

0 comments on commit 35e5c7d

Please sign in to comment.