rustdoc: general cleanups #62955

Mark-Simulacrum · 2019-07-24T21:32:42Z

This is purely a refactoring, mostly just simplifying some of the code. Commits are best reviewed individually.

rust-highfive · 2019-07-24T22:44:49Z

The job mingw-check of your PR failed (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.

2019-07-24T21:33:15.3095670Z ##[command]git remote add origin https://github.com/rust-lang/rust
2019-07-24T21:33:15.3317582Z ##[command]git config gc.auto 0
2019-07-24T21:33:15.3396130Z ##[command]git config --get-all http.https://github.com/rust-lang/rust.extraheader
2019-07-24T21:33:15.3452942Z ##[command]git config --get-all http.proxy
2019-07-24T21:33:15.3586172Z ##[command]git -c http.extraheader="AUTHORIZATION: basic ***" fetch --force --tags --prune --progress --no-recurse-submodules --depth=2 origin +refs/heads/*:refs/remotes/origin/* +refs/pull/62955/merge:refs/remotes/pull/62955/merge
---
2019-07-24T21:33:50.0958970Z do so (now or later) by using -b with the checkout command again. Example:
2019-07-24T21:33:50.0959188Z 
2019-07-24T21:33:50.0959568Z   git checkout -b <new-branch-name>
2019-07-24T21:33:50.0959765Z 
2019-07-24T21:33:50.0959968Z HEAD is now at 66a2ddf15 Merge ef4c04eff79e32273a5b0f3deb61000fe9120eb9 into 03f19f7ff128a3b01eeab3f87f04cce22883f006
2019-07-24T21:33:50.1085624Z ##[section]Starting: Collect CPU-usage statistics in the background
2019-07-24T21:33:50.1088084Z ==============================================================================
2019-07-24T21:33:50.1088136Z Task         : Bash
2019-07-24T21:33:50.1088193Z Description  : Run a Bash script on macOS, Linux, or Windows
---
2019-07-24T21:43:08.3302143Z    Compiling parking_lot_core v0.4.0
2019-07-24T21:43:11.6511407Z     Checking tempfile v3.0.5
2019-07-24T21:43:11.9920674Z     Checking parking_lot v0.7.1
2019-07-24T21:43:12.2808951Z     Checking rustdoc v0.0.0 (/checkout/src/librustdoc)
2019-07-24T21:43:12.5959894Z error[E0432]: unresolved import `crate::core::DocAccessLevels`
2019-07-24T21:43:12.5962541Z   --> src/librustdoc/clean/inline.rs:17:31
2019-07-24T21:43:12.5962817Z    |
2019-07-24T21:43:12.5963055Z 17 | use crate::core::{DocContext, DocAccessLevels};
2019-07-24T21:43:12.5963547Z    |                               |
2019-07-24T21:43:12.5963547Z    |                               |
2019-07-24T21:43:12.5963792Z    |                               no `DocAccessLevels` in `core`
2019-07-24T21:43:12.5964080Z    |                               help: a similar name exists in the module: `AccessLevels`
2019-07-24T21:43:12.5964230Z 
2019-07-24T21:43:12.5964476Z error[E0432]: unresolved import `crate::core::DocAccessLevels`
2019-07-24T21:43:12.5964722Z  --> src/librustdoc/clean/blanket_impl.rs:8:5
2019-07-24T21:43:12.5964905Z   |
2019-07-24T21:43:12.5965125Z 8 | use crate::core::DocAccessLevels;
2019-07-24T21:43:12.5965383Z   |     ^^^^^^^^^^^^^---------------
2019-07-24T21:43:12.5965617Z   |     |            |
2019-07-24T21:43:12.5965902Z   |     |            help: a similar name exists in the module: `AccessLevels`
2019-07-24T21:43:12.5966141Z   |     no `DocAccessLevels` in `core`
2019-07-24T21:43:12.5986913Z 
2019-07-24T21:43:12.5987917Z error[E0432]: unresolved import `crate::core::DocAccessLevels`
2019-07-24T21:43:12.5988210Z   --> src/librustdoc/html/format.rs:17:5
2019-07-24T21:43:12.5988448Z    |
2019-07-24T21:43:12.5988733Z 17 | use crate::core::DocAccessLevels;
2019-07-24T21:43:12.5989038Z    |     ^^^^^^^^^^^^^---------------
2019-07-24T21:43:12.5989347Z    |     |            |
2019-07-24T21:43:12.5989706Z    |     |            help: a similar name exists in the module: `AccessLevels`
2019-07-24T21:43:12.5990015Z    |     no `DocAccessLevels` in `core`
2019-07-24T21:43:12.5990069Z 
2019-07-24T21:43:12.5990351Z error[E0432]: unresolved import `crate::core::DocAccessLevels`
2019-07-24T21:43:12.5990933Z   --> src/librustdoc/passes/mod.rs:13:31
2019-07-24T21:43:12.5991307Z    |
2019-07-24T21:43:12.5991562Z 13 | use crate::core::{DocContext, DocAccessLevels};
2019-07-24T21:43:12.5992073Z    |                               |
2019-07-24T21:43:12.5992073Z    |                               |
2019-07-24T21:43:12.5992342Z    |                               no `DocAccessLevels` in `core`
2019-07-24T21:43:12.5992638Z    |                               help: a similar name exists in the module: `AccessLevels`
2019-07-24T21:43:15.2433417Z error: aborting due to 4 previous errors
2019-07-24T21:43:15.2434147Z 
2019-07-24T21:43:15.2434648Z For more information about this error, try `rustc --explain E0432`.
2019-07-24T21:43:15.2794858Z error: Could not compile `rustdoc`.
2019-07-24T21:43:15.2794858Z error: Could not compile `rustdoc`.
2019-07-24T21:43:15.2795554Z 
2019-07-24T21:43:15.2796258Z To learn more, run the command again with --verbose.
2019-07-24T21:43:15.2818399Z command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0/bin/cargo" "check" "--target" "x86_64-unknown-linux-gnu" "-j" "2" "--release" "--color" "always" "--manifest-path" "/checkout/src/tools/rustdoc/Cargo.toml" "--message-format" "json"
2019-07-24T21:43:15.2818868Z expected success, got: exit code: 101
2019-07-24T21:43:15.2823174Z failed to run: /checkout/obj/build/bootstrap/debug/bootstrap check
2019-07-24T21:43:15.2823685Z Build completed unsuccessfully in 0:06:13
2019-07-24T21:43:17.5667697Z ##[error]Bash exited with code '1'.
2019-07-24T21:43:17.5700779Z ##[section]Starting: Checkout
2019-07-24T21:43:17.5702159Z ==============================================================================
2019-07-24T21:43:17.5702204Z Task         : Get sources
2019-07-24T21:43:17.5702243Z Description  : Get sources from a repository. Supports Git, TfsVC, and SVN repositories.

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

JohnCSimon · 2019-08-03T05:05:51Z

@QuietMisdreavus Howdy from triage! This PR has sat waiting for review for a week. Can you please have a look?

bors · 2019-08-03T06:06:01Z

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

eddyb · 2019-08-10T08:18:04Z

src/librustdoc/clean/mod.rs

+// The `()` here is rather ugly and would be great to remove. Unfortunately, we
+// already have a different Clean impl for `doctree::Module` which makes this
+// the only way to easily disambiguate.
+impl<'tcx> Clean<Crate> for ((), doctree::Module<'tcx>) {


Implement this on &'tcx hir::Crate instead and have it create RustdocVisitor here.

eddyb · 2019-08-10T08:19:34Z

src/librustdoc/doctree.rs

@@ -23,8 +23,7 @@ pub struct Module<'hir> {
    pub enums: Vec<Enum<'hir>>,
    pub fns: Vec<Function<'hir>>,
    pub mods: Vec<Module<'hir>>,
-    pub id: NodeId,
-    pub hid: hir::HirId,
+    pub id: hir::HirId,


Ideally, this entire module would use DefId, but this is an improvement.

eddyb · 2019-08-10T08:20:19Z

r? @eddyb

r=me after rebase and maybe @petrochenkov can take a look at the resolver changes

Mark-Simulacrum · 2019-08-10T11:32:29Z

Rebased and fixed the review comments. I can try and replace everything with DefId in a follow up PR if you'd like; I believe this is waiting on @petrochenkov now for resolver change review.

Previously visit could be called multiple times, but this is inaccurate, as it deconstructs Visitor state.

Also privatizes needlessly public methods to enforce which methods callers are intended to call, i.e., only `new` and `visit`.

Mark-Simulacrum · 2019-08-10T13:38:59Z

@bors r=eddyb

bors · 2019-08-10T13:39:01Z

📌 Commit 32f144a has been approved by eddyb

bors · 2019-08-10T17:20:02Z

⌛ Testing commit 32f144a with merge 9703ef6...

rustdoc: general cleanups This is purely a refactoring, mostly just simplifying some of the code. Commits are best reviewed individually.

bors · 2019-08-10T21:01:55Z

☀️ Test successful - checks-azure
Approved by: eddyb
Pushing 9703ef6 to master...

rust-highfive assigned steveklabnik Jul 24, 2019

Mark-Simulacrum assigned QuietMisdreavus and unassigned steveklabnik Jul 24, 2019

Mark-Simulacrum force-pushed the rustdoc-clean-1 branch from ef4c04e to dca3e43 Compare July 24, 2019 22:57

Mark-Simulacrum added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 25, 2019

jonas-schievink added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jul 26, 2019

eddyb reviewed Aug 10, 2019

View reviewed changes

rust-highfive assigned eddyb and unassigned QuietMisdreavus Aug 10, 2019

petrochenkov self-assigned this Aug 10, 2019

Make fields of RustdocVisitor private

3710002

Mark-Simulacrum force-pushed the rustdoc-clean-1 branch from dca3e43 to f0c3563 Compare August 10, 2019 11:31

Mark-Simulacrum added 8 commits August 10, 2019 07:52

Remove Option from resolver

2d18504

Represent ownership transfer in RustdocVisitor::visit

2fadc45

Previously visit could be called multiple times, but this is inaccurate, as it deconstructs Visitor state.

Make exact_paths a non-optional field on RustdocVisitor

6c5d212

Also privatizes needlessly public methods to enforce which methods callers are intended to call, i.e., only `new` and `visit`.

Gather stability information during cleaning

11735b6

Gather deprecation information during cleaning

4beb751

Remove NodeId from doctree::Module

c36e0c0

Replace is_doc_reachable with is_public

78d9088

Implement Clean<Crate> on hir::Crate directly

32f144a

Mark-Simulacrum force-pushed the rustdoc-clean-1 branch from f0c3563 to 32f144a Compare August 10, 2019 11:52

petrochenkov approved these changes Aug 10, 2019

View reviewed changes

petrochenkov removed their assignment Aug 10, 2019

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 10, 2019

bors added a commit that referenced this pull request Aug 10, 2019

Auto merge of #62955 - Mark-Simulacrum:rustdoc-clean-1, r=eddyb

9703ef6

rustdoc: general cleanups This is purely a refactoring, mostly just simplifying some of the code. Commits are best reviewed individually.

bors added the merged-by-bors This PR was explicitly merged by bors. label Aug 10, 2019

bors merged commit 32f144a into rust-lang:master Aug 10, 2019

bors mentioned this pull request Aug 10, 2019

Almost fully deprecate hir::map::Map.hir_to_node_id #62975

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc: general cleanups #62955

rustdoc: general cleanups #62955

Mark-Simulacrum commented Jul 24, 2019

rust-highfive commented Jul 24, 2019

JohnCSimon commented Aug 3, 2019 •

edited

Loading

bors commented Aug 3, 2019

eddyb Aug 10, 2019

eddyb Aug 10, 2019

eddyb commented Aug 10, 2019

Mark-Simulacrum commented Aug 10, 2019

Mark-Simulacrum commented Aug 10, 2019

bors commented Aug 10, 2019

bors commented Aug 10, 2019

bors commented Aug 10, 2019

rustdoc: general cleanups #62955

rustdoc: general cleanups #62955

Conversation

Mark-Simulacrum commented Jul 24, 2019

rust-highfive commented Jul 24, 2019

JohnCSimon commented Aug 3, 2019 • edited Loading

bors commented Aug 3, 2019

eddyb Aug 10, 2019

Choose a reason for hiding this comment

eddyb Aug 10, 2019

Choose a reason for hiding this comment

eddyb commented Aug 10, 2019

Mark-Simulacrum commented Aug 10, 2019

Mark-Simulacrum commented Aug 10, 2019

bors commented Aug 10, 2019

bors commented Aug 10, 2019

bors commented Aug 10, 2019

JohnCSimon commented Aug 3, 2019 •

edited

Loading