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 tests error output without tidy is very bad #85061

Open
tmandry opened this issue May 8, 2021 · 6 comments
Open

rustdoc tests error output without tidy is very bad #85061

tmandry opened this issue May 8, 2021 · 6 comments
Labels
T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@tmandry
Copy link
Member

tmandry commented May 8, 2021

Note: tidy here is the html diff / format tool, not src/tools/tidy

From the 1.52 retrospective: Having this installed would have made it much easier to spot the issue in #84950.

@tmandry tmandry added the T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. label May 8, 2021
@jyn514
Copy link
Member

jyn514 commented May 8, 2021

"depend" is not quite correct - tests will pass fine without it, but if they fail the error message is very bad.

@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented May 8, 2021

We improved the error message in case tidy isn't installed to avoid showing up the HTML diff, so let's say it's less good and more difficult to understand.

@jyn514 jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label May 19, 2021
@GuillaumeGomez
Copy link
Member

I think we can close it since it's possible to run rustdoc tests without tidy installed.

@jyn514
Copy link
Member

jyn514 commented Nov 2, 2022

"depend" is not quite correct - tests will pass fine without it, but if they fail the error message is very bad.

@GuillaumeGomez this problem is still not solved.

@jyn514 jyn514 reopened this Nov 2, 2022
@GuillaumeGomez
Copy link
Member

Renaming the issue to reflect this then.

@GuillaumeGomez GuillaumeGomez changed the title rustdoc tests depend on tidy which isn't installed on release builders rustdoc tests error output without tidy is very bad Nov 2, 2022
@jyn514
Copy link
Member

jyn514 commented Nov 2, 2022

@tmandry A simple solution is to just install tidy on the release builders. I don't know how to do that but it's packaged in nearly every distro.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-infra Relevant to the infrastructure team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants