From 7f939fa4804b3c934343141b79e8e2ded5fe0b0d Mon Sep 17 00:00:00 2001 From: trinity-1686a Date: Wed, 17 Aug 2022 21:13:13 +0200 Subject: [PATCH] enable doc_auto_cfg feature on every crate when documenting for docs.rs --- .gitlab-ci.yml | 2 +- crates/arti-bench/Cargo.toml | 3 +++ crates/arti-client/Cargo.toml | 3 +++ crates/arti-client/src/lib.rs | 1 + crates/arti-config/Cargo.toml | 3 +++ crates/arti-config/src/lib.rs | 1 + crates/arti-hyper/Cargo.toml | 3 +++ crates/arti-hyper/src/lib.rs | 1 + crates/arti-testing/Cargo.toml | 3 +++ crates/arti/Cargo.toml | 3 +++ crates/arti/src/lib.rs | 1 + crates/caret/Cargo.toml | 3 +++ crates/caret/src/lib.rs | 1 + crates/fs-mistrust/Cargo.toml | 3 +++ crates/fs-mistrust/src/lib.rs | 1 + crates/retry-error/Cargo.toml | 3 +++ crates/retry-error/src/lib.rs | 1 + crates/safelog/Cargo.toml | 3 +++ crates/safelog/src/lib.rs | 1 + crates/tor-basic-utils/Cargo.toml | 3 +++ crates/tor-basic-utils/src/lib.rs | 1 + crates/tor-bytes/Cargo.toml | 3 +++ crates/tor-bytes/src/lib.rs | 1 + crates/tor-cell/Cargo.toml | 3 +++ crates/tor-cell/src/lib.rs | 1 + crates/tor-cert/Cargo.toml | 3 +++ crates/tor-cert/src/lib.rs | 1 + crates/tor-chanmgr/Cargo.toml | 3 +++ crates/tor-chanmgr/src/lib.rs | 1 + crates/tor-checkable/Cargo.toml | 3 +++ crates/tor-checkable/src/lib.rs | 1 + crates/tor-circmgr/Cargo.toml | 3 +++ crates/tor-circmgr/src/lib.rs | 1 + crates/tor-config/Cargo.toml | 3 +++ crates/tor-config/src/lib.rs | 1 + crates/tor-congestion/Cargo.toml | 3 +++ crates/tor-congestion/src/lib.rs | 1 + crates/tor-consdiff/Cargo.toml | 3 +++ crates/tor-consdiff/src/lib.rs | 1 + crates/tor-dirclient/Cargo.toml | 3 +++ crates/tor-dirclient/src/lib.rs | 1 + crates/tor-dirmgr/Cargo.toml | 3 +++ crates/tor-dirmgr/src/lib.rs | 1 + crates/tor-error/Cargo.toml | 3 +++ crates/tor-error/src/lib.rs | 1 + crates/tor-events/Cargo.toml | 3 +++ crates/tor-events/src/lib.rs | 1 + crates/tor-guardmgr/Cargo.toml | 3 +++ crates/tor-guardmgr/src/lib.rs | 1 + crates/tor-linkspec/Cargo.toml | 3 +++ crates/tor-linkspec/src/lib.rs | 1 + crates/tor-llcrypto/Cargo.toml | 3 +++ crates/tor-llcrypto/src/lib.rs | 1 + crates/tor-netdir/Cargo.toml | 3 +++ crates/tor-netdir/src/lib.rs | 1 + crates/tor-netdoc/Cargo.toml | 3 +++ crates/tor-netdoc/src/lib.rs | 1 + crates/tor-persist/Cargo.toml | 3 +++ crates/tor-persist/src/lib.rs | 1 + crates/tor-proto/Cargo.toml | 3 +++ crates/tor-proto/src/lib.rs | 1 + crates/tor-protover/Cargo.toml | 3 +++ crates/tor-protover/src/lib.rs | 1 + crates/tor-rtcompat/Cargo.toml | 3 +++ crates/tor-rtcompat/src/lib.rs | 1 + crates/tor-rtmock/Cargo.toml | 3 +++ crates/tor-rtmock/src/lib.rs | 1 + crates/tor-socksproto/Cargo.toml | 3 +++ crates/tor-socksproto/src/lib.rs | 1 + crates/tor-units/Cargo.toml | 3 +++ crates/tor-units/src/lib.rs | 1 + 71 files changed, 143 insertions(+), 1 deletion(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8819498a5..41d99e1f6 100644 --- a/.gitlab-ci.yml +++ b/.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 diff --git a/crates/arti-bench/Cargo.toml b/crates/arti-bench/Cargo.toml index 685bc9f1d..b4882129e 100644 --- a/crates/arti-bench/Cargo.toml +++ b/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"] diff --git a/crates/arti-client/Cargo.toml b/crates/arti-client/Cargo.toml index f188e2e49..6ceff5f96 100644 --- a/crates/arti-client/Cargo.toml +++ b/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"] diff --git a/crates/arti-client/src/lib.rs b/crates/arti-client/src/lib.rs index d0810dc54..282f7a548 100644 --- a/crates/arti-client/src/lib.rs +++ b/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 diff --git a/crates/arti-config/Cargo.toml b/crates/arti-config/Cargo.toml index ba8d3049e..ce1899c00 100644 --- a/crates/arti-config/Cargo.toml +++ b/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"] diff --git a/crates/arti-config/src/lib.rs b/crates/arti-config/src/lib.rs index 9953f4d89..b3c0b7853 100644 --- a/crates/arti-config/src/lib.rs +++ b/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 diff --git a/crates/arti-hyper/Cargo.toml b/crates/arti-hyper/Cargo.toml index 3e55e5aff..9e8d5291b 100644 --- a/crates/arti-hyper/Cargo.toml +++ b/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"] diff --git a/crates/arti-hyper/src/lib.rs b/crates/arti-hyper/src/lib.rs index a1ffcd127..a1bf18516 100644 --- a/crates/arti-hyper/src/lib.rs +++ b/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, diff --git a/crates/arti-testing/Cargo.toml b/crates/arti-testing/Cargo.toml index 5468a6c0a..7599b3dd2 100644 --- a/crates/arti-testing/Cargo.toml +++ b/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"] diff --git a/crates/arti/Cargo.toml b/crates/arti/Cargo.toml index 9ca8307f7..9386842f1 100644 --- a/crates/arti/Cargo.toml +++ b/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"] diff --git a/crates/arti/src/lib.rs b/crates/arti/src/lib.rs index a962ed2fa..ef6dcebc6 100644 --- a/crates/arti/src/lib.rs +++ b/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 diff --git a/crates/caret/Cargo.toml b/crates/caret/Cargo.toml index 4810321f2..1ac145989 100644 --- a/crates/caret/Cargo.toml +++ b/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"] diff --git a/crates/caret/src/lib.rs b/crates/caret/src/lib.rs index 845d22298..187d83ed6 100644 --- a/crates/caret/src/lib.rs +++ b/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? diff --git a/crates/fs-mistrust/Cargo.toml b/crates/fs-mistrust/Cargo.toml index 4eb7f3867..77921700f 100644 --- a/crates/fs-mistrust/Cargo.toml +++ b/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"] diff --git a/crates/fs-mistrust/src/lib.rs b/crates/fs-mistrust/src/lib.rs index 8b23e17f0..ffb5ae395 100644 --- a/crates/fs-mistrust/src/lib.rs +++ b/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 diff --git a/crates/retry-error/Cargo.toml b/crates/retry-error/Cargo.toml index c44461ec3..ce8fbfae8 100644 --- a/crates/retry-error/Cargo.toml +++ b/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"] diff --git a/crates/retry-error/src/lib.rs b/crates/retry-error/src/lib.rs index de63edf6b..f6e9d92fc 100644 --- a/crates/retry-error/src/lib.rs +++ b/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 diff --git a/crates/safelog/Cargo.toml b/crates/safelog/Cargo.toml index 8c9a021e6..c2bcbd9bb 100644 --- a/crates/safelog/Cargo.toml +++ b/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"] diff --git a/crates/safelog/src/lib.rs b/crates/safelog/src/lib.rs index 27e67c22c..ea761bf73 100644 --- a/crates/safelog/src/lib.rs +++ b/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 diff --git a/crates/tor-basic-utils/Cargo.toml b/crates/tor-basic-utils/Cargo.toml index ea18628b3..eca4ed724 100644 --- a/crates/tor-basic-utils/Cargo.toml +++ b/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"] diff --git a/crates/tor-basic-utils/src/lib.rs b/crates/tor-basic-utils/src/lib.rs index 3bdea1058..ee5fe9fe8 100644 --- a/crates/tor-basic-utils/src/lib.rs +++ b/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-*`. diff --git a/crates/tor-bytes/Cargo.toml b/crates/tor-bytes/Cargo.toml index 06bb81b6e..e0c72d73e 100644 --- a/crates/tor-bytes/Cargo.toml +++ b/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"] diff --git a/crates/tor-bytes/src/lib.rs b/crates/tor-bytes/src/lib.rs index 134bf69c4..191d6dd1a 100644 --- a/crates/tor-bytes/src/lib.rs +++ b/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 diff --git a/crates/tor-cell/Cargo.toml b/crates/tor-cell/Cargo.toml index edea1a294..4ac1797f8 100644 --- a/crates/tor-cell/Cargo.toml +++ b/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"] diff --git a/crates/tor-cell/src/lib.rs b/crates/tor-cell/src/lib.rs index 225a86ec1..e96ab9533 100644 --- a/crates/tor-cell/src/lib.rs +++ b/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 diff --git a/crates/tor-cert/Cargo.toml b/crates/tor-cert/Cargo.toml index 6a3d03f3d..70ff1f14c 100644 --- a/crates/tor-cert/Cargo.toml +++ b/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"] diff --git a/crates/tor-cert/src/lib.rs b/crates/tor-cert/src/lib.rs index c782650e6..5f8c0c33b 100644 --- a/crates/tor-cert/src/lib.rs +++ b/crates/tor-cert/src/lib.rs @@ -1,3 +1,4 @@ +#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_cfg))] //! Implementation for Tor certificates //! //! # Overview diff --git a/crates/tor-chanmgr/Cargo.toml b/crates/tor-chanmgr/Cargo.toml index b508ad9e6..f36e5a51e 100644 --- a/crates/tor-chanmgr/Cargo.toml +++ b/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"] diff --git a/crates/tor-chanmgr/src/lib.rs b/crates/tor-chanmgr/src/lib.rs index 252f182e8..d1b42fac9 100644 --- a/crates/tor-chanmgr/src/lib.rs +++ b/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 diff --git a/crates/tor-checkable/Cargo.toml b/crates/tor-checkable/Cargo.toml index 4d6b2a4d4..b638d066f 100644 --- a/crates/tor-checkable/Cargo.toml +++ b/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"] diff --git a/crates/tor-checkable/src/lib.rs b/crates/tor-checkable/src/lib.rs index b9d5fa2aa..79d24f13b 100644 --- a/crates/tor-checkable/src/lib.rs +++ b/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 diff --git a/crates/tor-circmgr/Cargo.toml b/crates/tor-circmgr/Cargo.toml index 09a398e48..0d4ea3c21 100644 --- a/crates/tor-circmgr/Cargo.toml +++ b/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"] diff --git a/crates/tor-circmgr/src/lib.rs b/crates/tor-circmgr/src/lib.rs index b40acff1f..67192fef6 100644 --- a/crates/tor-circmgr/src/lib.rs +++ b/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 diff --git a/crates/tor-config/Cargo.toml b/crates/tor-config/Cargo.toml index b55fc97c8..511d3d19e 100644 --- a/crates/tor-config/Cargo.toml +++ b/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"] diff --git a/crates/tor-config/src/lib.rs b/crates/tor-config/src/lib.rs index 9182891f1..926abd46e 100644 --- a/crates/tor-config/src/lib.rs +++ b/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 diff --git a/crates/tor-congestion/Cargo.toml b/crates/tor-congestion/Cargo.toml index fd4e84720..f1058a1aa 100644 --- a/crates/tor-congestion/Cargo.toml +++ b/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"] diff --git a/crates/tor-congestion/src/lib.rs b/crates/tor-congestion/src/lib.rs index 8fbfada3f..b1ebb08bc 100644 --- a/crates/tor-congestion/src/lib.rs +++ b/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 diff --git a/crates/tor-consdiff/Cargo.toml b/crates/tor-consdiff/Cargo.toml index d7f2f6876..34d3a9038 100644 --- a/crates/tor-consdiff/Cargo.toml +++ b/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"] diff --git a/crates/tor-consdiff/src/lib.rs b/crates/tor-consdiff/src/lib.rs index b48216283..b98325f99 100644 --- a/crates/tor-consdiff/src/lib.rs +++ b/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 diff --git a/crates/tor-dirclient/Cargo.toml b/crates/tor-dirclient/Cargo.toml index a74e6eb40..ceeaa6f04 100644 --- a/crates/tor-dirclient/Cargo.toml +++ b/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"] diff --git a/crates/tor-dirclient/src/lib.rs b/crates/tor-dirclient/src/lib.rs index 868891b7b..1d71aa81a 100644 --- a/crates/tor-dirclient/src/lib.rs +++ b/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 diff --git a/crates/tor-dirmgr/Cargo.toml b/crates/tor-dirmgr/Cargo.toml index b2d5337a0..cc4202757 100644 --- a/crates/tor-dirmgr/Cargo.toml +++ b/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"] diff --git a/crates/tor-dirmgr/src/lib.rs b/crates/tor-dirmgr/src/lib.rs index 149a9f9d9..5bcd99ee1 100644 --- a/crates/tor-dirmgr/src/lib.rs +++ b/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 diff --git a/crates/tor-error/Cargo.toml b/crates/tor-error/Cargo.toml index 6861c8126..932bbce13 100644 --- a/crates/tor-error/Cargo.toml +++ b/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"] diff --git a/crates/tor-error/src/lib.rs b/crates/tor-error/src/lib.rs index 4bffd0edd..6a83e6fa5 100644 --- a/crates/tor-error/src/lib.rs +++ b/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, diff --git a/crates/tor-events/Cargo.toml b/crates/tor-events/Cargo.toml index d0d2c6573..024475960 100644 --- a/crates/tor-events/Cargo.toml +++ b/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"] diff --git a/crates/tor-events/src/lib.rs b/crates/tor-events/src/lib.rs index c4c43702a..b36579365 100644 --- a/crates/tor-events/src/lib.rs +++ b/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 @@ diff --git a/crates/tor-guardmgr/Cargo.toml b/crates/tor-guardmgr/Cargo.toml index 2f845dd39..70edb757e 100644 --- a/crates/tor-guardmgr/Cargo.toml +++ b/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"] diff --git a/crates/tor-guardmgr/src/lib.rs b/crates/tor-guardmgr/src/lib.rs index 890d81402..c4634c52d 100644 --- a/crates/tor-guardmgr/src/lib.rs +++ b/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 diff --git a/crates/tor-linkspec/Cargo.toml b/crates/tor-linkspec/Cargo.toml index 821430bd5..8690ce5c9 100644 --- a/crates/tor-linkspec/Cargo.toml +++ b/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"] diff --git a/crates/tor-linkspec/src/lib.rs b/crates/tor-linkspec/src/lib.rs index 45031ade2..8f2c74a98 100644 --- a/crates/tor-linkspec/src/lib.rs +++ b/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 diff --git a/crates/tor-llcrypto/Cargo.toml b/crates/tor-llcrypto/Cargo.toml index 4880a3793..546a84a7d 100644 --- a/crates/tor-llcrypto/Cargo.toml +++ b/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"] diff --git a/crates/tor-llcrypto/src/lib.rs b/crates/tor-llcrypto/src/lib.rs index b31b1c67e..d20959a93 100644 --- a/crates/tor-llcrypto/src/lib.rs +++ b/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 diff --git a/crates/tor-netdir/Cargo.toml b/crates/tor-netdir/Cargo.toml index 0ddcbd746..8f8a2b100 100644 --- a/crates/tor-netdir/Cargo.toml +++ b/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"] diff --git a/crates/tor-netdir/src/lib.rs b/crates/tor-netdir/src/lib.rs index 351f716ce..7991fd42d 100644 --- a/crates/tor-netdir/src/lib.rs +++ b/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 diff --git a/crates/tor-netdoc/Cargo.toml b/crates/tor-netdoc/Cargo.toml index 2c6fbba3e..fb94bed22 100644 --- a/crates/tor-netdoc/Cargo.toml +++ b/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"] diff --git a/crates/tor-netdoc/src/lib.rs b/crates/tor-netdoc/src/lib.rs index 933d496b2..00641e517 100644 --- a/crates/tor-netdoc/src/lib.rs +++ b/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 diff --git a/crates/tor-persist/Cargo.toml b/crates/tor-persist/Cargo.toml index 444d99509..bd3a6714d 100644 --- a/crates/tor-persist/Cargo.toml +++ b/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"] diff --git a/crates/tor-persist/src/lib.rs b/crates/tor-persist/src/lib.rs index 50d4f84cd..f45c735e9 100644 --- a/crates/tor-persist/src/lib.rs +++ b/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 diff --git a/crates/tor-proto/Cargo.toml b/crates/tor-proto/Cargo.toml index 2526de4f5..0e42391f8 100644 --- a/crates/tor-proto/Cargo.toml +++ b/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"] diff --git a/crates/tor-proto/src/lib.rs b/crates/tor-proto/src/lib.rs index 72e116ad0..1317d3114 100644 --- a/crates/tor-proto/src/lib.rs +++ b/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 diff --git a/crates/tor-protover/Cargo.toml b/crates/tor-protover/Cargo.toml index d6fda9740..649e7d2f7 100644 --- a/crates/tor-protover/Cargo.toml +++ b/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"] diff --git a/crates/tor-protover/src/lib.rs b/crates/tor-protover/src/lib.rs index 8ade39947..ac42d9075 100644 --- a/crates/tor-protover/src/lib.rs +++ b/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 diff --git a/crates/tor-rtcompat/Cargo.toml b/crates/tor-rtcompat/Cargo.toml index c853fab70..e0b83ede7 100644 --- a/crates/tor-rtcompat/Cargo.toml +++ b/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"] diff --git a/crates/tor-rtcompat/src/lib.rs b/crates/tor-rtcompat/src/lib.rs index 38ca31f47..167438c31 100644 --- a/crates/tor-rtcompat/src/lib.rs +++ b/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 diff --git a/crates/tor-rtmock/Cargo.toml b/crates/tor-rtmock/Cargo.toml index d0a719048..fa88b5374 100644 --- a/crates/tor-rtmock/Cargo.toml +++ b/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"] diff --git a/crates/tor-rtmock/src/lib.rs b/crates/tor-rtmock/src/lib.rs index eacf81cbe..5386dd6ad 100644 --- a/crates/tor-rtmock/src/lib.rs +++ b/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 diff --git a/crates/tor-socksproto/Cargo.toml b/crates/tor-socksproto/Cargo.toml index bb72c22f0..b73a4923d 100644 --- a/crates/tor-socksproto/Cargo.toml +++ b/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"] diff --git a/crates/tor-socksproto/src/lib.rs b/crates/tor-socksproto/src/lib.rs index 89ec8a977..e44c1b334 100644 --- a/crates/tor-socksproto/src/lib.rs +++ b/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 diff --git a/crates/tor-units/Cargo.toml b/crates/tor-units/Cargo.toml index e42ae6018..4f947b715 100644 --- a/crates/tor-units/Cargo.toml +++ b/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"] diff --git a/crates/tor-units/src/lib.rs b/crates/tor-units/src/lib.rs index de6174c62..42da63de3 100644 --- a/crates/tor-units/src/lib.rs +++ b/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