Ignore rustc_private items from std docs #76571

tesuji · 2020-09-10T13:23:05Z

By ignoring rustc_private items for non local impl block,
this may fix #74672 and fix #75588 .

This might suppress #76529 if it is simple enough for backport.

rust-highfive · 2020-09-10T13:23:08Z

r? @GuillaumeGomez

(rust_highfive has picked a reviewer for you, use r? to override)

src/librustdoc/clean/inline.rs

jyn514

Thanks so much for working on this! Just a few nits.

compiler/rustc_span/src/def_id.rs

src/librustdoc/clean/inline.rs

src/tools/linkchecker/main.rs

src/test/rustdoc/issue-75588.rs

jyn514 · 2020-09-10T14:54:21Z

src/tools/linkchecker/main.rs

+        //
+        // NOTE: This cannot be added to `LINKCHECK_EXCEPTIONS` because the resolved path
+        // calculated in `check` function is outside `build/<triple>/doc` dir.
+        // So the `strip_prefix` method just returns the old absolute broken path.


Yeah, this comment seems fine. nit: this could be else if so you don't need the early return, but won't block on that

Mark-Simulacrum · 2020-09-10T22:08:56Z

r? @jyn514

tesuji · 2020-09-11T03:29:40Z

I removed all the added doc to make this patch smaller to be able to backport.

jyn514 · 2020-09-11T03:43:35Z

I removed all the added doc to make this patch smaller to be able to backport.

Oh, I don't think there's need for that, the comments won't hurt anything. It's logic changes I'm worried about backporting.

@bors r+

on getting this into nightly. Now about getting this into beta: @rust-lang/rustdoc I see three options:

Don't backport anything. Beta/stable will be missing Join and other unstable traits (Missing Implementors for Join and Pattern trait in rustdoc #75588), and have some rustc_private traits (impl Deref for EndianSlice appears in std docs #74672). This is IMO the worst outcome.
Backport Particially revert #73771 #76529 which is a simple revert. Beta/stable will have Join, but also have other documentation about rustc_private items like gimli traits. This is the most conservative option: it exposes rustc internals, but it makes sure there's no missing docs.
Backport this PR. Beta/stable will have Join and will not have rustc_private items, but there's the possibility this introduces a bug by accident.

Personally I'm in favor of 3, but I'm willing to be convinced by 2. What do you think?

bors · 2020-09-11T03:43:37Z

📌 Commit ccd76110bfcd0339d70f554f5901443dd551fdbf has been approved by jyn514

jyn514 · 2020-09-11T03:44:36Z

cc also @alexcrichton who wrote #73771

jyn514 · 2020-09-11T03:44:53Z

@bors r-

CI is failing, but LGTM when fixed, maybe add back the comments while you're at it

tesuji · 2020-09-11T03:48:29Z

Fixed the tidy error,

maybe add back the comments while you're at it

I will add them back in other cleanup PRs.

@rustbot modify labels: -S-waiting-on-author +S-waiting-on-review

tesuji · 2020-09-13T12:58:09Z

@lzutao please don't force push, github now shows a 4k line diff before and after.

Yeah, I'm sorry. But GitHub could improve their compare page.
At local you could run git range-diff c3d048a...c743fc4, it is a lot cleaner.
My local result of that command:

