Skip to content

Commit

Permalink
rustdoc: Deliberately load extern crates before processing docs
Browse files Browse the repository at this point in the history
In order that we can successfully later resolve paths in crates
which weren't loaded as a result of merely parsing the crate
we're documenting, we force the resolution of the path to each
crate before cloning the resolver to use later.  Closes #66159

Signed-off-by: Daniel Silverstone <[email protected]>
  • Loading branch information
kinnison committed Nov 8, 2019
1 parent 2c33568 commit 33ded3e
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
25 changes: 24 additions & 1 deletion src/librustdoc/core.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use rustc_lint;
use rustc::session::{self, config};
use rustc::hir::def::Namespace::TypeNS;
use rustc::hir::def_id::{DefId, DefIndex, CrateNum, LOCAL_CRATE};
use rustc::hir::HirId;
use rustc::middle::cstore::CrateStore;
Expand All @@ -13,11 +14,13 @@ use rustc_interface::interface;
use rustc_driver::abort_on_err;
use rustc_resolve as resolve;

use syntax::ast::CRATE_NODE_ID;
use syntax::source_map;
use syntax::attr;
use syntax::feature_gate::UnstableFeatures;
use syntax::json::JsonEmitter;
use syntax::symbol::sym;
use syntax_pos::DUMMY_SP;
use errors;
use errors::emitter::{Emitter, EmitterWriter};

Expand Down Expand Up @@ -246,6 +249,8 @@ pub fn run_core(options: RustdocOptions) -> (clean::Crate, RenderInfo, RenderOpt
..
} = options;

let extern_names: Vec<String> = externs.iter().map(|(s,_)| s).cloned().collect();

// Add the rustdoc cfg into the doc build.
cfgs.push("rustdoc".to_string());

Expand Down Expand Up @@ -343,7 +348,25 @@ pub fn run_core(options: RustdocOptions) -> (clean::Crate, RenderInfo, RenderOpt
// We need to hold on to the complete resolver, so we cause everything to be
// cloned for the analysis passes to use. Suboptimal, but necessary in the
// current architecture.
let resolver = abort_on_err(compiler.expansion(), sess).peek().1.borrow().clone();
let resolver = {
let parts = abort_on_err(compiler.expansion(), sess).peek();
let resolver = parts.1.borrow();

// Before we actually clone it, let's force all the extern'd crates to
// actually be loaded, just in case they're only referred to inside
// intra-doc-links
resolver.borrow_mut().access(|resolver| {
for extern_name in &extern_names {
resolver.resolve_str_path_error(DUMMY_SP, extern_name, TypeNS, CRATE_NODE_ID)
.unwrap_or_else(
|()| panic!("Unable to resolve external crate {}", extern_name)
);
}
});

// Now we're good to clone the resolver because everything should be loaded
resolver.clone()
};

if sess.has_errors() {
sess.fatal("Compilation failed, aborting rustdoc");
Expand Down
2 changes: 2 additions & 0 deletions src/test/rustdoc/auxiliary/issue-66159-1.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/// This will be referred to by the test docstring
pub struct Something;
10 changes: 10 additions & 0 deletions src/test/rustdoc/issue-66159.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// aux-build:issue-66159-1.rs
// extern-private:issue_66159_1

// The issue was an ICE which meant that we never actually generated the docs
// so if we have generated the docs, we're okay.
// Since we don't generate the docs for the auxilliary files, we can't actually
// verify that the struct is linked correctly.

// @has issue_66159/index.html
//! [issue_66159_1::Something]

0 comments on commit 33ded3e

Please sign in to comment.