rustc-dev-guide icon indicating copy to clipboard operation
rustc-dev-guide copied to clipboard
verified publisher icon rust-lang

`cfg(bootstrap)` docs don't say what it does

Open camelid opened this issue 4 years ago • 1 comments

https://rustc-dev-guide.rust-lang.org/building/bootstrapping.html#why-does-only-libstd-use-cfgbootstrap

cc https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/rename.20.60cfg.28bootstrap.29.60.20to.20.60cfg.28stageN.29.60

camelid avatar Nov 10 '21 19:11 camelid

It also misleadingly says that rustc only uses cfg(bootstrap) when adding internal lints for diagnostic items. That's not true; rustc also uses cfg(bootstrap) when feature gates that are used internally are renamed or removed.

camelid avatar Jan 09 '22 21:01 camelid

The docs for cfg(bootstrap) are here: https://rustc-dev-guide.rust-lang.org/building/bootstrapping.html#complications-of-bootstrapping. Maybe it would help to link there from the libstd section?

It also misleadingly says that rustc only uses cfg(bootstrap) when adding internal lints for diagnostic items. That's not true; rustc also uses cfg(bootstrap) when feature gates that are used internally are renamed or removed.

👍 I'll fix this.

jyn514 avatar Apr 08 '23 20:04 jyn514