[WIP] Get rid of rustdoc::doctree #78082

jyn514 · 2020-10-18T19:37:01Z

There's nothing this does that clean can't do. Moving the transformations into clean directly makes it more clear what's going on, and less likely to have data that's inconsistent compared to rustc. It also means that there's no need to have 15 different impl Clean for doctree::X blocks, making it easier to add data to clean::Item (#76998).

~~This will probably end up obsoleting #77820, but I haven't actually finished impl Clean for hir::Item 😇 so I won't know until that's done.~~ #77820 is going to get merged first, which will hopefully make this easier to work on.

Changes from doctree:

renamed was always None, so no need to carry over
- visit_local_macro <- maybe_inline <- visit_item <- maybe_inline
imported_from was always None, no need to carry over
Crate name should never have been None; use tcx.crate_name instead.

r? @ghost

camelid · 2020-10-19T04:29:30Z

I know this is WIP but wanted to point out that you committed a change to src/llvm-project which is causing conflicts.

jyn514 · 2020-10-25T09:21:36Z

Current errors:

thread 'rustc' panicked at 'assertion failed: !item.is_stripped()', src/librustdoc/formats/cache.rs:306:21
failures:
    [rustdoc] rustdoc/inline_cross/macros.rs
    [rustdoc] rustdoc/pub-use-extern-macros.rs

I think I'm missing some logic around stripping, although I didn't see anything relevant in visit_ast ...

Fix handling of item names for HIR - Handle variants, fields, macros in `Node::ident()` - Handle the crate root in `opt_item_name` - Rewrite `item_name` in terms of `opt_item_name` I need this for both rust-lang#77820 and rust-lang#78082, so splitting it out into a separate PR so it can land early.

Make all rustdoc functions and structs crate-private This gives warnings when code is no longer used, which will be helpful when rust-lang#77820 and rust-lang#78082 land. AFAIK no one is using this API. r? ``@GuillaumeGomez`` cc ``@rust-lang/rustdoc``

Get rid of clean::{Method, TyMethod} They're redundant and almost the same as `clean::Function`. I needed this for rust-lang#78082, although I forget why. r? `@GuillaumeGomez`

Remove duplicate `Trait::auto` field It was exactly the same as `is_auto`. I found this while working on rust-lang#78082, but it's not required for that PR. r? `@GuillaumeGomez`

this compiles but does not run

It turns out these were being silently dropped before because they didn't have a name.

ForeignModule is just such a terrible name for these.

- Add back call to `from_hir_id_and_parts()` - Remove outdated comment

Get rid of some doctree items They can be derived directly from the `hir::Item`, there's no special logic. - TypeDef - OpaqueTy - Constant - Static - TraitAlias - Enum - Union - Struct Part of rust-lang#78082 (the easiest part, I'm still debugging some other changes). r? `@GuillaumeGomez`

Get rid of `doctree::Impl` Follow-up to rust-lang#79264, continues breaking up rust-lang#78082. At some point I want to introduce `MaybeInlined`, but I think I'll wait until I need `MaybeInlined::InlinedWithOriginal` because it's not very useful in other situations. r? `@GuillaumeGomez`

Get rid of doctree::{ExternalCrate, ForeignItem, Trait, Function} Closes rust-lang#79314, closes rust-lang#79331, closes rust-lang#79332. Follow-up to rust-lang#79264 and rust-lang#79312, continues breaking up rust-lang#78082. r? `@GuillaumeGomez`

Remove doctree::Macro and distinguish between `macro_rules!` and `pub macro` This is a part of rust-lang#78082, removing doctree::Macro. Uses the changes in rust-lang#79372 Fixes rust-lang#76761

Pass around Symbols instead of Idents in doctree The span was unused. Vaguely related to rust-lang#78082 - currently working on converting `visit_ast` to use `hir::intravisit` and this makes that a little easier. r? `@GuillaumeGomez`

Pass around Symbols instead of Idents in doctree The span was unused. Vaguely related to rust-lang#78082 - currently working on converting `visit_ast` to use `hir::intravisit` and this makes that a little easier. r? ``@GuillaumeGomez``

