From 823acd6f6991b1b6b0f6d09959d89599d6abc730 Mon Sep 17 00:00:00 2001
From: Hannes <55623006+umgefahren@users.noreply.github.com>
Date: Tue, 6 Aug 2024 17:14:49 +0200
Subject: [PATCH] docs: As implied by #5517 make sure everything still builds
 on docs.rs

As @guillaumemichel already found out, passing the `docsrs` cfg to rustc now breaks the documentation build. Although I couldn't exactly reproduce the docs.rs build env (everyone is welcome to try; it's explained [here](https://github.com/rust-lang/docs.rs/blob/master/README.md#build-subcommand)) it's safe to assume that the same problem will occur when we push to docs.rs.

Passing the docsrs flag is also no longer required since it's now automatically passed to rustdoc when building on docs.rs. Explanation: https://docs.rs/about/builds#detecting-docsrs

Pull-Request: #5535.
---
 core/Cargo.toml                           | 2 --
 identity/Cargo.toml                       | 2 --
 libp2p/Cargo.toml                         | 2 --
 misc/metrics/Cargo.toml                   | 2 --
 misc/multistream-select/Cargo.toml        | 2 --
 misc/quick-protobuf-codec/Cargo.toml      | 2 --
 misc/rw-stream-sink/Cargo.toml            | 2 --
 muxers/mplex/Cargo.toml                   | 2 --
 muxers/yamux/Cargo.toml                   | 2 --
 protocols/autonat/Cargo.toml              | 2 --
 protocols/dcutr/Cargo.toml                | 2 --
 protocols/floodsub/Cargo.toml             | 2 --
 protocols/gossipsub/Cargo.toml            | 2 --
 protocols/identify/Cargo.toml             | 2 --
 protocols/kad/Cargo.toml                  | 2 --
 protocols/mdns/Cargo.toml                 | 2 --
 protocols/perf/Cargo.toml                 | 2 --
 protocols/ping/Cargo.toml                 | 2 --
 protocols/relay/Cargo.toml                | 2 --
 protocols/rendezvous/Cargo.toml           | 2 --
 protocols/request-response/Cargo.toml     | 2 --
 protocols/upnp/Cargo.toml                 | 2 --
 swarm-derive/Cargo.toml                   | 2 --
 swarm/Cargo.toml                          | 2 --
 transports/dns/Cargo.toml                 | 2 --
 transports/noise/Cargo.toml               | 2 --
 transports/plaintext/Cargo.toml           | 2 --
 transports/pnet/Cargo.toml                | 2 --
 transports/quic/Cargo.toml                | 2 --
 transports/tcp/Cargo.toml                 | 2 --
 transports/tls/Cargo.toml                 | 2 --
 transports/uds/Cargo.toml                 | 2 --
 transports/webrtc/Cargo.toml              | 2 --
 transports/websocket-websys/Cargo.toml    | 2 --
 transports/websocket/Cargo.toml           | 2 --
 transports/webtransport-websys/Cargo.toml | 2 --
 36 files changed, 72 deletions(-)

diff --git a/core/Cargo.toml b/core/Cargo.toml
index 3f9bd540f23..8a083276e7f 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -48,8 +48,6 @@ serde = ["multihash/serde-codec", "dep:serde", "libp2p-identity/serde"]
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/identity/Cargo.toml b/identity/Cargo.toml
index ea49a1adbb4..cb0b8cb000e 100644
--- a/identity/Cargo.toml
+++ b/identity/Cargo.toml
@@ -56,8 +56,6 @@ harness = false
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/libp2p/Cargo.toml b/libp2p/Cargo.toml
index 59a075b777e..68a76e52b58 100644
--- a/libp2p/Cargo.toml
+++ b/libp2p/Cargo.toml
@@ -150,8 +150,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/misc/metrics/Cargo.toml b/misc/metrics/Cargo.toml
index 5fb927bee84..b75ea5ed0de 100644
--- a/misc/metrics/Cargo.toml
+++ b/misc/metrics/Cargo.toml
@@ -40,8 +40,6 @@ libp2p-identity = { workspace = true, features = ["rand"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustc-args = ["--cfg", "docsrs"]
-rustdoc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/misc/multistream-select/Cargo.toml b/misc/multistream-select/Cargo.toml
index 77d8de54332..1bbe3642477 100644
--- a/misc/multistream-select/Cargo.toml
+++ b/misc/multistream-select/Cargo.toml
@@ -30,8 +30,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/misc/quick-protobuf-codec/Cargo.toml b/misc/quick-protobuf-codec/Cargo.toml
index a98ffa5308f..985479059a2 100644
--- a/misc/quick-protobuf-codec/Cargo.toml
+++ b/misc/quick-protobuf-codec/Cargo.toml
@@ -30,8 +30,6 @@ harness = false
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/misc/rw-stream-sink/Cargo.toml b/misc/rw-stream-sink/Cargo.toml
index 557163c438a..20fa2fa23fa 100644
--- a/misc/rw-stream-sink/Cargo.toml
+++ b/misc/rw-stream-sink/Cargo.toml
@@ -22,8 +22,6 @@ async-std = "1.0"
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/muxers/mplex/Cargo.toml b/muxers/mplex/Cargo.toml
index fb55e03b614..4fdb4dabedd 100644
--- a/muxers/mplex/Cargo.toml
+++ b/muxers/mplex/Cargo.toml
@@ -42,8 +42,6 @@ harness = false
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/muxers/yamux/Cargo.toml b/muxers/yamux/Cargo.toml
index f56cd485b9b..289f84fe1dd 100644
--- a/muxers/yamux/Cargo.toml
+++ b/muxers/yamux/Cargo.toml
@@ -27,8 +27,6 @@ libp2p-muxer-test-harness = { path = "../test-harness" }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/autonat/Cargo.toml b/protocols/autonat/Cargo.toml
index f047cb7d5ba..7e31a7f3895 100644
--- a/protocols/autonat/Cargo.toml
+++ b/protocols/autonat/Cargo.toml
@@ -34,8 +34,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/dcutr/Cargo.toml b/protocols/dcutr/Cargo.toml
index cd46840caf3..6b1d04f82f5 100644
--- a/protocols/dcutr/Cargo.toml
+++ b/protocols/dcutr/Cargo.toml
@@ -47,8 +47,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/floodsub/Cargo.toml b/protocols/floodsub/Cargo.toml
index 9f0557c6d01..18d77e99e9c 100644
--- a/protocols/floodsub/Cargo.toml
+++ b/protocols/floodsub/Cargo.toml
@@ -30,8 +30,6 @@ tracing = { workspace = true }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/gossipsub/Cargo.toml b/protocols/gossipsub/Cargo.toml
index f989e997bfb..4cb590bed0c 100644
--- a/protocols/gossipsub/Cargo.toml
+++ b/protocols/gossipsub/Cargo.toml
@@ -55,8 +55,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/identify/Cargo.toml b/protocols/identify/Cargo.toml
index 320c8465650..cdc5ce587de 100644
--- a/protocols/identify/Cargo.toml
+++ b/protocols/identify/Cargo.toml
@@ -37,8 +37,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/kad/Cargo.toml b/protocols/kad/Cargo.toml
index 494d812c6ec..72b29d00ef7 100644
--- a/protocols/kad/Cargo.toml
+++ b/protocols/kad/Cargo.toml
@@ -52,8 +52,6 @@ serde = ["dep:serde", "bytes/serde"]
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/mdns/Cargo.toml b/protocols/mdns/Cargo.toml
index 0c8229465d6..19ae5ce9f36 100644
--- a/protocols/mdns/Cargo.toml
+++ b/protocols/mdns/Cargo.toml
@@ -54,8 +54,6 @@ required-features = ["tokio"]
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/perf/Cargo.toml b/protocols/perf/Cargo.toml
index abe58088caa..398bdce65ec 100644
--- a/protocols/perf/Cargo.toml
+++ b/protocols/perf/Cargo.toml
@@ -42,8 +42,6 @@ libp2p-swarm-test = { path = "../../swarm-test" }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/ping/Cargo.toml b/protocols/ping/Cargo.toml
index 2c347adb2c4..66775d3ba8d 100644
--- a/protocols/ping/Cargo.toml
+++ b/protocols/ping/Cargo.toml
@@ -33,8 +33,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/relay/Cargo.toml b/protocols/relay/Cargo.toml
index 1a0e7836158..084fec07efd 100644
--- a/protocols/relay/Cargo.toml
+++ b/protocols/relay/Cargo.toml
@@ -44,8 +44,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/rendezvous/Cargo.toml b/protocols/rendezvous/Cargo.toml
index 32b233813e3..78a6a1a0a4c 100644
--- a/protocols/rendezvous/Cargo.toml
+++ b/protocols/rendezvous/Cargo.toml
@@ -44,8 +44,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/request-response/Cargo.toml b/protocols/request-response/Cargo.toml
index af70fd9a83e..c6b2eda348b 100644
--- a/protocols/request-response/Cargo.toml
+++ b/protocols/request-response/Cargo.toml
@@ -47,8 +47,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/protocols/upnp/Cargo.toml b/protocols/upnp/Cargo.toml
index 50ed9db0f6f..e9c7414236d 100644
--- a/protocols/upnp/Cargo.toml
+++ b/protocols/upnp/Cargo.toml
@@ -30,5 +30,3 @@ workspace = true
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
diff --git a/swarm-derive/Cargo.toml b/swarm-derive/Cargo.toml
index d4b596a12cf..b31ea188962 100644
--- a/swarm-derive/Cargo.toml
+++ b/swarm-derive/Cargo.toml
@@ -23,8 +23,6 @@ proc-macro2 = "1.0"
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/swarm/Cargo.toml b/swarm/Cargo.toml
index 1e2842998a3..375f51490a8 100644
--- a/swarm/Cargo.toml
+++ b/swarm/Cargo.toml
@@ -67,8 +67,6 @@ required-features = ["macros"]
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [[bench]]
 name = "connection_handler"
diff --git a/transports/dns/Cargo.toml b/transports/dns/Cargo.toml
index b728509364a..707b67fc935 100644
--- a/transports/dns/Cargo.toml
+++ b/transports/dns/Cargo.toml
@@ -35,8 +35,6 @@ tokio = ["hickory-resolver/tokio-runtime"]
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/transports/noise/Cargo.toml b/transports/noise/Cargo.toml
index 7333d4cddda..76cf9475cc4 100644
--- a/transports/noise/Cargo.toml
+++ b/transports/noise/Cargo.toml
@@ -43,8 +43,6 @@ libp2p-identity = { workspace = true, features = ["rand"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/transports/plaintext/Cargo.toml b/transports/plaintext/Cargo.toml
index db6fe75b505..4f07c5fee6e 100644
--- a/transports/plaintext/Cargo.toml
+++ b/transports/plaintext/Cargo.toml
@@ -31,8 +31,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/transports/pnet/Cargo.toml b/transports/pnet/Cargo.toml
index 76964ce3152..e7b3bfc30ac 100644
--- a/transports/pnet/Cargo.toml
+++ b/transports/pnet/Cargo.toml
@@ -33,8 +33,6 @@ tokio = { workspace = true, features = ["full"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/transports/quic/Cargo.toml b/transports/quic/Cargo.toml
index d2d8c6fc2b0..1f540c9542a 100644
--- a/transports/quic/Cargo.toml
+++ b/transports/quic/Cargo.toml
@@ -35,8 +35,6 @@ async-std = ["dep:async-std", "if-watch/smol", "quinn/runtime-async-std"]
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [dev-dependencies]
 async-std = { version = "1.12.0", features = ["attributes"] }
diff --git a/transports/tcp/Cargo.toml b/transports/tcp/Cargo.toml
index b17d7f3b58e..03e7fac491c 100644
--- a/transports/tcp/Cargo.toml
+++ b/transports/tcp/Cargo.toml
@@ -37,8 +37,6 @@ tracing-subscriber = { workspace = true, features = ["env-filter"] }
 [package.metadata.docs.rs]
 all-features = true
 
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/transports/tls/Cargo.toml b/transports/tls/Cargo.toml
index c4b30951e66..41b4c215dd9 100644
--- a/transports/tls/Cargo.toml
+++ b/transports/tls/Cargo.toml
@@ -40,8 +40,6 @@ tokio = { workspace = true, features = ["full"] }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/transports/uds/Cargo.toml b/transports/uds/Cargo.toml
index df5159f3c02..f70ac388fa8 100644
--- a/transports/uds/Cargo.toml
+++ b/transports/uds/Cargo.toml
@@ -24,8 +24,6 @@ tempfile = "3.10"
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/transports/webrtc/Cargo.toml b/transports/webrtc/Cargo.toml
index a205810e7c4..fc2748d93c3 100644
--- a/transports/webrtc/Cargo.toml
+++ b/transports/webrtc/Cargo.toml
@@ -55,5 +55,3 @@ workspace = true
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
diff --git a/transports/websocket-websys/Cargo.toml b/transports/websocket-websys/Cargo.toml
index 0b3148a8b92..32483f28c57 100644
--- a/transports/websocket-websys/Cargo.toml
+++ b/transports/websocket-websys/Cargo.toml
@@ -26,8 +26,6 @@ web-sys = { version = "0.3.69", features = ["BinaryType", "CloseEvent", "Message
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [dev-dependencies]
 libp2p-yamux = { workspace = true }
diff --git a/transports/websocket/Cargo.toml b/transports/websocket/Cargo.toml
index 271631b4021..e08346da5ca 100644
--- a/transports/websocket/Cargo.toml
+++ b/transports/websocket/Cargo.toml
@@ -36,8 +36,6 @@ rcgen = { workspace = true }
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true
diff --git a/transports/webtransport-websys/Cargo.toml b/transports/webtransport-websys/Cargo.toml
index 68ba7091794..370158190b1 100644
--- a/transports/webtransport-websys/Cargo.toml
+++ b/transports/webtransport-websys/Cargo.toml
@@ -44,8 +44,6 @@ multibase = "0.9.1"
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-rustc-args = ["--cfg", "docsrs"]
 
 [lints]
 workspace = true