bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Improve how warnings are displayed

Browse source
This commit is contained in:
Guillaume Gomez 2017-09-06 11:53:50 +02:00
parent ef227f5ffe
commit 7aa5367236
1 changed files with 44 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

68
src/librustdoc/html/render.rs
View file

@ -588,14 +588,10 @@ pub fn run(mut krate: clean::Crate,
let markdown_warnings = scx.markdown_warnings.borrow(); let markdown_warnings = scx.markdown_warnings.borrow();
if !markdown_warnings.is_empty() { if !markdown_warnings.is_empty() {
println!("WARNING: documentation for this crate may be rendered \ let mut intro_msg = false;
differently using the new Pulldown renderer.");
println!(" See https://github.com/rust-lang/rust/issues/44229 for details.");
for &(ref span, ref text, ref diffs) in &*markdown_warnings { for &(ref span, ref text, ref diffs) in &*markdown_warnings {
println!("WARNING: rendering difference in `{}`", concise_str(text));
println!(" --> {}:{}:{}", span.filename, span.loline, span.locol);
for d in diffs { for d in diffs {
render_difference(d); render_difference(d, &mut intro_msg, span, text);
} }
} }
} }
@ -648,43 +644,67 @@ fn concise_compared_strs(s1: &str, s2: &str) -> (String, String) {
(format!("...{}", concise_str(s1)), format!("...{}", concise_str(s2))) (format!("...{}", concise_str(s1)), format!("...{}", concise_str(s2)))
} }
fn render_difference(diff: &html_diff::Difference) {
fn print_message(msg: &str, intro_msg: &mut bool, span: &Span, text: &str) {
if !*intro_msg {
println!("WARNING: documentation for this crate may be rendered \
differently using the new Pulldown renderer.");
println!(" See https://github.com/rust-lang/rust/issues/44229 for details.");
*intro_msg = true;
}
println!("WARNING: rendering difference in `{}`", concise_str(text));
println!(" --> {}:{}:{}", span.filename, span.loline, span.locol);
println!("{}", msg);
}
fn render_difference(diff: &html_diff::Difference, intro_msg: &mut bool, span: &Span, text: &str) {
match *diff { match *diff {
html_diff::Difference::NodeType { ref elem, ref opposite_elem } => { html_diff::Difference::NodeType { ref elem, ref opposite_elem } => {
println!(" {} Types differ: expected: `{}`, found: `{}`", print_message(&format!(" {} Types differ: expected: `{}`, found: `{}`",
elem.path, elem.element_name, opposite_elem.element_name); elem.path, elem.element_name, opposite_elem.element_name),
intro_msg, span, text);
} }
html_diff::Difference::NodeName { ref elem, ref opposite_elem } => { html_diff::Difference::NodeName { ref elem, ref opposite_elem } => {
println!(" {} Tags differ: expected: `{}`, found: `{}`", print_message(&format!(" {} Tags differ: expected: `{}`, found: `{}`",
elem.path, elem.element_name, opposite_elem.element_name); elem.path, elem.element_name, opposite_elem.element_name),
intro_msg, span, text);
} }
html_diff::Difference::NodeAttributes { ref elem, html_diff::Difference::NodeAttributes { ref elem,
ref elem_attributes, ref elem_attributes,
ref opposite_elem_attributes, ref opposite_elem_attributes,
.. } => { .. } => {
println!(" {} Attributes differ in `{}`: expected: `{:?}`, found: `{:?}`", print_message(&format!(" {} Attributes differ in `{}`: expected: `{:?}`, \
elem.path, elem.element_name, elem_attributes, opposite_elem_attributes); found: `{:?}`",
elem.path, elem.element_name, elem_attributes,
opposite_elem_attributes),
intro_msg, span, text);
} }
html_diff::Difference::NodeText { ref elem, ref elem_text, ref opposite_elem_text, .. } => { html_diff::Difference::NodeText { ref elem, ref elem_text, ref opposite_elem_text, .. } => {
if elem_text.split("\n") if elem_text.split("\n")
.zip(opposite_elem_text.split("\n")) .zip(opposite_elem_text.split("\n"))
.any(|(a, b)| a.trim() != b.trim()) { .any(|(a, b)| a.trim() != b.trim()) {
let (s1, s2) = concise_compared_strs(elem_text, opposite_elem_text); let (s1, s2) = concise_compared_strs(elem_text, opposite_elem_text);
println!(" {} Text differs:\n expected: `{}`\n found: `{}`", print_message(&format!(" {} Text differs:\n expected: `{}`\n \
elem.path, s1, s2); found: `{}`",
elem.path, s1, s2),
intro_msg, span, text);
} }
} }
html_diff::Difference::NotPresent { ref elem, ref opposite_elem } => { html_diff::Difference::NotPresent { ref elem, ref opposite_elem } => {
if let Some(ref elem) = *elem { if let Some(ref elem) = *elem {
println!(" {} One element is missing: expected: `{}`", print_message(&format!(" {} One element is missing: expected: `{}`",
elem.path, elem.element_name); elem.path, elem.element_name),
intro_msg, span, text);
} else if let Some(ref elem) = *opposite_elem { } else if let Some(ref elem) = *opposite_elem {
if elem.element_name.is_empty() { if elem.element_name.is_empty() {
println!(" {} Unexpected element: `{}`", print_message(&format!(" {} One element is missing: expected: `{}`",
elem.path, concise_str(&elem.element_content)); elem.path, concise_str(&elem.element_content)),
intro_msg, span, text);
} else { } else {
println!(" {} Unexpected element `{}`: found: `{}`", print_message(&format!(" {} Unexpected element `{}`: found: `{}`",
elem.path, elem.element_name, concise_str(&elem.element_content)); elem.path, elem.element_name,
concise_str(&elem.element_content)),
intro_msg, span, text);
} }
} }
} }