Print rustdoc rendering warnings all the time #45324
Conversation
|
cc #44229 IMO it's way too early for this, like shouldn't we be following that process? The next step is to print the warnings by default (instead of just when |
|
Hum... I thought that the next step was to make the pulldown renderer the default one in the next cycle and to print the warnings by default (which makes sense). Didn't understood that it was two steps? |
|
As far as i understand the intended process, we were supposed to warn people about the rendering changes without changing the rendering output. By switching the default renderer like this, we're warning them about the changes while we mess up their docs, which is what we set out to avoid by adding all this overhead. |
GuillaumeGomez
added
I-nominated
T-dev-tools
GuillaumeGomez
force-pushed
the
switch-default-markdown-renderer
branch
from
1a4e9ca
to
11b2b08
Compare
GuillaumeGomez
changed the title
|
Updated. |
|
Much better! Now we just print the warnings all the time, and begin our stability cycle for real. |
|
We discussed this in the dev-tools meeting. It seems like the next logical step. Thanks for the PR, @GuillaumeGomez! |
steveklabnik
added
the
relnotes
|
@bors: r+ thank you! |
|
📌 Commit 11b2b08 has been approved by |
kennytm
added
the
S-waiting-on-bors
|
Is there any reason that these warnings aren't emitted when using rustdoc on plain markdown files? |
|
@ollie27: No idea. It should though... I think it's a separate issue. Can you open an issue so I can look into it later on please? |
|
done: #45365 |
…r, r=steveklabnik Print rustdoc rendering warnings all the time r? @rust-lang/dev-tools
|
☀️ Test successful - status-appveyor, status-travis |
Is it really time? Have our months, no, *years* of suffering come to an end? Are we finally able to cast off the pall of Hoedown? The weight which has dragged us down for so long? ----- So, timeline for those who need to catch up: * Way back in December 2016, [we decided we wanted to switch out the markdown renderer](rust-lang#38400). However, this was put on hold because the build system at the time made it difficult to pull in dependencies from crates.io. * A few months later, in March 2017, [the first PR was done, to switch out the renderers entirely](rust-lang#40338). The PR itself was fraught with CI and build system issues, but eventually landed. * However, not all was well in the Rustdoc world. During the PR and shortly after, we noticed [some differences in the way the two parsers handled some things](rust-lang#40912), and some of these differences were major enough to break the docs for some crates. * A couple weeks afterward, [Hoedown was put back in](rust-lang#41290), at this point just to catch tests that Pulldown was "spuriously" running. This would at least provide some warning about spurious tests, rather than just breaking spontaneously. * However, the problems had created enough noise by this point that just a few days after that, [Hoedown was switched back to the default](rust-lang#41431) while we came up with a solution for properly warning about the differences. * That solution came a few weeks later, [as a series of warnings when the HTML emitted by the two parsers was semantically different](rust-lang#41991). But that came at a cost, as now rustdoc needed proc-macro support (the new crate needed some custom derives farther down its dependency tree), and the build system was not equipped to handle it at the time. It was worked on for three months as the issue stumped more and more people. * In that time, [bootstrap was completely reworked](rust-lang#43059) to change how it ordered compilation, and [the method by which it built rustdoc would change](rust-lang#43482), as well. This allowed it to only be built after stage1, when proc-macros would be available, allowing the "rendering differences" PR to finally land. * The warnings were not perfect, and revealed a few [spurious](rust-lang#44368) [differences](rust-lang#45421) between how we handled the renderers. * Once these were handled, [we flipped the switch to turn on the "rendering difference" warnings all the time](rust-lang#45324), in October 2017. This began the "warning cycle" for this change, and landed in stable in 1.23, on 2018-01-04. * Once those warnings hit stable, and after a couple weeks of seeing whether we would get any more reports than what we got from sitting on nightly/beta, [we switched the renderers](rust-lang#47398), making Pulldown the default but still offering the option to use Hoedown. And that brings us to the present. We haven't received more new issues from this in the meantime, and the "switch by default" is now on beta. Our reasoning is that, at this point, anyone who would have been affected by this has run into it already.
r? @rust-lang/dev-tools