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

Re-enable hoedown by default #41431

Merged
merged 5 commits into from
Apr 22, 2017
Merged

Conversation

GuillaumeGomez
Copy link
Member

r? @rust-lang/docs

cc @aturon

@GuillaumeGomez
Copy link
Member Author

To make this PR works when running "-Z unstable-options enable-commonmark", we need #41405 to be merged as well (but after if possible).

@steveklabnik
Copy link
Member

I've r+'d that PR

@GuillaumeGomez
Copy link
Member Author

Ok thanks. When merged, I'll update this one.

@shepmaster shepmaster added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Apr 21, 2017
@aturon
Copy link
Member

aturon commented Apr 21, 2017

OK, I've confirmed that this indeed includes the old hoedown code as of this commit, and properly threads through a new render type flag. Thanks @GuillaumeGomez!

r=me when ready.

@GuillaumeGomez GuillaumeGomez force-pushed the hoedown-default branch 5 times, most recently from 7ce1eb7 to 225d345 Compare April 21, 2017 20:59
@bors
Copy link
Contributor

bors commented Apr 22, 2017

☔ The latest upstream changes (presumably #41459) made this pull request unmergeable. Please resolve the merge conflicts.

@GuillaumeGomez
Copy link
Member Author

@bors: r=aturon

@bors
Copy link
Contributor

bors commented Apr 22, 2017

📌 Commit 9c97882 has been approved by aturon

@bors
Copy link
Contributor

bors commented Apr 22, 2017

⌛ Testing commit 9c97882 with merge cb4065b...

bors added a commit that referenced this pull request Apr 22, 2017
Re-enable hoedown by default

r? @rust-lang/docs

cc @aturon
@bors
Copy link
Contributor

bors commented Apr 22, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: aturon
Pushing cb4065b to master...

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Feb 16, 2018
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants