[rustdoc-json] JSON no longer inlines #93518
Conversation
This removes all inlining from Rustdoc-JSON. Instead, JSON preserves private modules containing public items as 'stripped' modules, indicating that they exist solely to prevent orphaning of contained items. Format version has been bumped and tests updated, as this is a significant change over previous behavior around re-exports. However, the new system fixes multiple ICEs and is generally cleaner.
|
rustdoc-json-types is a public (although nightly-only) API. Consider changing |
rustbot
added
the
T-rustdoc
|
r? @jsha (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
Waiting for them then. Please ping us when it's ready for review. |
|
I just experimented with this PR and found out that the inlining is still done for intra-doc-links. |
|
Inlining is also still done with double (maybe more, haven't tested) nested re-exports: mod depth1 {
mod depth2 {
pub const C: usize = 7;
}
pub use self::depth2::C;
}
pub use depth1::C; // Direct link to `pub const C` instead of `pub use self::depth2::C` |
CraftSpider
added
S-blocked
| @@ -192,6 +192,9 @@ pub enum ItemKind { | |||
| #[serde(tag = "kind", content = "inner", rename_all = "snake_case")] | |||
| pub enum ItemEnum { | |||
| Module(Module), | |||
| StrippedModule { | |||
There was a problem hiding this comment.
For symmetry with most other enum variants, most notably Module(Module), this should be StrippedModule(StrippedModule).
Another option that I find even more attractive since it removes the need for more types and enum variants is to simply add is_stripped to struct Module, so it becomes:
pub struct Module {
pub is_crate: bool,
pub is_stripped: bool,
pub items: Vec<Id>,
}That would be even more symmetric with existing code, since there is no CrateModule (which would be an alternative to having the current is_crate field in Module).
|
☔ The latest upstream changes (presumably #94009) made this pull request unmergeable. Please resolve the merge conflicts. |
|
I took over this one in #99287. |
…export, r=notriddle [rustdoc-json] JSON no longer inlines Fixes rust-lang#98007. Fixes rust-lang#96161. Fixes rust-lang#83057. Fixes rust-lang#83720. I took over rust-lang#93518 and applied the comments and added more tests. There was one thing missing (which is in the second commit): if a non-exported item was used in a public API but not reexported, it was still missing. cc `@CraftSpider` `@Urgau` `@Enselic` r? `@notriddle`
This removes all inlining from Rustdoc-JSON. Instead, JSON preserves private modules containing public items as 'stripped' modules, indicating that they exist solely to prevent orphaning of contained items. Format version has been bumped and tests updated, as this is a significant change over previous behavior around re-exports. However, the new system fixes multiple ICEs and is generally cleaner.
Fixes #83057
Fixes #83720