summaryrefslogtreecommitdiffstats
path: root/COPYRIGHT
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2018-02-16 15:09:19 +0100
committerGuillaume Gomez <guillaume1.gomez@gmail.com>2018-02-16 23:17:15 +0100
commit5bd5bc3f21d91496d03c68ac1e08745f2f19c9e9 (patch)
tree274b26c6a9404d905177032b196f690abf153326 /COPYRIGHT
parentAuto merge of #46714 - leodasvacas:refactor-structurally-resolve-type, r=niko... (diff)
downloadgrust-5bd5bc3f21d91496d03c68ac1e08745f2f19c9e9.tar.gz
grust-5bd5bc3f21d91496d03c68ac1e08745f2f19c9e9.tar.bz2
grust-5bd5bc3f21d91496d03c68ac1e08745f2f19c9e9.tar.xz
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](https://github.com/rust-lang/rust/issues/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](https://github.com/rust-lang/rust/pull/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](https://github.com/rust-lang/rust/issues/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](https://github.com/rust-lang/rust/pull/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](https://github.com/rust-lang/rust/pull/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](https://github.com/rust-lang/rust/pull/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](https://github.com/rust-lang/rust/pull/43059) to change how it ordered compilation, and [the method by which it built rustdoc would change](https://github.com/rust-lang/rust/pull/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](https://github.com/rust-lang/rust/pull/44368) [differences](https://github.com/rust-lang/rust/pull/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](https://github.com/rust-lang/rust/pull/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](https://github.com/rust-lang/rust/pull/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.
Diffstat (limited to 'COPYRIGHT')
-rw-r--r--COPYRIGHT22
1 files changed, 0 insertions, 22 deletions
diff --git a/COPYRIGHT b/COPYRIGHT
index f8b637d204..9bc018d983 100644
--- a/COPYRIGHT
+++ b/COPYRIGHT
@@ -192,28 +192,6 @@ their own copyright notices and license terms:
192 USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 192 USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
193 OF SUCH DAMAGE. 193 OF SUCH DAMAGE.
194 194
195* Hoedown, the markdown parser, under src/rt/hoedown, is
196 licensed as follows.
197
198 Copyright (c) 2008, Natacha Porté
199 Copyright (c) 2011, Vicent Martí
200 Copyright (c) 2013, Devin Torres and the Hoedown authors
201
202 Permission to use, copy, modify, and distribute this
203 software for any purpose with or without fee is hereby
204 granted, provided that the above copyright notice and
205 this permission notice appear in all copies.
206
207 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR
208 DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
209 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
210 FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
211 SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR
212 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
213 OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
214 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
215 CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
216
217* libbacktrace, under src/libbacktrace: 195* libbacktrace, under src/libbacktrace:
218 196
219 Copyright (C) 2012-2014 Free Software Foundation, Inc. 197 Copyright (C) 2012-2014 Free Software Foundation, Inc.