2014-06-28 03:35:25 -07:00
|
|
|
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
|
// file at the top-level directory of this distribution and at
|
|
|
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
|
|
|
//
|
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
|
// except according to those terms.
|
|
|
|
|
|
2018-01-10 08:58:39 -08:00
|
|
|
use std::fs;
|
2016-10-08 16:29:10 -04:00
|
|
|
use std::path::Path;
|
2015-02-26 21:00:43 -08:00
|
|
|
use std::str;
|
2018-05-08 13:42:53 -05:00
|
|
|
use errors;
|
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.
2018-02-16 15:09:19 +01:00
|
|
|
use html::markdown::Markdown;
|
2014-06-28 03:35:25 -07:00
|
|
|
|
2015-01-03 22:54:18 -05:00
|
|
|
#[derive(Clone)]
|
2018-01-20 22:16:46 +01:00
|
|
|
pub struct ExternalHtml {
|
2016-10-08 17:34:13 -04:00
|
|
|
/// Content that will be included inline in the <head> section of a
|
|
|
|
|
/// rendered Markdown file or generated documentation
|
2014-06-28 03:35:25 -07:00
|
|
|
pub in_header: String,
|
2016-10-08 17:34:13 -04:00
|
|
|
/// Content that will be included inline between <body> and the content of
|
|
|
|
|
/// a rendered Markdown file or generated documentation
|
2014-06-28 03:35:25 -07:00
|
|
|
pub before_content: String,
|
2016-10-08 17:34:13 -04:00
|
|
|
/// Content that will be included inline between the content and </body> of
|
|
|
|
|
/// a rendered Markdown file or generated documentation
|
2014-06-28 03:35:25 -07:00
|
|
|
pub after_content: String
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl ExternalHtml {
|
2017-05-08 14:25:01 +02:00
|
|
|
pub fn load(in_header: &[String], before_content: &[String], after_content: &[String],
|
2018-05-08 13:42:53 -05:00
|
|
|
md_before_content: &[String], md_after_content: &[String], diag: &errors::Handler)
|
2014-06-28 03:35:25 -07:00
|
|
|
-> Option<ExternalHtml> {
|
2018-05-08 13:42:53 -05:00
|
|
|
load_external_files(in_header, diag)
|
2016-10-08 23:53:57 -04:00
|
|
|
.and_then(|ih|
|
2018-05-08 13:42:53 -05:00
|
|
|
load_external_files(before_content, diag)
|
2016-10-08 23:53:57 -04:00
|
|
|
.map(|bc| (ih, bc))
|
|
|
|
|
)
|
2017-05-08 14:25:01 +02:00
|
|
|
.and_then(|(ih, bc)|
|
2018-05-08 13:42:53 -05:00
|
|
|
load_external_files(md_before_content, diag)
|
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.
2018-02-16 15:09:19 +01:00
|
|
|
.map(|m_bc| (ih, format!("{}{}", bc, Markdown(&m_bc, &[]))))
|
2017-05-08 14:25:01 +02:00
|
|
|
)
|
2016-10-08 23:53:57 -04:00
|
|
|
.and_then(|(ih, bc)|
|
2018-05-08 13:42:53 -05:00
|
|
|
load_external_files(after_content, diag)
|
2016-10-08 23:53:57 -04:00
|
|
|
.map(|ac| (ih, bc, ac))
|
|
|
|
|
)
|
2017-05-08 14:25:01 +02:00
|
|
|
.and_then(|(ih, bc, ac)|
|
2018-05-08 13:42:53 -05:00
|
|
|
load_external_files(md_after_content, diag)
|
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.
2018-02-16 15:09:19 +01:00
|
|
|
.map(|m_ac| (ih, bc, format!("{}{}", ac, Markdown(&m_ac, &[]))))
|
2017-05-08 14:25:01 +02:00
|
|
|
)
|
2016-10-08 23:53:57 -04:00
|
|
|
.map(|(ih, bc, ac)|
|
|
|
|
|
ExternalHtml {
|
|
|
|
|
in_header: ih,
|
|
|
|
|
before_content: bc,
|
|
|
|
|
after_content: ac,
|
|
|
|
|
}
|
|
|
|
|
)
|
2014-06-28 03:35:25 -07:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-10-08 22:55:40 -04:00
|
|
|
pub enum LoadStringError {
|
|
|
|
|
ReadFail,
|
|
|
|
|
BadUtf8,
|
2014-06-28 03:35:25 -07:00
|
|
|
}
|
|
|
|
|
|
2018-05-08 13:42:53 -05:00
|
|
|
pub fn load_string<P: AsRef<Path>>(file_path: P, diag: &errors::Handler)
|
|
|
|
|
-> Result<String, LoadStringError>
|
|
|
|
|
{
|
2016-10-08 22:55:40 -04:00
|
|
|
let file_path = file_path.as_ref();
|
2018-01-10 08:58:39 -08:00
|
|
|
let contents = match fs::read(file_path) {
|
|
|
|
|
Ok(bytes) => bytes,
|
|
|
|
|
Err(e) => {
|
2018-05-08 13:42:53 -05:00
|
|
|
diag.struct_err(&format!("error reading `{}`: {}", file_path.display(), e)).emit();
|
2018-01-10 08:58:39 -08:00
|
|
|
return Err(LoadStringError::ReadFail);
|
|
|
|
|
}
|
|
|
|
|
};
|
2016-10-08 22:55:40 -04:00
|
|
|
match str::from_utf8(&contents) {
|
|
|
|
|
Ok(s) => Ok(s.to_string()),
|
|
|
|
|
Err(_) => {
|
2018-05-08 13:42:53 -05:00
|
|
|
diag.struct_err(&format!("error reading `{}`: not UTF-8", file_path.display())).emit();
|
2016-10-08 22:55:40 -04:00
|
|
|
Err(LoadStringError::BadUtf8)
|
2014-06-28 03:35:25 -07:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-05-08 13:42:53 -05:00
|
|
|
fn load_external_files(names: &[String], diag: &errors::Handler) -> Option<String> {
|
2014-06-28 03:35:25 -07:00
|
|
|
let mut out = String::new();
|
2015-01-31 12:20:46 -05:00
|
|
|
for name in names {
|
2018-05-08 13:42:53 -05:00
|
|
|
let s = match load_string(name, diag) {
|
2016-10-08 22:55:40 -04:00
|
|
|
Ok(s) => s,
|
|
|
|
|
Err(_) => return None,
|
|
|
|
|
};
|
|
|
|
|
out.push_str(&s);
|
2014-09-22 08:28:35 -07:00
|
|
|
out.push('\n');
|
2014-06-28 03:35:25 -07:00
|
|
|
}
|
|
|
|
|
Some(out)
|
|
|
|
|
}
|