jyn514 · 2020-12-18T16:26:47Z

I think what's left of doctree is doing useful work.

This was referenced Oct 19, 2020

Normalize <X as Y>::T for rustdoc #77467

Merged

Fix handling of item names for HIR #78345

Merged

jyn514 force-pushed the no-doctree branch 2 times, most recently from c8b042e to 76da828 Compare October 25, 2020 09:11

This comment has been minimized.

Sign in to view

jyn514 mentioned this pull request Nov 14, 2020

Make all rustdoc functions and structs crate-private #79061

Merged

jyn514 force-pushed the no-doctree branch from 76da828 to 51bcfe7 Compare November 17, 2020 02:49

jyn514 mentioned this pull request Nov 17, 2020

Get rid of clean::{Method, TyMethod} #79125

Merged

jyn514 force-pushed the no-doctree branch from 51bcfe7 to 6e5b1d9 Compare November 17, 2020 04:55

jyn514 mentioned this pull request Nov 17, 2020

Remove duplicate Trait::auto field #79126

Merged

This comment has been minimized.

Sign in to view

jyn514 added 8 commits November 18, 2020 17:18

[extremely broken] try to get rid of doctree

ad9933e

this compiles but does not run

implement macros

7b8c5aa

Remove dead code

0b05cee

[WIP] fill out Item

341ae70

[WIP] fill out ExternCrate

42b2043

[WIP] fill out ImportItem

4b22097

[WIP] add statics and unions

350e4d7

[WIP] add ConstantItem

5ba37bc

jyn514 added 8 commits November 18, 2020 17:19

ModuleItems

ed27f87

Add crate name

1697ada

Cleanup some TODOs

44cef3e

Fix crash on items only named in HIR

a79eb20

Don't ICE on trait functions and imports

ba301ac

It turns out these were being silently dropped before because they didn't have a name.

Fix broken handling of extern "ABI" blocks

ee0cad5

ForeignModule is just such a terrible name for these.

debugging

e27b769

Fix semantic conflict

9eaca9d

jyn514 force-pushed the no-doctree branch from 779af43 to 9eaca9d Compare November 18, 2020 22:23

Small cleanups

5e2793b

- Add back call to `from_hir_id_and_parts()` - Remove outdated comment

jyn514 mentioned this pull request Nov 21, 2020

Get rid of some doctree items #79264

Merged

This comment has been minimized.

Sign in to view

This was referenced Nov 22, 2020

Get rid of doctree::Impl #79312

Merged

Get rid of doctree::ForeignItem #79314

Closed

Get rid of doctree::Function #79331

Closed

Get rid of doctree::Trait #79332

Closed

Get rid of doctree::{ExternalCrate, ForeignItem, Trait, Function} #79335

Merged

CraftSpider mentioned this pull request Nov 26, 2020

Remove doctree::Macro and distinguish between macro_rules! and pub macro #79455

Merged

jyn514 mentioned this pull request Dec 2, 2020

Pass around Symbols instead of Idents in doctree #79623

Merged

jyn514 closed this Dec 18, 2020

jyn514 deleted the no-doctree branch December 18, 2020 16:26

jyn514 mentioned this pull request Mar 23, 2021

rustdoc: Record crate name instead of using None #83399

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Get rid of rustdoc::doctree #78082

[WIP] Get rid of rustdoc::doctree #78082

jyn514 commented Oct 18, 2020 •

edited

Loading

camelid commented Oct 19, 2020

jyn514 commented Oct 25, 2020 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jyn514 commented Dec 18, 2020

[WIP] Get rid of rustdoc::doctree #78082

[WIP] Get rid of rustdoc::doctree #78082

Conversation

jyn514 commented Oct 18, 2020 • edited Loading

camelid commented Oct 19, 2020

jyn514 commented Oct 25, 2020 • edited Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jyn514 commented Dec 18, 2020

jyn514 commented Oct 18, 2020 •

edited

Loading

jyn514 commented Oct 25, 2020 •

edited

Loading