Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rustdoc: Print a warning if the diff when comparing to old nightlies is empty #85997

Merged
merged 1 commit into from
Jun 10, 2021

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Jun 4, 2021

This avoids confusing situations where it's unclear whether there's a
bug in the diff tool or not:

26: @has check failed
        `XPATH PATTERN` did not match
        // @has - '//code/a[@href="{{channel}}/std/primitive.i32.html"]' 'i32'

Encountered 6 errors

------------------------------------------

info: generating a diff against nightly rustdoc

failures:
    [rustdoc] rustdoc/primitive-reexport.rs

@jyn514 jyn514 added A-testsuite Area: The testsuite used to check the correctness of rustc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 4, 2021
@rust-highfive
Copy link
Collaborator

r? @Mark-Simulacrum

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 4, 2021
@jyn514 jyn514 added A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 4, 2021
@rust-log-analyzer

This comment has been minimized.

…is empty

This avoids confusing situations where it's unclear whether there's a
bug in the diff tool or not:

```
26: @Has check failed
        `XPATH PATTERN` did not match
        // @Has - '//code/a[@href="{{channel}}/std/primitive.i32.html"]' 'i32'

Encountered 6 errors

------------------------------------------

info: generating a diff against nightly rustdoc

failures:
    [rustdoc] rustdoc/primitive-reexport.rs
```
@jyn514 jyn514 added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 4, 2021
@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

Seems OK as an improvement. I'm a bit worried by the allegedly nightly (though I see no record of that, we seem to just invoke whatever rustdoc we happen to find, and on Windows especially that's pretty likely to be the newly built rustdoc I'd expect, as it's easy for the bin directory to end up in PATH there) rustdoc. I'm not sure if I expressed similar concerns before or what the purpose of this code is, but it seems surprising.

@bors
Copy link
Contributor

bors commented Jun 9, 2021

📌 Commit 2430ede has been approved by Mark-Simulacrum

@bors 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 Jun 9, 2021
@jyn514
Copy link
Member Author

jyn514 commented Jun 9, 2021

Yeah, I do want to change it to download a version from CI at some point (maybe reusing the logic from download-rustc?) but I haven't gotten around to it yet.

bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 10, 2021
Rollup of 7 pull requests

Successful merges:

 - rust-lang#82037 (Make symbols stripping work on MacOS X)
 - rust-lang#84687 (Multiple improvements to RwLocks)
 - rust-lang#85997 (rustdoc: Print a warning if the diff when comparing to old nightlies is empty)
 - rust-lang#86051 (Updated code examples and wording in move keyword documentation )
 - rust-lang#86111 (fix off by one in `std::iter::Iterator` documentation)
 - rust-lang#86113 (build doctests with lld if use-lld = true)
 - rust-lang#86175 (update Miri)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 232e7a5 into rust-lang:master Jun 10, 2021
@rustbot rustbot added this to the 1.54.0 milestone Jun 10, 2021
@jyn514 jyn514 deleted the rustdoc-diff branch June 10, 2021 12:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-testsuite Area: The testsuite used to check the correctness of rustc S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants