Skip to content

Commit 0f2f20d

Browse files
authored
Rollup merge of rust-lang#90489 - jyn514:load-all-extern-crates, r=petrochenkov
rustdoc: Go back to loading all external crates unconditionally This *continues* to cause regressions. This code will be unnecessary once access to the resolver happens fully before creating the tyctxt (rust-lang#83761), so load all crates unconditionally for now. To minimize churn, this leaves in the code for loading crates selectively. "Fixes" rust-lang#84738. Previously: rust-lang#83738, rust-lang#85749, rust-lang#88215 r? `@petrochenkov` cc `@camelid` (this should fix the "index out of bounds" error you had while looking up `crate_name`).
2 parents 9dbbbb1 + 51345a8 commit 0f2f20d

File tree

8 files changed

+93
-7
lines changed

8 files changed

+93
-7
lines changed

src/librustdoc/core.rs

+34-2
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ use rustc_middle::hir::map::Map;
1616
use rustc_middle::middle::privacy::AccessLevels;
1717
use rustc_middle::ty::{ParamEnv, Ty, TyCtxt};
1818
use rustc_resolve as resolve;
19+
use rustc_resolve::Namespace::TypeNS;
1920
use rustc_session::config::{self, CrateType, ErrorOutputType};
2021
use rustc_session::lint;
2122
use rustc_session::DiagnosticOutput;
2223
use rustc_session::Session;
24+
use rustc_span::def_id::CRATE_DEF_INDEX;
2325
use rustc_span::source_map;
2426
use rustc_span::symbol::sym;
25-
use rustc_span::Span;
27+
use rustc_span::{Span, DUMMY_SP};
2628

2729
use std::cell::RefCell;
2830
use std::lazy::SyncLazy;
@@ -283,13 +285,43 @@ crate fn create_config(
283285
}
284286

285287
crate fn create_resolver<'a>(
288+
externs: config::Externs,
286289
queries: &Queries<'a>,
287290
sess: &Session,
288291
) -> Rc<RefCell<interface::BoxedResolver>> {
289292
let (krate, resolver, _) = &*abort_on_err(queries.expansion(), sess).peek();
290293
let resolver = resolver.clone();
291294

292-
crate::passes::collect_intra_doc_links::load_intra_link_crates(resolver, krate)
295+
let resolver = crate::passes::collect_intra_doc_links::load_intra_link_crates(resolver, krate);
296+
297+
// FIXME: somehow rustdoc is still missing crates even though we loaded all
298+
// the known necessary crates. Load them all unconditionally until we find a way to fix this.
299+
// DO NOT REMOVE THIS without first testing on the reproducer in
300+
// https://github.com/jyn514/objr/commit/edcee7b8124abf0e4c63873e8422ff81beb11ebb
301+
let extern_names: Vec<String> = externs
302+
.iter()
303+
.filter(|(_, entry)| entry.add_prelude)
304+
.map(|(name, _)| name)
305+
.cloned()
306+
.collect();
307+
resolver.borrow_mut().access(|resolver| {
308+
sess.time("load_extern_crates", || {
309+
for extern_name in &extern_names {
310+
debug!("loading extern crate {}", extern_name);
311+
if let Err(()) = resolver
312+
.resolve_str_path_error(
313+
DUMMY_SP,
314+
extern_name,
315+
TypeNS,
316+
LocalDefId { local_def_index: CRATE_DEF_INDEX }.to_def_id(),
317+
) {
318+
warn!("unable to resolve external crate {} (do you have an unused `--extern` crate?)", extern_name)
319+
}
320+
}
321+
});
322+
});
323+
324+
resolver
293325
}
294326

