Skip to content

Commit 52dd3dd

Browse files
authored
Rollup merge of #149355 - anishamahuli:anishamahuli-issue-103557, r=Mark-Simulacrum
Document that `build.description` affects symbol mangling and crate IDs Addresses issue #103557 Adds warning to `bootstrap.example.toml` explaining that changing build.description affects crate IDs and symbol name mangling, which makes compiled artifacts incompatible across different values. As `@Mark-Simulacrum` points out, "if you're building with different settings, we really can't guarantee compatibility in any nice way." This documentation attempts to make that clear. This is my first contribution here, so any feedback would be greatly appreciated!
2 parents fe6d4b8 + 4af0b97 commit 52dd3dd

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

bootstrap.example.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,11 @@
220220
# which is also used in places like debuginfo `DW_AT_producer`. This may be useful for
221221
# supplementary build information, like distro-specific package versions.
222222
#
223+
# IMPORTANT: Changing this value changes crate IDs and symbol name mangling, making
224+
# compiled artifacts incompatible. PGO profiles cannot be reused across different
225+
# descriptions, and incremental compilation caches are invalidated. Keep this value
226+
# consistent when reusing build artifacts.
227+
#
223228
# The Rust compiler will differentiate between versions of itself, including
224229
# based on this string, which means that if you wish to be compatible with
225230
# upstream Rust you need to set this to "". However, note that if you set this to "" but

0 commit comments

Comments
 (0)