diff --git a/.cargo/config.toml b/.cargo/config.toml index 6d9e7e56..f126caa6 100644 --- a/.cargo/config.toml +++ b/.cargo/config.toml @@ -49,6 +49,9 @@ rustflags = [ # Code styles we want to accept "-Aclippy::try_err", + # Links in public docs can point to private items. + "-Arustdoc::private_intra_doc_links" + # TODOs: # `cargo fix` might help do these fixes, # or add a config.toml to sub-directories which should allow these lints, diff --git a/zebra-chain/src/lib.rs b/zebra-chain/src/lib.rs index b529a5b4..755cd48c 100644 --- a/zebra-chain/src/lib.rs +++ b/zebra-chain/src/lib.rs @@ -6,7 +6,6 @@ #![doc(html_favicon_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-favicon-128.png")] #![doc(html_logo_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-icon.png")] #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_chain")] -#![allow(rustdoc::private_intra_doc_links)] // Required by bitvec! macro #![recursion_limit = "256"] diff --git a/zebra-consensus/src/lib.rs b/zebra-consensus/src/lib.rs index 43f1cbc7..392971e1 100644 --- a/zebra-consensus/src/lib.rs +++ b/zebra-consensus/src/lib.rs @@ -33,7 +33,6 @@ #![doc(html_favicon_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-favicon-128.png")] #![doc(html_logo_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-icon.png")] #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_consensus")] -#![allow(rustdoc::private_intra_doc_links)] mod block; mod checkpoint; diff --git a/zebra-network/src/lib.rs b/zebra-network/src/lib.rs index 172fe7f8..a8309fa4 100644 --- a/zebra-network/src/lib.rs +++ b/zebra-network/src/lib.rs @@ -124,7 +124,6 @@ #![doc(html_favicon_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-favicon-128.png")] #![doc(html_logo_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-icon.png")] #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_network")] -#![allow(rustdoc::private_intra_doc_links)] #[macro_use] extern crate pin_project; diff --git a/zebra-state/src/lib.rs b/zebra-state/src/lib.rs index 089c44c4..3e8601bd 100644 --- a/zebra-state/src/lib.rs +++ b/zebra-state/src/lib.rs @@ -11,7 +11,6 @@ #![doc(html_favicon_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-favicon-128.png")] #![doc(html_logo_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-icon.png")] #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_state")] -#![allow(rustdoc::private_intra_doc_links)] #[macro_use] extern crate tracing; diff --git a/zebra-test/src/lib.rs b/zebra-test/src/lib.rs index a9476529..9cd2aa07 100644 --- a/zebra-test/src/lib.rs +++ b/zebra-test/src/lib.rs @@ -2,7 +2,6 @@ #![doc(html_favicon_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-favicon-128.png")] #![doc(html_logo_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-icon.png")] #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebra_test")] -#![allow(rustdoc::private_intra_doc_links)] // Each lazy_static variable uses additional recursion #![recursion_limit = "512"] use color_eyre::section::PanicMessage; diff --git a/zebrad/src/lib.rs b/zebrad/src/lib.rs index 5711c50c..b6976125 100644 --- a/zebrad/src/lib.rs +++ b/zebrad/src/lib.rs @@ -17,7 +17,6 @@ #![doc(html_favicon_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-favicon-128.png")] #![doc(html_logo_url = "https://zfnd.org/wp-content/uploads/2022/03/zebra-icon.png")] #![doc(html_root_url = "https://doc.zebra.zfnd.org/zebrad")] -#![allow(rustdoc::private_intra_doc_links)] // Tracing causes false positives on this lint: // https://github.com/tokio-rs/tracing/issues/553 #![allow(clippy::cognitive_complexity)]