295327
crate fn run_global_ctxt(

src/librustdoc/lib.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -756,6 +756,7 @@ fn main_options(options: config::Options) -> MainResult {
756756
let default_passes = options.default_passes;
757757
let output_format = options.output_format;
758758
// FIXME: fix this clone (especially render_options)
759+
let externs = options.externs.clone();
759760
let manual_passes = options.manual_passes.clone();
760761
let render_options = options.render_options.clone();
761762
let scrape_examples_options = options.scrape_examples_options.clone();
@@ -774,7 +775,7 @@ fn main_options(options: config::Options) -> MainResult {
774775
// We need to hold on to the complete resolver, so we cause everything to be
775776
// cloned for the analysis passes to use. Suboptimal, but necessary in the
776777
// current architecture.
777-
let resolver = core::create_resolver(queries, sess);
778+
let resolver = core::create_resolver(externs, queries, sess);
778779

779780
if sess.diagnostic().has_errors_or_lint_errors() {
780781
sess.fatal("Compilation failed, aborting rustdoc");

src/librustdoc/passes/collect_intra_doc_links/early.rs

+27-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
use ast::visit;
12
use rustc_ast as ast;
23
use rustc_hir::def::Namespace::TypeNS;
34
use rustc_hir::def_id::{LocalDefId, CRATE_DEF_ID};
@@ -16,7 +17,7 @@ crate fn load_intra_link_crates(resolver: Resolver, krate: &ast::Crate) -> Resol
1617
let mut loader = IntraLinkCrateLoader { current_mod: CRATE_DEF_ID, resolver };
1718
// `walk_crate` doesn't visit the crate itself for some reason.
1819
loader.load_links_in_attrs(&krate.attrs, krate.span);
19-
ast::visit::walk_crate(&mut loader, krate);
20+
visit::walk_crate(&mut loader, krate);
2021
loader.resolver
2122
}
2223

@@ -54,7 +55,12 @@ impl IntraLinkCrateLoader {
5455
}
5556
}
5657

57-
impl ast::visit::Visitor<'_> for IntraLinkCrateLoader {
58+
impl visit::Visitor<'_> for IntraLinkCrateLoader {
59+
fn visit_foreign_item(&mut self, item: &ast::ForeignItem) {
60+
self.load_links_in_attrs(&item.attrs, item.span);
61+
visit::walk_foreign_item(self, item)
62+
}
63+
5864
fn visit_item(&mut self, item: &ast::Item) {
5965
use rustc_ast_lowering::ResolverAstLowering;
6066

@@ -64,12 +70,29 @@ impl ast::visit::Visitor<'_> for IntraLinkCrateLoader {
6470
let old_mod = mem::replace(&mut self.current_mod, new_mod);
6571

6672
self.load_links_in_attrs(&item.attrs, item.span);
67-
ast::visit::walk_item(self, item);
73+
visit::walk_item(self, item);
6874

6975
self.current_mod = old_mod;
7076
} else {
7177
self.load_links_in_attrs(&item.attrs, item.span);
72-
ast::visit::walk_item(self, item);
78+
visit::walk_item(self, item);
7379
}
7480
}
81+
82+
// NOTE: if doc-comments are ever allowed on function parameters, this will have to implement `visit_param` too.
83+
84+
fn visit_assoc_item(&mut self, item: &ast::AssocItem, ctxt: visit::AssocCtxt) {
85+
self.load_links_in_attrs(&item.attrs, item.span);
86+
visit::walk_assoc_item(self, item, ctxt)
87+
}
88+
89+
fn visit_field_def(&mut self, field: &ast::FieldDef) {
90+
self.load_links_in_attrs(&field.attrs, field.span);
91+
visit::walk_field_def(self, field)
92+
}
93+
94+
fn visit_variant(&mut self, v: &ast::Variant) {
95+
self.load_links_in_attrs(&v.attrs, v.span);
96+
visit::walk_variant(self, v)
97+
}
7598
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// intentionally empty
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// intentionally empty
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// intentionally empty
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// intentionally empty
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// check-pass
2+
// aux-crate:dep1=dep1.rs
3+
// aux-crate:dep2=dep2.rs
4+
// aux-crate:dep3=dep3.rs
5+
// aux-crate:dep4=dep4.rs
6+
#![deny(rustdoc::broken_intra_doc_links)]
7+
8+
pub trait Trait {
9+
/// [dep1]
10+
type Item;
11+
}
12+
13+
pub struct S {
14+
/// [dep2]
15+
pub x: usize,
16+
}
17+
18+
extern "C" {
19+
/// [dep3]
20+
pub fn printf();
21+
}
22+
23+
pub enum E {
24+
/// [dep4]
25+
A
26+
}

0 commit comments

Comments
 (0)