search

rust-lang / rust

Empowering everyone to build reliable and efficient software.
https://www.rust-lang.org
Other
98.36k stars 12.72k forks source link

rustdoc tests error output without `tidy` is very bad #85061

Open tmandry opened 3 years ago

tmandry commented 3 years ago

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.

jyn514 commented 3 years ago

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

GuillaumeGomez commented 3 years ago

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.

GuillaumeGomez commented 2 years ago

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

jyn514 commented 2 years ago

"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.

GuillaumeGomez commented 2 years ago

Renaming the issue to reflect this then.

jyn514 commented 2 years ago

@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.

lolbinarycat commented 3 weeks ago

at the very least the "tidy is not installed" message should link to the tool's homepage so it can be installed.

this is especially confusing because of the existence of the tidy tool.