From a9a6952fd0670f6daa7fe6047dac339823c2d827 Mon Sep 17 00:00:00 2001 From: QuietMisdreavus Date: Fri, 13 Jul 2018 17:34:58 -0500 Subject: [PATCH 1/2] don't panic when you see proc-macros --- src/librustdoc/clean/inline.rs | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/librustdoc/clean/inline.rs b/src/librustdoc/clean/inline.rs index fa0e5a88f80e..0117e4fde842 100644 --- a/src/librustdoc/clean/inline.rs +++ b/src/librustdoc/clean/inline.rs @@ -104,7 +104,11 @@ pub fn try_inline(cx: &DocContext, def: Def, name: ast::Name, visited: &mut FxHa // separately Def::Macro(did, MacroKind::Bang) => { record_extern_fqn(cx, did, clean::TypeKind::Macro); - clean::MacroItem(build_macro(cx, did, name)) + if let Some(mac) = build_macro(cx, did, name) { + clean::MacroItem(mac) + } else { + return None; + } } _ => return None, }; @@ -466,12 +470,12 @@ fn build_static(cx: &DocContext, did: DefId, mutable: bool) -> clean::Static { } } -fn build_macro(cx: &DocContext, did: DefId, name: ast::Name) -> clean::Macro { +fn build_macro(cx: &DocContext, did: DefId, name: ast::Name) -> Option { let imported_from = cx.tcx.original_crate_name(did.krate); let def = match cx.cstore.load_macro_untracked(did, cx.sess()) { LoadedMacro::MacroDef(macro_def) => macro_def, // FIXME(jseyfried): document proc macro re-exports - LoadedMacro::ProcMacro(..) => panic!("attempting to document proc-macro re-export"), + LoadedMacro::ProcMacro(..) => return None, }; let matchers: hir::HirVec = if let ast::ItemKind::MacroDef(ref def) = def.node { @@ -487,10 +491,10 @@ fn build_macro(cx: &DocContext, did: DefId, name: ast::Name) -> clean::Macro { format!(" {} => {{ ... }};\n", span.to_src(cx)) }).collect::()); - clean::Macro { + Some(clean::Macro { source, imported_from: Some(imported_from).clean(cx), - } + }) } /// A trait's generics clause actually contains all of the predicates for all of From e78fb9bad0e9137c75147c4469806fe0e61154c2 Mon Sep 17 00:00:00 2001 From: QuietMisdreavus Date: Fri, 13 Jul 2018 21:46:47 -0500 Subject: [PATCH 2/2] add test for issue 52129 --- src/test/rustdoc/doc-proc-macro.rs | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 src/test/rustdoc/doc-proc-macro.rs diff --git a/src/test/rustdoc/doc-proc-macro.rs b/src/test/rustdoc/doc-proc-macro.rs new file mode 100644 index 000000000000..b3b403a7b86a --- /dev/null +++ b/src/test/rustdoc/doc-proc-macro.rs @@ -0,0 +1,18 @@ +// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +// Issue #52129: ICE when trying to document the `quote` proc-macro from proc_macro + +// As of this writing, we don't currently attempt to document proc-macros. However, we shouldn't +// crash when we try. + +extern crate proc_macro; + +pub use proc_macro::*;