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

Use a crate to produce rustdoc tree comparisons instead of the diff command #82469

Merged
merged 1 commit into from
Mar 3, 2021

Conversation

notriddle
Copy link
Contributor

@notriddle notriddle commented Feb 24, 2021

It doesn't come with Windows, so bring our own.

Fixes #82409

image

@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 Feb 24, 2021
@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. A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself labels Feb 24, 2021
@Nemo157
Copy link
Member

Nemo157 commented Feb 25, 2021

Maybe it'd be worth replacing the other diff function too, if unified-diff produces better results?

https://github.com/rust-lang/rust/blob/3d82ea37a5b2dc3aa233dd69270d21a82804d433/src/tools/compiletest/src/runtest.rs#L103-L206

@notriddle
Copy link
Contributor Author

notriddle commented Feb 25, 2021

I expect both of them would produce very similar results, but slightly differently formatted.

I don't want to reformat all of the MIR diff files in the test suite. That sounds like a lot of churn for nothing.

I also don't want to break people's custom diff viewers that they're using for the rustdoc diff, which is why it doesn't just use the existing diff tool for it.

@notriddle notriddle marked this pull request as ready for review February 25, 2021 23:01
@Mark-Simulacrum
Copy link
Member

r=me with commits squashed a bit

@Mark-Simulacrum Mark-Simulacrum 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-review Status: Awaiting review from the assignee but also interested parties. labels Mar 1, 2021
… command

It doesn't exist on Windows, so we bring our own unified diff implementation.

Fixes rust-lang#82409
@notriddle
Copy link
Contributor Author

Okay, it's been rebased and squashed. @Mark-Simulacrum

@Mark-Simulacrum
Copy link
Member

@bors r+

@bors
Copy link
Contributor

bors commented Mar 1, 2021

📌 Commit b29d9d5 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Mar 1, 2021
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Mar 2, 2021
…k-Simulacrum

Use a crate to produce rustdoc tree comparisons instead of the `diff` command

It doesn't come with Windows, so bring [our own](https://github.com/notriddle/rust-unified-diff/).

Fixes rust-lang#82409

![image](https://user-images.githubusercontent.com/1593513/109230755-9a1d5700-7782-11eb-8359-353a506875ab.png)
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request Mar 3, 2021
…k-Simulacrum

Use a crate to produce rustdoc tree comparisons instead of the `diff` command

It doesn't come with Windows, so bring [our own](https://github.com/notriddle/rust-unified-diff/).

Fixes rust-lang#82409

![image](https://user-images.githubusercontent.com/1593513/109230755-9a1d5700-7782-11eb-8359-353a506875ab.png)
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2021
Rollup of 10 pull requests

Successful merges:

 - rust-lang#81223 ([rustdoc] Generate redirect map file)
 - rust-lang#82439 (BTree: fix untrue safety)
 - rust-lang#82469 (Use a crate to produce rustdoc tree comparisons instead of the `diff` command)
 - rust-lang#82589 (unix: Non-mutable bufs in send_vectored_with_ancillary_to)
 - rust-lang#82689 (meta: Notify Zulip for rustdoc nominated issues)
 - rust-lang#82695 (Revert non-power-of-two vector restriction)
 - rust-lang#82706 (use outer_expn_data() instead of outer_expn().expn_data())
 - rust-lang#82710 (FloatToInit: Replacing round_unchecked_to --> to_int_unchecked)
 - rust-lang#82712 (Remove unnecessary conditional `cfg(target_os)` for `redox` and `vxworks`)
 - rust-lang#82713 (Update cargo)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 0c7e898 into rust-lang:master Mar 3, 2021
@rustbot rustbot added this to the 1.52.0 milestone Mar 3, 2021
@notriddle notriddle deleted the bring-our-own-diff branch March 3, 2021 19:46
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.

Diff on rustdoc test failure does not work on Windows
7 participants