enable doc_auto_cfg feature on every crate when documenting for docs.rs

.gitlab-ci.yml

@@ -100,7 +100,7 @@ rust-nightly:
     # cfg flag for nightly, and a cargo "feature" would be bad with --all-features.)
     - (echo; cat clippy-nightly.toml) >>clippy.toml
     - cargo clippy --all-features --tests -- --cfg ci_arti_nightly -D clippy::dbg_macro -D clippy::print_stdout -D clippy::print_stderr
-    - RUSTDOCFLAGS="-Dwarnings" cargo doc --all-features --document-private-items --no-deps
+    - RUSTDOCFLAGS="-Dwarnings --cfg docsrs" cargo doc --all-features --document-private-items --no-deps
   tags:
     - amd64
 

crates/arti-bench/Cargo.toml

@@ -28,3 +28,6 @@ tor-config = { path = "../tor-config", version = "0.5.0" }
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
 tracing = "0.1.18"
 tracing-subscriber = { version = "0.3.0", features = ["env-filter"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/arti-client/Cargo.toml

@@ -98,3 +98,6 @@ tokio-crate = { package = "tokio", version = "1.7", features = [
 tokio-util = { version = "0.7.0", features = ["compat"] }
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
 tracing-subscriber = "0.3.0"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/arti-client/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! High-level functionality for accessing the Tor network as a client.
 //!
 //! # Overview

crates/arti-config/Cargo.toml

@@ -10,3 +10,6 @@ description = "Removed crate.  (Tools for configuration management in Arti)"
 keywords = ["tor", "arti"]
 categories = ["config"]
 repository = "https://gitlab.torproject.org/tpo/core/arti.git/"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/arti-config/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `arti-config`: Removed crate.  (Tools for configuration management in Arti)
 //!
 //! This crate was part of

crates/arti-hyper/Cargo.toml

@@ -45,3 +45,6 @@ tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio
 
 [dev-dependencies]
 tracing-subscriber = "0.3.0"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/arti-hyper/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! High-level layer for making http(s) requests the Tor network as a client.
 //!
 //! This can be used by applications which embed Arti,

crates/arti-testing/Cargo.toml

@@ -45,3 +45,6 @@ tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0" }
 tracing = "0.1.18"
 tracing-appender = "0.2.0"
 tracing-subscriber = { version = "0.3.0", features = ["env-filter"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/arti/Cargo.toml

@@ -76,3 +76,6 @@ libc = { version = "0.2", default-features = false }
 
 [target.'cfg(windows)'.dependencies]
 winapi = { version = "0.3.8", features = ["winerror"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/arti/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! A minimal command line program for connecting to the tor network
 //!
 //! (If you want a more general Tor client library interface, use

crates/caret/Cargo.toml

@@ -12,3 +12,6 @@ categories = ["rust-patterns"]
 repository = "https://gitlab.torproject.org/tpo/core/arti.git/"
 
 [dependencies]
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/caret/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `caret`: Integers with some named values.
 //!
 //! # Crikey! Another Rust Enum Tool?

crates/fs-mistrust/Cargo.toml

@@ -33,3 +33,6 @@ anyhow = "1.0.23"
 serde_json = "1.0.50"
 tempfile = "3"
 toml = "0.5"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/fs-mistrust/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! # `fs-mistrust`: check whether file permissions are private.
 //!
 //! This crate provides a set of functionality to check the permissions on files

crates/retry-error/Cargo.toml

@@ -14,3 +14,6 @@ repository = "https://gitlab.torproject.org/tpo/core/arti.git/"
 [dev-dependencies]
 
 anyhow = "1.0.23"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/retry-error/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! An error attempt to represent multiple failures.
 //!
 //! This crate implements [`RetryError`], a type to use when you

crates/safelog/Cargo.toml

@@ -24,3 +24,6 @@ thiserror = "1"
 [dev-dependencies]
 serial_test = "0.8.0"
 static_assertions = "1"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/safelog/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! # `safelog`: Mark data as sensitive for logging purposes.
 //!
 //! Some information is too sensitive to routinely write to system logs, but

crates/tor-basic-utils/Cargo.toml

@@ -27,3 +27,6 @@ derive_more = "0.99"
 educe = "0.4.6"
 futures-await-test = "0.3.0"
 tokio = { version = "1.7", features = ["macros", "rt", "rt-multi-thread", "time"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-basic-utils/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-basic-utils`: Utilities (low-level) for Tor
 //!
 //! Miscellaneous utilities for `tor-*` and `arti-*`.

crates/tor-bytes/Cargo.toml

@@ -28,3 +28,6 @@ hex-literal = "0.3"
 
 [target.wasm32-unknown-unknown.dependencies]
 getrandom = { version = "0.2.3", features = ["js"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-bytes/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-bytes`: Utilities to decode/encode things into bytes.
 //!
 //! # Overview

crates/tor-cell/Cargo.toml

@@ -39,3 +39,6 @@ tor-units = { path = "../tor-units", version = "0.3.1" }
 [dev-dependencies]
 hex = "0.4"
 hex-literal = "0.3"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-cell/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Coding and decoding for the cell types that make up Tor's protocol
 //!
 //! # Overview

crates/tor-cert/Cargo.toml

@@ -30,3 +30,6 @@ tor-llcrypto = { path = "../tor-llcrypto", version = "0.3.3" }
 base64 = "0.13.0"
 hex-literal = "0.3"
 rand = "0.8"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-cert/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Implementation for Tor certificates
 //!
 //! # Overview

crates/tor-chanmgr/Cargo.toml

@@ -47,3 +47,6 @@ tor-netdir = { path = "../tor-netdir", version = "0.5.0", features = ["testing"]
 tor-proto = { path = "../tor-proto", version = "0.5.0", features = ["testing"] }
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
 tor-rtmock = { path = "../tor-rtmock", version = "0.4.0" }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-chanmgr/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-chanmgr`: Manage a set of channels on the Tor network.
 //!
 //! # Overview

crates/tor-checkable/Cargo.toml

@@ -20,3 +20,6 @@ humantime = "2"
 signature = "1"
 thiserror = "1"
 tor-llcrypto = { path = "../tor-llcrypto", version = "0.3.2" }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-checkable/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Traits for wrapping up signed and/or time-bound objects
 //!
 //! # Overview

crates/tor-circmgr/Cargo.toml

@@ -60,3 +60,6 @@ tor-netdir = { path = "../tor-netdir", version = "0.5.0", features = ["testing"]
 tor-persist = { path = "../tor-persist", version = "0.5.0", features = ["testing"] }
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
 tor-rtmock = { path = "../tor-rtmock", version = "0.4.0" }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-circmgr/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-circmgr`: circuits through the Tor network on demand.
 //!
 //! # Overview

crates/tor-config/Cargo.toml

@@ -44,3 +44,6 @@ serde_json = "1.0.50"
 tempfile = "3"
 toml = "0.5"
 tracing-test = "0.2"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-config/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-config`: Tools for configuration management in Arti
 //!
 //! # Overview

crates/tor-congestion/Cargo.toml

@@ -16,3 +16,6 @@ thiserror = "1"
 tor-error = { path = "../tor-error", version = "0.3.2" }
 tor-netdir = { path = "../tor-netdir", version = "0.5.0"}
 tor-units = { path = "../tor-units", version = "0.3.1"}
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-congestion/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-congestion`: algorithms for congestion control on the Tor network
 //!
 //! # Overview

crates/tor-consdiff/Cargo.toml

@@ -20,3 +20,6 @@ digest = "0.10.0"
 hex = "0.4"
 thiserror = "1"
 tor-llcrypto = { path = "../tor-llcrypto", version = "0.3.2" }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-consdiff/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-consdiff`: Restricted ed diff and patch formats for Tor.
 //!
 //! # Overview

crates/tor-dirclient/Cargo.toml

@@ -43,3 +43,6 @@ tracing = "0.1.18"
 futures-await-test = "0.3.0"
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
 tor-rtmock = { path = "../tor-rtmock", version = "0.4.0" }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-dirclient/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-dirclient`: Implements a minimal directory client for Tor.
 //!
 //! # Overview

crates/tor-dirmgr/Cargo.toml

@@ -74,3 +74,6 @@ hex-literal = "0.3"
 tempfile = "3"
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
 tor-rtmock = { path = "../tor-rtmock", version = "0.4.0" }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-dirmgr/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-dirmgr`: Code to fetch, store, and update Tor directory information.
 //!
 //! # Overview

crates/tor-error/Cargo.toml

@@ -23,3 +23,6 @@ strum = { version = "0.24", features = ["derive"] }
 thiserror = "1"
 
 [dev-dependencies]
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-error/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-error` -- Support for error handling in Tor and Arti
 //!
 //! Primarily, this crate provides the [`ErrorKind`] enum,

crates/tor-events/Cargo.toml

@@ -21,3 +21,6 @@ tracing = "0.1.18"
 
 [dev-dependencies]
 tokio = { version = "1.7", features = ["macros", "rt", "rt-multi-thread", "time"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-events/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Tools for generating a stream of structured events, similar to C tor's `ControlPort`.
 
 // @@ begin lint list maintained by maint/add_warning @@

crates/tor-guardmgr/Cargo.toml

@@ -53,3 +53,6 @@ tor-netdoc = { path = "../tor-netdoc", version = "0.5.0" }
 tor-persist = { path = "../tor-persist", version = "0.5.0", features = ["testing"] }
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
 tor-rtmock = { path = "../tor-rtmock", version = "0.4.0" }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-guardmgr/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-guardmgr`: guard node selection for Tor network clients.
 //!
 //! # Overview

crates/tor-linkspec/Cargo.toml

@@ -24,3 +24,6 @@ tor-protover = { path = "../tor-protover", version = "0.3.0" }
 
 [dev-dependencies]
 hex-literal = "0.3"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-linkspec/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-linkspec`: Descriptions of Tor relays, as used to connect to them.
 //!
 //! # Overview

crates/tor-llcrypto/Cargo.toml

@@ -57,3 +57,6 @@ tor-basic-utils = { path = "../tor-basic-utils", version = "0.3.3" }
 
 [target.wasm32-unknown-unknown.dependencies]
 getrandom = { version = "0.2.3", features = ["js"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-llcrypto/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-llcrypto`: Low-level cryptographic implementations for Tor.
 //!
 //! # Overview

crates/tor-netdir/Cargo.toml

@@ -55,3 +55,6 @@ hex-literal = "0.3"
 rand_chacha = "0.3"
 tor-basic-utils = { path = "../tor-basic-utils", version = "0.3.3" }
 tor-netdoc = { path = "../tor-netdoc", version = "0.5.0", features = ["build_docs"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-netdir/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Represents a clients'-eye view of the Tor network.
 //!
 //! # Overview

crates/tor-netdoc/Cargo.toml

@@ -74,3 +74,6 @@ weak-table = "0.3.0"
 hex-literal = "0.3"
 itertools = "0.10.1"
 serde_json = "1.0.50"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-netdoc/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Parse and represent directory objects used in Tor.
 //!
 //! # Overview

crates/tor-persist/Cargo.toml

@@ -31,3 +31,6 @@ fslock = { version = "0.2.0" }
 
 [dev-dependencies]
 tempfile = "3"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-persist/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-persist`: Persistent data storage for use with Tor.
 //!
 //! This crate is part of

crates/tor-proto/Cargo.toml

@@ -67,3 +67,6 @@ regex = { version = "1", default-features = false, features = ["std"] }
 statrs = "0.15.0"
 tokio-crate = { package = "tokio", version = "1.7", features = ["full"] }
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-proto/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Implementations for the core Tor protocol
 //!
 //! # Overview

crates/tor-protover/Cargo.toml

@@ -14,3 +14,6 @@ repository = "https://gitlab.torproject.org/tpo/core/arti.git/"
 [dependencies]
 caret = { path = "../caret", version = "0.2.0" }
 thiserror = "1"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-protover/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Implementation of Tor's "subprotocol versioning" feature.
 //!
 //! # Overview

crates/tor-rtcompat/Cargo.toml

@@ -51,3 +51,6 @@ x509-signature = { version = "0.5.0", optional = true }
 [dev-dependencies]
 # Used for testing our TLS implementation.
 native-tls-crate = { package = "native-tls", version = "0.2" }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-rtcompat/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Compatibility between different async runtimes for Arti.
 //!
 //! # Overview

crates/tor-rtmock/Cargo.toml

@@ -24,3 +24,6 @@ futures-await-test = "0.3.0"
 rand = "0.8"
 tor-basic-utils = { path = "../tor-basic-utils", version = "0.3.2" }
 tor-rtcompat = { path = "../tor-rtcompat", version = "0.5.0", features = ["tokio", "native-tls"] }
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-rtmock/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Support for mocking with `tor-rtcompat` asynchronous runtimes.
 //!
 //! # Overview

crates/tor-socksproto/Cargo.toml

@@ -19,3 +19,6 @@ tor-error = { path = "../tor-error", version = "0.3.2" }
 
 [dev-dependencies]
 hex-literal = "0.3"
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-socksproto/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! Implements SOCKS in the flavors provided by Tor.
 //!
 //! # Overview

crates/tor-units/Cargo.toml

@@ -22,3 +22,6 @@ float-cmp = "0.9.0"
 # [derive_more]
 # default-features = false
 # features = ["from"]
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

crates/tor-units/src/lib.rs

@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))]
 //! `tor-units` -- Safe wrappers for primitive numeric types.
 //!
 //! # Overview