Skip to content

Commit c60a370

Browse files
committed
Fix the bugs and add a regression test
- All attributes for an item need to be considered at once, they can't be considered a line at a time. - The top-level crate was not being visited. This bug was caught by `extern-crate-used-only-in-link`, which I'm very glad I added. - Make the loader private to the module, so that only one function is exposed.
1 parent d933edd commit c60a370

File tree

5 files changed

+38
-22
lines changed

5 files changed

+38
-22
lines changed

src/librustdoc/core.rs

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
use rustc_ast as ast;
21
use rustc_data_structures::fx::{FxHashMap, FxHashSet};
32
use rustc_data_structures::sync::{self, Lrc};
43
use rustc_driver::abort_on_err;
@@ -307,10 +306,7 @@ crate fn create_resolver<'a>(
307306
let (krate, resolver, _) = &*abort_on_err(queries.expansion(), sess).peek();
308307
let resolver = resolver.clone();
309308

310-
let mut loader = crate::passes::collect_intra_doc_links::IntraLinkCrateLoader::new(resolver);
311-
ast::visit::walk_crate(&mut loader, krate);
312-
313-
loader.resolver
309+
crate::passes::collect_intra_doc_links::load_intra_link_crates(resolver, krate)
314310
}
315311

316312
crate fn run_global_ctxt(

src/librustdoc/passes/collect_intra_doc_links.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ use crate::lint::{BROKEN_INTRA_DOC_LINKS, PRIVATE_INTRA_DOC_LINKS};
3838
use crate::passes::Pass;
3939

4040
mod early;
41-
crate use early::IntraLinkCrateLoader;
41+
crate use early::load_intra_link_crates;
4242

4343
crate const COLLECT_INTRA_DOC_LINKS: Pass = Pass {
4444
name: "collect-intra-doc-links",

src/librustdoc/passes/collect_intra_doc_links/early.rs

+28-16
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,74 @@
11
use rustc_ast as ast;
22
use rustc_hir::def::Namespace::TypeNS;
3-
use rustc_hir::def_id::{DefId, LocalDefId, CRATE_DEF_INDEX};
3+
use rustc_hir::def_id::{LocalDefId, CRATE_DEF_ID};
44
use rustc_interface::interface;
5+
use rustc_span::Span;
56

67
use std::cell::RefCell;
78
use std::mem;
89
use std::rc::Rc;
910

11+
type Resolver = Rc<RefCell<interface::BoxedResolver>>;
1012
// Letting the resolver escape at the end of the function leads to inconsistencies between the
1113
// crates the TyCtxt sees and the resolver sees (because the resolver could load more crates
1214
// after escaping). Hopefully `IntraLinkCrateLoader` gets all the crates we need ...
13-
crate struct IntraLinkCrateLoader {
14-
current_mod: DefId,
15-
crate resolver: Rc<RefCell<interface::BoxedResolver>>,
15+
crate fn load_intra_link_crates(resolver: Resolver, krate: &ast::Crate) -> Resolver {
16+
let mut loader = IntraLinkCrateLoader { current_mod: CRATE_DEF_ID, resolver };
17+
// `walk_crate` doesn't visit the crate itself for some reason.
18+
loader.load_links_in_attrs(&krate.attrs, krate.span);
19+
ast::visit::walk_crate(&mut loader, krate);
20+
loader.resolver
1621
}
1722

18-
impl IntraLinkCrateLoader {
19-
crate fn new(resolver: Rc<RefCell<interface::BoxedResolver>>) -> Self {
20-
let crate_id = LocalDefId { local_def_index: CRATE_DEF_INDEX }.to_def_id();
21-
Self { current_mod: crate_id, resolver }
22-
}
23+
struct IntraLinkCrateLoader {
24+
current_mod: LocalDefId,
25+
resolver: Rc<RefCell<interface::BoxedResolver>>,
2326
}
2427

25-
impl ast::visit::Visitor<'_> for IntraLinkCrateLoader {
26-
fn visit_attribute(&mut self, attr: &ast::Attribute) {
28+
impl IntraLinkCrateLoader {
29+
fn load_links_in_attrs(&mut self, attrs: &[ast::Attribute], span: Span) {
2730
use crate::html::markdown::markdown_links;
2831
use crate::passes::collect_intra_doc_links::preprocess_link;
2932

30-
if let Some(doc) = attr.doc_str() {
33+
// FIXME: this probably needs to consider inlining
34+
let attrs = crate::clean::Attributes::from_ast(attrs, None);
35+
for (parent_module, doc) in attrs.collapsed_doc_value_by_module_level() {
36+
debug!(?doc);
3137
for link in markdown_links(&doc.as_str()) {
38+
debug!(?link.link);
3239
let path_str = if let Some(Ok(x)) = preprocess_link(&link) {
3340
x.path_str
3441
} else {
3542
continue;
3643
};
3744
self.resolver.borrow_mut().access(|resolver| {
3845
let _ = resolver.resolve_str_path_error(
39-
attr.span,
46+
span,
4047
&path_str,
4148
TypeNS,
42-
self.current_mod,
49+
parent_module.unwrap_or(self.current_mod.to_def_id()),
4350
);
4451
});
4552
}
4653
}
47-
ast::visit::walk_attribute(self, attr);
4854
}
55+
}
4956

57+
impl ast::visit::Visitor<'_> for IntraLinkCrateLoader {
5058
fn visit_item(&mut self, item: &ast::Item) {
5159
use rustc_ast_lowering::ResolverAstLowering;
5260

5361
if let ast::ItemKind::Mod(..) = item.kind {
5462
let new_mod =
5563
self.resolver.borrow_mut().access(|resolver| resolver.local_def_id(item.id));
56-
let old_mod = mem::replace(&mut self.current_mod, new_mod.to_def_id());
64+
let old_mod = mem::replace(&mut self.current_mod, new_mod);
65+
66+
self.load_links_in_attrs(&item.attrs, item.span);
5767
ast::visit::walk_item(self, item);
68+
5869
self.current_mod = old_mod;
5970
} else {
71+
self.load_links_in_attrs(&item.attrs, item.span);
6072
ast::visit::walk_item(self, item);
6173
}
6274
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pub struct SomeStruct;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// compile-flags: --extern pub_struct
2+
// aux-build:pub-struct.rs
3+
4+
/// [SomeStruct]
5+
///
6+
/// [SomeStruct]: pub_struct::SomeStruct
7+
pub fn foo() {}

0 commit comments

Comments
 (0)