From e0c8a7f477525f4c70c4ee0b06ddd478d021360e Mon Sep 17 00:00:00 2001 From: Alex Crichton Date: Wed, 2 Nov 2022 11:59:01 -0500 Subject: [PATCH] Don't fail documentation without the default feature (#5180) This commit fixes `cargo doc -p wasmtime --no-default-features` where previously it would fail with many broken doc links because the crate is missing many items that links refer to. Instead they're emitted as warnings now which while noisy should prevent the build from being entirely usable at least. --- crates/wasmtime/src/lib.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/crates/wasmtime/src/lib.rs b/crates/wasmtime/src/lib.rs index 2ec92d1445e7..1f0d0a9e01ad 100644 --- a/crates/wasmtime/src/lib.rs +++ b/crates/wasmtime/src/lib.rs @@ -379,12 +379,16 @@ //! # } //! ``` -#![allow(unknown_lints)] -#![deny(missing_docs, rustdoc::broken_intra_doc_links)] +#![deny(missing_docs)] #![doc(test(attr(deny(warnings))))] #![doc(test(attr(allow(dead_code, unused_variables, unused_mut))))] #![cfg_attr(nightlydoc, feature(doc_cfg))] #![cfg_attr(not(feature = "default"), allow(dead_code, unused_imports))] +// Allow broken links when the default features is disabled because most of our +// documentation is written for the "one build" of the `main` branch which has +// most features enabled. This will present warnings in stripped-down doc builds +// and will prevent the doc build from failing. +#![cfg_attr(feature = "default", deny(rustdoc::broken_intra_doc_links))] #[macro_use] mod func;