From bf2c3b0455ba0e7d747f271383ee8ceabd9b6392 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Mon, 4 Apr 2022 15:17:55 +0200 Subject: [PATCH 1/2] Fix ICE in rustdoc intra doc links when trying to get traits in scope for a private module --- src/librustdoc/lib.rs | 8 +++++++- src/librustdoc/passes/collect_intra_doc_links/early.rs | 5 ++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs index f59222b780d3..1d7a790bdb78 100644 --- a/src/librustdoc/lib.rs +++ b/src/librustdoc/lib.rs @@ -771,6 +771,7 @@ fn main_options(options: config::Options) -> MainResult { let externs = options.externs.clone(); let render_options = options.render_options.clone(); let scrape_examples_options = options.scrape_examples_options.clone(); + let document_private = options.render_options.document_private; let config = core::create_config(options); interface::create_compiler_and_run(config, |compiler| { @@ -791,7 +792,12 @@ fn main_options(options: config::Options) -> MainResult { let (resolver, resolver_caches) = { let (krate, resolver, _) = &*abort_on_err(queries.expansion(), sess).peek(); let resolver_caches = resolver.borrow_mut().access(|resolver| { - collect_intra_doc_links::early_resolve_intra_doc_links(resolver, krate, externs) + collect_intra_doc_links::early_resolve_intra_doc_links( + resolver, + krate, + externs, + document_private, + ) }); (resolver.clone(), resolver_caches) }; diff --git a/src/librustdoc/passes/collect_intra_doc_links/early.rs b/src/librustdoc/passes/collect_intra_doc_links/early.rs index 75e952c5122b..d712ec8aa6ab 100644 --- a/src/librustdoc/passes/collect_intra_doc_links/early.rs +++ b/src/librustdoc/passes/collect_intra_doc_links/early.rs @@ -22,6 +22,7 @@ crate fn early_resolve_intra_doc_links( resolver: &mut Resolver<'_>, krate: &ast::Crate, externs: Externs, + document_private_items: bool, ) -> ResolverCaches { let mut loader = IntraLinkCrateLoader { resolver, @@ -30,6 +31,7 @@ crate fn early_resolve_intra_doc_links( traits_in_scope: Default::default(), all_traits: Default::default(), all_trait_impls: Default::default(), + document_private_items, }; // Because of the `crate::` prefix, any doc comment can reference @@ -66,6 +68,7 @@ struct IntraLinkCrateLoader<'r, 'ra> { traits_in_scope: DefIdMap>, all_traits: Vec, all_trait_impls: Vec, + document_private_items: bool, } impl IntraLinkCrateLoader<'_, '_> { @@ -175,7 +178,7 @@ impl IntraLinkCrateLoader<'_, '_> { } for child in self.resolver.module_children_or_reexports(module_id) { - if child.vis == Visibility::Public { + if child.vis == Visibility::Public || self.document_private_items { if let Some(def_id) = child.res.opt_def_id() { self.add_traits_in_parent_scope(def_id); } From 50cc0fa8abd0279608ce3434a5a3fe34dee62a70 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Mon, 4 Apr 2022 15:18:28 +0200 Subject: [PATCH 2/2] Add test to ensure rustdoc does not panic on intra doc link pass --- src/test/rustdoc/issue-95633.rs | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 src/test/rustdoc/issue-95633.rs diff --git a/src/test/rustdoc/issue-95633.rs b/src/test/rustdoc/issue-95633.rs new file mode 100644 index 000000000000..a71d0a037318 --- /dev/null +++ b/src/test/rustdoc/issue-95633.rs @@ -0,0 +1,7 @@ +// compile-flags: --document-private-items + +// This ensures that no ICE is triggered when rustdoc is run on this code. + +mod stdlib { + pub (crate) use std::i8; +}