From 9d9c0579f8a22cda301cc7a77b60ae7e7a392777 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Sat, 27 Mar 2021 08:27:17 +1300 Subject: [PATCH] Use new name for broken_intra_doc_links lint We also add the lint to crates in the workspace that didn't have it. Closes zcash/librustzcash#279. --- components/equihash/src/lib.rs | 3 +++ zcash_client_backend/src/lib.rs | 2 +- zcash_client_sqlite/src/lib.rs | 3 +++ zcash_extensions/src/lib.rs | 3 +++ zcash_history/src/lib.rs | 3 +++ zcash_primitives/src/lib.rs | 2 +- zcash_proofs/src/lib.rs | 2 +- 7 files changed, 15 insertions(+), 3 deletions(-) diff --git a/components/equihash/src/lib.rs b/components/equihash/src/lib.rs index 59c287305..aa275c61c 100644 --- a/components/equihash/src/lib.rs +++ b/components/equihash/src/lib.rs @@ -17,6 +17,9 @@ //! [Section 7.6.1: Equihash.]: https://zips.z.cash/protocol/protocol.pdf#equihash //! [BK16]: https://www.internetsociety.org/sites/default/files/blogs-media/equihash-asymmetric-proof-of-work-based-generalized-birthday-problem.pdf +// Catch documentation errors caused by code changes. +#![deny(broken_intra_doc_links)] + mod verify; #[cfg(test)] diff --git a/zcash_client_backend/src/lib.rs b/zcash_client_backend/src/lib.rs index fc26166f5..9d72cb471 100644 --- a/zcash_client_backend/src/lib.rs +++ b/zcash_client_backend/src/lib.rs @@ -4,7 +4,7 @@ //! light clients. // Catch documentation errors caused by code changes. -#![deny(intra_doc_link_resolution_failure)] +#![deny(broken_intra_doc_links)] pub mod address; pub mod data_api; diff --git a/zcash_client_sqlite/src/lib.rs b/zcash_client_sqlite/src/lib.rs index 2b62ed93f..890fbf67c 100644 --- a/zcash_client_sqlite/src/lib.rs +++ b/zcash_client_sqlite/src/lib.rs @@ -29,6 +29,9 @@ //! [`CompactBlock`]: zcash_client_backend::proto::compact_formats::CompactBlock //! [`init_cache_database`]: crate::chain::init::init_cache_database +// Catch documentation errors caused by code changes. +#![deny(broken_intra_doc_links)] + use std::collections::HashMap; use std::fmt; use std::path::Path; diff --git a/zcash_extensions/src/lib.rs b/zcash_extensions/src/lib.rs index 3b6ce6424..70788b6e9 100644 --- a/zcash_extensions/src/lib.rs +++ b/zcash_extensions/src/lib.rs @@ -1,2 +1,5 @@ +// Catch documentation errors caused by code changes. +#![deny(broken_intra_doc_links)] + pub mod consensus; pub mod transparent; diff --git a/zcash_history/src/lib.rs b/zcash_history/src/lib.rs index 9bc487b5f..5732ff640 100644 --- a/zcash_history/src/lib.rs +++ b/zcash_history/src/lib.rs @@ -1,6 +1,9 @@ //! Chain history library for Zcash //! //! To be used in zebra and via FFI bindings in zcashd + +// Catch documentation errors caused by code changes. +#![deny(broken_intra_doc_links)] #![warn(missing_docs)] mod entry; diff --git a/zcash_primitives/src/lib.rs b/zcash_primitives/src/lib.rs index f8695fe42..d39c6d828 100644 --- a/zcash_primitives/src/lib.rs +++ b/zcash_primitives/src/lib.rs @@ -5,7 +5,7 @@ #![cfg_attr(docsrs, feature(doc_cfg))] // Catch documentation errors caused by code changes. -#![deny(intra_doc_link_resolution_failure)] +#![deny(broken_intra_doc_links)] pub mod block; pub mod consensus; diff --git a/zcash_proofs/src/lib.rs b/zcash_proofs/src/lib.rs index 733f9c3ff..4decc0d3b 100644 --- a/zcash_proofs/src/lib.rs +++ b/zcash_proofs/src/lib.rs @@ -5,7 +5,7 @@ #![cfg_attr(docsrs, feature(doc_cfg))] // Catch documentation errors caused by code changes. -#![deny(intra_doc_link_resolution_failure)] +#![deny(broken_intra_doc_links)] use bellman::groth16::{prepare_verifying_key, Parameters, PreparedVerifyingKey, VerifyingKey}; use bls12_381::Bls12;