@@ src/tools/linkchecker/main.rs: fn is_exception(file: &Path, link: &str) -> bool
 +        // calculated in `check` function is outside `build/<triple>/doc` dir.
 +        // So the `strip_prefix` method just returns the old absolute broken path.
 +        if file.ends_with("std/primitive.slice.html") {
-+            if link.ends_with("std/primitive.slice.html") {
++            if link.ends_with("primitive.slice.html") {
 +                return true;
 +            }
 +        }

What change did you make to fix the tidy error?

I simply removed the "std/" prefix, cause windows path (in this case has type lossy &str) usually has \ as path separators.

jyn514 · 2020-09-13T14:22:51Z

GitHub could improve their compare page. At local you could run git range-diff c3d048a...c743fc4, it is a lot cleaner.

Yeah, I've suggested this before (isaacs/github#1834) but it was ignored.

Ok, the change looks fine.

@bors r+

bors · 2020-09-13T14:22:52Z

📌 Commit c743fc4 has been approved by jyn514

tesuji · 2020-09-13T14:28:47Z

Yeah, I've suggested this before (isaacs/github#1834) but it was ignored.

Yeah, that's sad. But I think running range-diff still requires more calculation power than just normal diff.
Consider that github processes thousands of diff requests per second (I guess), it could be a burden for their servers.
Still they could have reply that instead of ignoring the issue.

bors · 2020-09-14T08:25:50Z

⌛ Testing commit c743fc4 with merge 356d8ad...

bors · 2020-09-14T10:23:04Z

☀️ Test successful - checks-actions, checks-azure
Approved by: jyn514
Pushing 356d8ad to master...

tesuji · 2020-09-14T10:24:23Z

Finally! 🎉

jyn514 · 2020-09-14T11:45:59Z

@lzutao to backport this to beta, make a PR with the same commits, but against the beta branch instead of master: https://forge.rust-lang.org/release/beta-backporting.html
Then the rustdoc team will decided whether or not it should be backported.

jyn514 · 2020-09-14T12:48:50Z

@rust-lang/rustdoc this is waiting on a decision about backporting: #76571 (comment)

GuillaumeGomez · 2020-09-14T12:52:15Z

Is there any reason why we shouldn't? If not I guess it's fine to approve the backport.

spastorino · 2020-09-17T14:58:58Z

discussed in T-compiler meeting.

@rustbot modify labels: beta-accepted

…ulacrum [beta] backports * Ignore rustc_private items from std docs rust-lang#76571 * Fix HashMap visualizers in Visual Studio (Code) rust-lang#76389 * Account for version number in NtIdent hack rust-lang#76331 * Account for async functions when suggesting new named lifetime rust-lang#75867 * Fix loading pretty-printers in rust-lldb script rust-lang#76015 This also bumps to the released stable compiler.

Add some docs to rustdoc::clean::inline and def_id functions Split from rust-lang#76571 .

rust-highfive assigned GuillaumeGomez Sep 10, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 10, 2020

tesuji mentioned this pull request Sep 10, 2020

Particially revert #73771 #76529

Closed

jyn514 added A-stability Area: `#[stable]`, `#[unstable]` etc. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Sep 10, 2020

tesuji commented Sep 10, 2020

View reviewed changes

src/librustdoc/clean/inline.rs Outdated Show resolved Hide resolved

jyn514 reviewed Sep 10, 2020

View reviewed changes

tesuji force-pushed the rustdoc-private-traits branch from de818c4 to 43cce69 Compare September 10, 2020 13:48

tesuji changed the title ~~Ignore rustc_private item from std docs~~ Ignore rustc_private items from std docs Sep 10, 2020

tesuji force-pushed the rustdoc-private-traits branch 2 times, most recently from 7679606 to 1444a89 Compare September 10, 2020 14:05

tesuji commented Sep 10, 2020

View reviewed changes

src/test/rustdoc/issue-75588.rs Outdated Show resolved Hide resolved

jyn514 reviewed Sep 10, 2020

View reviewed changes

rust-highfive assigned jyn514 and unassigned GuillaumeGomez Sep 10, 2020

tesuji force-pushed the rustdoc-private-traits branch from 1444a89 to ccd7611 Compare September 11, 2020 03:27

tesuji marked this pull request as ready for review September 11, 2020 03:30

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 Sep 11, 2020

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Sep 11, 2020

tesuji force-pushed the rustdoc-private-traits branch from ccd7611 to c3d048a Compare September 11, 2020 03:45

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 Sep 13, 2020

jyn514 mentioned this pull request Sep 13, 2020

Add a section on how to use git rust-lang/rustc-dev-guide#850

Closed

bors added the merged-by-bors This PR was explicitly merged by bors. label Sep 14, 2020

bors merged commit 356d8ad into rust-lang:master Sep 14, 2020

rustbot added this to the 1.48.0 milestone Sep 14, 2020

tesuji deleted the rustdoc-private-traits branch September 14, 2020 10:23

jyn514 added the beta-nominated Nominated for backporting to the compiler in the beta channel. label Sep 14, 2020

This comment has been minimized.

Sign in to view

This was referenced Sep 15, 2020

compiler-docs: Missing trait impls for type #76736

Closed

Add some docs to rustdoc::clean::inline and def_id functions #76784

Merged

rustbot added the beta-accepted Accepted for backporting to the compiler in the beta channel. label Sep 17, 2020

Mark-Simulacrum removed the beta-nominated Nominated for backporting to the compiler in the beta channel. label Sep 17, 2020

Mark-Simulacrum mentioned this pull request Sep 17, 2020

[beta] backports #76852

Merged

Mark-Simulacrum modified the milestones: 1.48.0, 1.47.0 Sep 17, 2020

Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Oct 6, 2020

Rollup merge of rust-lang#76784 - lzutao:rd_doc, r=GuillaumeGomez

d26ca98

Add some docs to rustdoc::clean::inline and def_id functions Split from rust-lang#76571 .

jyn514 mentioned this pull request Dec 15, 2020

hashbrown's trait implementations appear in std docs #62763

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ignore rustc_private items from std docs #76571

Ignore rustc_private items from std docs #76571

tesuji commented Sep 10, 2020 •

edited

Loading

rust-highfive commented Sep 10, 2020

jyn514 left a comment

jyn514 Sep 10, 2020

Mark-Simulacrum commented Sep 10, 2020

tesuji commented Sep 11, 2020

jyn514 commented Sep 11, 2020 •

edited

Loading

bors commented Sep 11, 2020

jyn514 commented Sep 11, 2020 •

edited

Loading

jyn514 commented Sep 11, 2020 •

edited

Loading

tesuji commented Sep 11, 2020 •

edited

Loading

tesuji commented Sep 13, 2020 •

edited

Loading

jyn514 commented Sep 13, 2020

bors commented Sep 13, 2020

tesuji commented Sep 13, 2020 •

edited

Loading

bors commented Sep 14, 2020

bors commented Sep 14, 2020

tesuji commented Sep 14, 2020

jyn514 commented Sep 14, 2020

jyn514 commented Sep 14, 2020

This comment has been minimized.

GuillaumeGomez commented Sep 14, 2020

spastorino commented Sep 17, 2020

Ignore rustc_private items from std docs #76571

Ignore rustc_private items from std docs #76571

Conversation

tesuji commented Sep 10, 2020 • edited Loading

rust-highfive commented Sep 10, 2020

jyn514 left a comment

Choose a reason for hiding this comment

jyn514 Sep 10, 2020

Choose a reason for hiding this comment

Mark-Simulacrum commented Sep 10, 2020

tesuji commented Sep 11, 2020

jyn514 commented Sep 11, 2020 • edited Loading

bors commented Sep 11, 2020

jyn514 commented Sep 11, 2020 • edited Loading

jyn514 commented Sep 11, 2020 • edited Loading

tesuji commented Sep 11, 2020 • edited Loading

tesuji commented Sep 13, 2020 • edited Loading

jyn514 commented Sep 13, 2020

bors commented Sep 13, 2020

tesuji commented Sep 13, 2020 • edited Loading

bors commented Sep 14, 2020

bors commented Sep 14, 2020

tesuji commented Sep 14, 2020

jyn514 commented Sep 14, 2020

jyn514 commented Sep 14, 2020

This comment has been minimized.

GuillaumeGomez commented Sep 14, 2020

spastorino commented Sep 17, 2020

tesuji commented Sep 10, 2020 •

edited

Loading

jyn514 commented Sep 11, 2020 •

edited

Loading

jyn514 commented Sep 11, 2020 •

edited

Loading

jyn514 commented Sep 11, 2020 •

edited

Loading

tesuji commented Sep 11, 2020 •

edited

Loading

tesuji commented Sep 13, 2020 •

edited

Loading

tesuji commented Sep 13, 2020 •

edited

Loading