Implement RFC 3631: add rustdoc doc_cfg features #138907

GuillaumeGomez · 2025-03-24T22:50:33Z

This implementation actually resulted in a lot of simplifications:

All cfg computation is now done in one place: propagate_doc_cfg.rs. Because (trait) impls are not retrieved at the same time as the other items, we cannot perform this computation in the clean process, it needs to be after.
Because there is cfg inheritance, we can keep track of them in one place (in propagate_doc_cfg.rs), meaning we don't need to copy an item's attributes to its children anymore. Only exception: impl items. For them we clone only cfg attributes.
propagate_doc_cfg.rs is also now much simpler, much less need to keep track of parents, since everything we need is handled by the new CfgInfo type.
I also suspect that Cfg::simplify_with could either be removed or at least used directly into propagate_doc_cfg.rs when we compute cfgs. Considering how big the PR already is, I'll do it in a follow-up.

I didn't remove the doc_cfg* features in this PR because some dependencies used in rustc (like stdarch) are using it, so we need to have a nightly released with this PR before I can switch to the new feature.

r? ghost

petrochenkov · 2025-03-25T09:48:06Z

What remains to be done:

I'd also want to block the stabilization on landing #138844 to avoid a stable rustdoc feature relying on externally observable hacks in rustc.
The crater run in #138844 returned mostly clean, so I expect it to land soon.

GuillaumeGomez · 2025-03-25T10:36:45Z

Noted! And that will be a nice improvement, thanks!

Just one thing left for the cfg expansion missing: #[cfg_attr(blabla, derive(Debug))]. In this case, the cfg is not kept in the generated derive items. It's been in my TODO list for a long time now. ^^'

petrochenkov · 2025-03-25T10:49:31Z

Just one thing left for the cfg expansion missing: #[cfg_attr(blabla, derive(Debug))]

Do you mean like in #138515? :)

GuillaumeGomez · 2025-03-25T10:52:03Z

You're my hero! Gonna need to handle this new attribute then. :)

bors · 2025-03-25T17:53:10Z

☔ The latest upstream changes (presumably #138923) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2025-03-27T19:41:02Z

☔ The latest upstream changes (presumably #138927) made this pull request unmergeable. Please resolve the merge conflicts.

See rust-lang/rust#138907

* chore(deps): update various dependencies * chore(deps): update checkout and CodSpeedHQ actions * chore(ci): specify mode for `CodSpeedHQ` action * chore!: bump minimum Rust version, `1.82.0` -> `1.88.0` * fix(docs): rename `doc_auto_cfg` attribute See rust-lang/rust#138907 * fix(ci): require `read` permission for crates' token * chore(ci): remove duplicate test for docs * fix * fix(ci): only check if access token is set * fix(ci): better emulate docsrs by not building dependencies --------- Co-authored-by: Jérome Eertmans <[email protected]>

* feat(lock): add support for private packages * refactor(error): rename error variant * feat(core): support installing private package * feat(registry): authenticate all requests if logged in * feat: save correct lockfile entry for private projects * test(core): add install private package test * docs: doc_auto_cfg merged into doc_cfg Ref: rust-lang/rust#138907 * test: add integration test

the `doc_auto_cfg` feature has been subsumed by `doc_cfg`: rust-lang/rust#138907

The `doc_auto_cfg` feature has been subsumed by `doc_cfg`: rust-lang/rust#138907

the `doc_auto_cfg` feature has been subsumed by `doc_cfg`: rust-lang/rust#138907

The `doc_auto_cfg` feature has been subsumed by `doc_cfg`: rust-lang/rust#138907

skip-changelog, we don't officially support nightly. See-Also: rust-lang/rfcs#3631 See-Also: rust-lang/rust#138907

Replace `doc_auto_cfg` with `doc_cfg`, see rust-lang/rust#138907 Fixes issues with docs.rs builds of Fontations crates.

Our latest release failed to build on docs.rs [1] because the `doc_auto_cfg` feature has been subsumed by `doc_cfg`: rust-lang/rust#138907 [1]: https://docs.rs/crate/uefi/0.36.0/builds/2603179

## What changes are proposed in this pull request? Noticed docs didn't build successfully for [0.17.0 release](https://docs.rs/crate/delta_kernel/0.17.0/builds/2652981) since in rustc 1.92 the `doc_auto_cfg` feature was removed (and TIL docs.rs builds with nightly). This pr just moves from the `doc_auto_cfg` to `doc_cfg` (see associated [rust pr](rust-lang/rust#138907)). ## How was this change tested? docs only. reproed with `cargo +nightly doc`

See rust-lang/rust#138907