Rollup merge of #48596 - GuillaumeGomez:invalid-code-block-start, r=QuietMisdreavus

Add warning for invalid start of code blocks in rustdoc

Follow up of #48382.

Still two things to consider:
 1. Adding test for rustdoc output (but where? In UI or in rustdoc tests?).
 2. Try to fix the span issue.

r? @QuietMisdreavus
This commit is contained in:
kennytm 2018-03-22 17:51:15 +08:00 committed by GitHub
commit a848336a31
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 4 deletions

View file

@ -27,6 +27,7 @@
#![allow(non_camel_case_types)]
use rustc::session;
use std::cell::RefCell;
use std::collections::{HashMap, VecDeque};
use std::default::Default;
@ -434,7 +435,8 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for Footnotes<'a, I> {
}
}
pub fn find_testable_code(doc: &str, tests: &mut ::test::Collector, position: Span) {
pub fn find_testable_code(doc: &str, tests: &mut ::test::Collector, position: Span,
sess: Option<&session::Session>) {
tests.set_position(position);
let mut parser = Parser::new(doc);
@ -484,6 +486,9 @@ pub fn find_testable_code(doc: &str, tests: &mut ::test::Collector, position: Sp
line, filename, block_info.allow_fail);
prev_offset = offset;
} else {
if let Some(ref sess) = sess {
sess.span_warn(position, "invalid start of a new code block");
}
break;
}
}

View file

@ -152,7 +152,7 @@ pub fn test(input: &str, cfgs: Vec<String>, libs: SearchPaths, externs: Externs,
true, opts, maybe_sysroot, None,
Some(PathBuf::from(input)),
linker);
find_testable_code(&input_str, &mut collector, DUMMY_SP);
find_testable_code(&input_str, &mut collector, DUMMY_SP, None);
test_args.insert(0, "rustdoctest".to_string());
testing::test_main(&test_args, collector.tests,
testing::Options::new().display_output(display_warnings));

View file

@ -645,8 +645,10 @@ impl<'a, 'hir> HirCollector<'a, 'hir> {
// the collapse-docs pass won't combine sugared/raw doc attributes, or included files with
// anything else, this will combine them for us
if let Some(doc) = attrs.collapsed_doc_value() {
markdown::find_testable_code(&doc, self.collector,
attrs.span.unwrap_or(DUMMY_SP));
markdown::find_testable_code(&doc,
self.collector,
attrs.span.unwrap_or(DUMMY_SP),
Some(self.sess));
}
nested(self);