about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTamir Duberstein <tamird@gmail.com>2024-12-28 08:44:25 -0500
committerTamir Duberstein <tamird@gmail.com>2024-12-28 11:45:25 -0500
commit35e5c7d43808c0dfaffa67abeb16ce58f1ae4695 (patch)
tree765c2dd6e0a115c21c7fbbc296bfcc69b145ea1a
parent8b3f7ac5262531aefa227f90387cf2eb34aae800 (diff)
downloadrust-35e5c7d43808c0dfaffa67abeb16ce58f1ae4695.tar.gz
rust-35e5c7d43808c0dfaffa67abeb16ce58f1ae4695.zip
Document virality of `feature(rustc_private)`
Since 9cb1998ea15e179482504e07cad8fa121e169a32 this feature is viral.
-rw-r--r--src/doc/unstable-book/src/language-features/rustc-private.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/doc/unstable-book/src/language-features/rustc-private.md b/src/doc/unstable-book/src/language-features/rustc-private.md
index 97fce5980e4..3b83a3cf4df 100644
--- a/src/doc/unstable-book/src/language-features/rustc-private.md
+++ b/src/doc/unstable-book/src/language-features/rustc-private.md
@@ -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).