/rust

Switch to pulldown as default markdown renderer #47398

Merged
merged 1 commit into from Jan 18, 2018

Conversation

Reviewers
No reviews
Assignees

@QuietMisdreavus QuietMisdreavus

Labels
Projects
None yet
Milestone
No milestone
6 participants
@GuillaumeGomez @QuietMisdreavus @bors @Mark-Simulacrum @shepmaster @kennytm
@GuillaumeGomez
Member

GuillaumeGomez commented Jan 12, 2018

r? @QuietMisdreavus

@rust-highfive rust-highfive assigned QuietMisdreavus Jan 12, 2018

@nrc nrc referenced this pull request Jan 12, 2018

Closed

Tracking issue (Rustdoc): hoedown -> pulldown migration #44229

10 of 10 tasks complete
@QuietMisdreavus

This comment has been minimized.

Show comment
Hide comment
@QuietMisdreavus

QuietMisdreavus Jan 12, 2018

Member

cc #44229

So, this will be interesting. I'm pretty sure that there's some rustdoc tests that use the --enable-commonmark flag, so those will probably need to be changed. I'm also curious to see whether the pulldown switch breaks any of our tests, because this will be the first time most of them will have been run with it. >_> Let's see what happens with travis.
Member

QuietMisdreavus commented Jan 12, 2018

cc #44229

So, this will be interesting. I'm pretty sure that there's some rustdoc tests that use the --enable-commonmark flag, so those will probably need to be changed. I'm also curious to see whether the pulldown switch breaks any of our tests, because this will be the first time most of them will have been run with it. >_> Let's see what happens with travis.

@Mark-Simulacrum Mark-Simulacrum added the relnotes label Jan 12, 2018

@shepmaster shepmaster added the S-waiting-on-review label Jan 13, 2018

@GuillaumeGomez

This comment has been minimized.

Show comment
Hide comment
@GuillaumeGomez

GuillaumeGomez Jan 13, 2018

Member

No, I looked for it but nothing (or at least, git grep -n "enable-commonmark" returned nothing).

@bors: r=QuietMisdreavus
Member

GuillaumeGomez commented Jan 13, 2018

No, I looked for it but nothing (or at least, git grep -n "enable-commonmark" returned nothing).

@bors: r=QuietMisdreavus
@bors

This comment has been minimized.

Show comment
Hide comment
@bors

bors Jan 13, 2018

Contributor

📌 Commit f312046 has been approved by QuietMisdreavus
Contributor

bors commented Jan 13, 2018

📌 Commit f312046 has been approved by QuietMisdreavus

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 14, 2018

@GuillaumeGomez
Rollup merge of #47398 - GuillaumeGomez:pulldown-warnings, r=QuietMis… 
…dreavus

Switch to pulldown as default markdown renderer

r? @QuietMisdreavus
d4d8d76

@GuillaumeGomez GuillaumeGomez referenced this pull request Jan 14, 2018

Closed

Rollup of 8 pull requests #47435

bors added a commit that referenced this pull request Jan 15, 2018

@bors
Auto merge of #47435 - GuillaumeGomez:rollup, r=GuillaumeGomez 
Rollup of 8 pull requests

- Successful merges: #47120, #47126, #47277, #47330, #47398, #47413, #47417, #47432
- Failed merges:
Loading status checks…
9e05654

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 16, 2018

@GuillaumeGomez
Rollup merge of #47398 - GuillaumeGomez:pulldown-warnings, r=QuietMis… 
…dreavus

Switch to pulldown as default markdown renderer

r? @QuietMisdreavus
3fa53a4

@GuillaumeGomez GuillaumeGomez referenced this pull request Jan 16, 2018

Closed

Rollup of 6 pull requests #47485

bors added a commit that referenced this pull request Jan 16, 2018

@bors
Auto merge of #47485 - GuillaumeGomez:rollup, r=GuillaumeGomez 
Rollup of 6 pull requests

- Successful merges: #47250, #47302, #47387, #47398, #47436, #47444
- Failed merges:
Loading status checks…
db1abf8

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 16, 2018

@GuillaumeGomez
Rollup merge of #47398 - GuillaumeGomez:pulldown-warnings, r=QuietMis… 
…dreavus

Switch to pulldown as default markdown renderer

r? @QuietMisdreavus
af6bdd2

@GuillaumeGomez GuillaumeGomez referenced this pull request Jan 16, 2018

Closed

Rollup of 6 pull requests #47492

bors added a commit that referenced this pull request Jan 16, 2018

@bors
Auto merge of #47492 - GuillaumeGomez:rollup, r=GuillaumeGomez 
Rollup of 6 pull requests

- Successful merges: #47250, #47302, #47387, #47398, #47436, #47444
- Failed merges:
Loading status checks…
047132d

bors added a commit that referenced this pull request Jan 17, 2018

@bors
Auto merge of #47492 - GuillaumeGomez:rollup, r=GuillaumeGomez 
Rollup of 6 pull requests

- Successful merges: #47250, #47302, #47387, #47398, #47436, #47444
- Failed merges:
Loading status checks…
2d3558e

@kennytm kennytm added S-waiting-on-bors and removed S-waiting-on-review labels Jan 17, 2018

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jan 17, 2018

@GuillaumeGomez
Rollup merge of #47398 - GuillaumeGomez:pulldown-warnings, r=QuietMis… 
…dreavus

Switch to pulldown as default markdown renderer

r? @QuietMisdreavus
49065a1

@GuillaumeGomez GuillaumeGomez referenced this pull request Jan 17, 2018

Merged

Rollup of 6 pull requests #47528

bors added a commit that referenced this pull request Jan 18, 2018

@bors
Auto merge of #47528 - GuillaumeGomez:rollup, r=GuillaumeGomez 
Rollup of 6 pull requests

- Successful merges: #47250, #47313, #47398, #47468, #47471, #47520
- Failed merges:
Loading status checks…
bbb3ff6

bors added a commit that referenced this pull request Jan 18, 2018

@bors
Auto merge of #47528 - GuillaumeGomez:rollup, r=GuillaumeGomez 
Rollup of 6 pull requests

- Successful merges: #47250, #47313, #47398, #47468, #47471, #47520
- Failed merges:
Loading status checks…
a58b55c

bors added a commit that referenced this pull request Jan 18, 2018

@bors
Auto merge of #47528 - GuillaumeGomez:rollup, r=GuillaumeGomez 
Rollup of 6 pull requests

- Successful merges: #47250, #47313, #47398, #47468, #47471, #47520
- Failed merges:
Loading status checks…
3bd4af8

@bors bors merged commit f312046 into rust-lang:master Jan 18, 2018
1 check passed

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@GuillaumeGomez GuillaumeGomez deleted the GuillaumeGomez:pulldown-warnings branch Jan 18, 2018

@kennytm kennytm referenced this pull request Feb 8, 2018

Closed

Nightly rustdoc warns about code block if it contains comments and tab #48068

@QuietMisdreavus QuietMisdreavus referenced this pull request Feb 16, 2018

Merged

Remove hoedown from rustdoc #48274

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Feb 16, 2018

@GuillaumeGomez
Remove hoedown from rustdoc 
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.
5ec00e2

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Feb 16, 2018

@GuillaumeGomez
Remove hoedown from rustdoc 
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.
186384e

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Feb 16, 2018

@GuillaumeGomez
Remove hoedown from rustdoc 
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.
6f8cfde

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Feb 16, 2018

@GuillaumeGomez
Remove hoedown from rustdoc 
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.
5bd5bc3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment