*: Use auto_doc_cfg instead of doc(cfg) attributes (#2983)

Co-authored-by: João Oliveira <[email protected]>
Co-authored-by: Thomas Eizinger <[email protected]>

Cargo.toml

@@ -78,9 +78,6 @@ serde = ["libp2p-core/serde", "libp2p-kad?/serde", "libp2p-gossipsub?/serde"]
 tokio = ["libp2p-mdns?/tokio", "libp2p-tcp?/tokio", "libp2p-dns?/tokio"]
 async-std = ["libp2p-mdns?/async-io", "libp2p-tcp?/async-io", "libp2p-dns?/async-std"]
 
-[package.metadata.docs.rs]
-all-features = true
-
 [dependencies]
 bytes = "1"
 futures = "0.3.1"
@@ -204,3 +201,10 @@ required-features = ["full"]
 [[example]]
 name = "distributed-key-value-store"
 required-features = ["full"]
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

core/Cargo.toml

@@ -64,3 +64,10 @@ serde = ["multihash/serde-codec", "dep:serde"]
 [[bench]]
 name = "peer_id"
 harness = false
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

core/src/lib.rs

@@ -35,6 +35,8 @@
 //!   define how to upgrade each individual substream to use a protocol.
 //!   See the `upgrade` module.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 #[allow(clippy::derive_partial_eq_without_eq)]
 mod keys_proto {
     include!(concat!(env!("OUT_DIR"), "/keys_proto.rs"));

misc/metrics/Cargo.toml

@@ -38,3 +38,10 @@ futures = "0.3.1"
 libp2p = { path = "../..", features = ["full"] }
 hyper = { version="0.14", features = ["server", "tcp", "http1"] }
 tokio = { version = "1", features = ["rt-multi-thread"] }
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

misc/metrics/src/lib.rs

@@ -25,6 +25,8 @@
 //!
 //! See `examples` directory for more.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 #[cfg(feature = "dcutr")]
 mod dcutr;
 #[cfg(feature = "gossipsub")]

misc/multistream-select/Cargo.toml

@@ -25,3 +25,10 @@ libp2p = { path = "../..", features = ["full"] }
 quickcheck = { package = "quickcheck-ext", path = "../../misc/quickcheck-ext" }
 rand = "0.8"
 rw-stream-sink = { version = "0.3.0", path = "../../misc/rw-stream-sink" }
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

misc/multistream-select/src/lib.rs

@@ -87,6 +87,8 @@
 //! ```
 //!
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 mod dialer_select;
 mod length_delimited;
 mod listener_select;

misc/prost-codec/Cargo.toml

@@ -19,3 +19,10 @@ unsigned-varint = { version = "0.7", features = ["asynchronous_codec"] }
 
 [dev-dependencies]
 prost-build = "0.11"
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

misc/prost-codec/src/lib.rs

@@ -1,3 +1,5 @@
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 use asynchronous_codec::{Decoder, Encoder};
 use bytes::BytesMut;
 use prost::Message;

misc/quickcheck-ext/src/lib.rs

@@ -1,3 +1,5 @@
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 pub use quickcheck::*;
 
 use core::ops::Range;

misc/rw-stream-sink/Cargo.toml

@@ -16,3 +16,10 @@ static_assertions = "1"
 
 [dev-dependencies]
 async-std = "1.0"
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

misc/rw-stream-sink/src/lib.rs

@@ -25,6 +25,8 @@
 //! Each call to [`AsyncWrite::poll_write`] will send one packet to the sink.
 //! Calls to [`AsyncRead::poll_read`] will read from the stream's incoming packets.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 use futures::{prelude::*, ready};
 use std::{
     io::{self, Read},

muxers/mplex/Cargo.toml

@@ -34,3 +34,10 @@ quickcheck = { package = "quickcheck-ext", path = "../../misc/quickcheck-ext" }
 [[bench]]
 name = "split_send_size"
 harness = false
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

muxers/mplex/src/lib.rs

@@ -18,6 +18,8 @@
 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 // DEALINGS IN THE SOFTWARE.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 mod codec;
 mod config;
 mod io;

muxers/yamux/Cargo.toml

@@ -21,3 +21,10 @@ log = "0.4"
 [dev-dependencies]
 async-std = { version = "1.7.0", features = ["attributes"] }
 libp2p-muxer-test-harness = { path = "../test-harness" }
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

muxers/yamux/src/lib.rs

@@ -21,6 +21,8 @@
 //! Implements the Yamux multiplexing protocol for libp2p, see also the
 //! [specification](https://github.com/hashicorp/yamux/blob/master/spec.md).
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 use futures::{
     future,
     prelude::*,

protocols/autonat/Cargo.toml

@@ -30,3 +30,10 @@ async-std = { version = "1.10", features = ["attributes"] }
 env_logger = "0.9"
 clap = { version = "4.0.13", features = ["derive"] }
 libp2p = { path = "../..", features = ["full"] }
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/autonat/src/lib.rs

@@ -19,6 +19,9 @@
 // DEALINGS IN THE SOFTWARE.
 
 //! Implementation of the AutoNAT protocol.
+
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 mod behaviour;
 mod protocol;
 

protocols/dcutr/Cargo.toml

@@ -33,3 +33,10 @@ env_logger = "0.9.0"
 libp2p = { path = "../..", features = ["full"] }
 rand = "0.8"
 clap = { version = "4.0.13", features = ["derive"] }
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/dcutr/src/lib.rs

@@ -21,6 +21,8 @@
 //! Implementation of the [libp2p Direct Connection Upgrade through Relay
 //! specification](https://github.com/libp2p/specs/blob/master/relay/DCUtR.md).
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 pub mod behaviour;
 mod handler;
 mod protocol;

protocols/floodsub/Cargo.toml

@@ -23,3 +23,10 @@ smallvec = "1.6.1"
 
 [build-dependencies]
 prost-build = "0.11"
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/floodsub/src/lib.rs

@@ -21,6 +21,8 @@
 //! Implements the floodsub protocol, see also the:
 //! [spec](https://github.com/libp2p/specs/tree/master/pubsub).
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 use libp2p_core::PeerId;
 
 pub mod protocol;

protocols/gossipsub/Cargo.toml

@@ -43,3 +43,10 @@ derive_builder = "0.11.1"
 
 [build-dependencies]
 prost-build = "0.11"
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/gossipsub/src/lib.rs

@@ -133,6 +133,8 @@
 //! println!("Listening on {:?}", addr);
 //! ```
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 pub mod error;
 pub mod protocol;
 

protocols/identify/Cargo.toml

@@ -31,3 +31,10 @@ libp2p = { path = "../..", features = ["full"] }
 
 [build-dependencies]
 prost-build = "0.11"
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/identify/src/lib.rs

@@ -39,6 +39,8 @@
 //! that negotiates and executes the protocol on every established connection, emitting
 //! [`Event`]s.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 pub use self::behaviour::{Behaviour, Config, Event};
 pub use self::protocol::{Info, UpgradeError, PROTOCOL_NAME, PUSH_PROTOCOL_NAME};
 

protocols/kad/Cargo.toml

@@ -43,3 +43,10 @@ prost-build = "0.11"
 
 [features]
 serde = ["dep:serde", "bytes/serde"]
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/kad/src/lib.rs

@@ -38,6 +38,7 @@
 // TODO: we allow dead_code for now because this library contains a lot of unused code that will
 //       be useful later for record store
 #![allow(dead_code)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 pub mod handler;
 pub mod kbucket;

protocols/mdns/Cargo.toml

@@ -45,3 +45,10 @@ required-features = ["async-io"]
 name = "use-tokio"
 required-features = ["tokio"]
 
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/mdns/src/lib.rs

@@ -30,6 +30,9 @@
 //! implements the `NetworkBehaviour` trait. This struct will automatically discover other
 //! libp2p nodes on the local network.
 //!
+
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 use std::net::{Ipv4Addr, Ipv6Addr};
 use std::time::Duration;
 

protocols/ping/Cargo.toml

@@ -24,3 +24,10 @@ void = "1.0"
 async-std = "1.6.2"
 libp2p = { path = "../..", features = ["full"] }
 quickcheck = { package = "quickcheck-ext", path = "../../misc/quickcheck-ext" }
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/ping/src/lib.rs

@@ -40,6 +40,8 @@
 //! [`Swarm`]: libp2p_swarm::Swarm
 //! [`Transport`]: libp2p_core::Transport
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 mod handler;
 mod protocol;
 

protocols/relay/Cargo.toml

@@ -37,3 +37,10 @@ env_logger = "0.9.0"
 libp2p = { path = "../..", features = ["full"] }
 quickcheck = { package = "quickcheck-ext", path = "../../misc/quickcheck-ext" }
 clap = { version = "4.0.13", features = ["derive"] }
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/relay/src/lib.rs

@@ -21,6 +21,8 @@
 
 //! libp2p circuit relay implementations
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 pub mod v2;
 
 // Check that we can safely cast a `usize` to a `u64`.

protocols/rendezvous/Cargo.toml

@@ -35,3 +35,10 @@ tokio = { version = "1.15", features = [ "rt-multi-thread", "time", "macros", "s
 
 [build-dependencies]
 prost-build = "0.11"
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/rendezvous/src/lib.rs

@@ -18,6 +18,8 @@
 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 // DEALINGS IN THE SOFTWARE.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 pub use self::codec::{Cookie, ErrorCode, Namespace, NamespaceTooLong, Registration, Ttl};
 
 mod codec;

protocols/request-response/Cargo.toml

@@ -27,3 +27,10 @@ async-std = "1.6.2"
 env_logger = "0.9.0"
 libp2p = { path = "../..", features = ["full"] }
 rand = "0.8"
+
+# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# More information: https://docs.rs/about/builds#cross-compiling
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+rustc-args = ["--cfg", "docsrs"]

protocols/request-response/src/lib.rs

@@ -56,6 +56,8 @@
 //! advertised during inbound respectively outbound protocol negotiation
 //! on the substreams.
 
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 pub mod codec;
 pub mod handler;