finish doc_cfg for tracing-tower and tracing-log (#537)

Closes #440 this should be the last of them * finish doc_cfg for tracing-tower * finish doc_cfg for tracing-log * Add cargo metadata to tower and log
tokio-rs · Jan 15, 2020 · dee99ac · dee99ac
1 parent 8b9fc8e
commit dee99ac
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 0 deletions.
diff --git a/tracing-log/Cargo.toml b/tracing-log/Cargo.toml
@@ -34,3 +34,7 @@ tracing = "0.1"
 [badges]
 azure-devops = { project = "tracing/tracing", pipeline = "tokio-rs.tracing", build = "1" }
 maintenance = { status = "actively-maintained" }
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/tracing-log/src/lib.rs b/tracing-log/src/lib.rs
@@ -87,6 +87,7 @@
 //! [`Subscriber`]: https://docs.rs/tracing/latest/tracing/trait.Subscriber.html
 //! [`tracing::Event`]: https://docs.rs/tracing/latest/tracing/struct.Event.html
 #![doc(html_root_url = "https://docs.rs/tracing-log/0.1.1")]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![warn(
     missing_debug_implementations,
     missing_docs,
@@ -123,16 +124,20 @@ use tracing_core::{
 };
 
 #[cfg(feature = "log-tracer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "log-tracer")))]
 pub mod log_tracer;
 
 #[cfg(feature = "trace-logger")]
+#[cfg_attr(docsrs, doc(cfg(feature = "trace-logger")))]
 pub mod trace_logger;
 
 #[cfg(feature = "log-tracer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "log-tracer")))]
 #[doc(inline)]
 pub use self::log_tracer::LogTracer;
 
 #[cfg(feature = "trace-logger")]
+#[cfg_attr(docsrs, doc(cfg(feature = "trace-logger")))]
 #[deprecated(
     since = "0.1.1",
     note = "use the `tracing` crate's \"log\" feature flag instead"
@@ -142,6 +147,7 @@ pub use self::log_tracer::LogTracer;
 pub use self::trace_logger::TraceLogger;
 
 #[cfg(feature = "env_logger")]
+#[cfg_attr(docsrs, doc(cfg(feature = "env_logger")))]
 pub mod env_logger;
 
 /// Format a log record as a trace event in the current span.

diff --git a/tracing-log/src/log_tracer.rs b/tracing-log/src/log_tracer.rs
@@ -112,6 +112,7 @@ impl LogTracer {
     ///
     /// [`builder`]: #method.builder
     #[cfg(feature = "std")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
     pub fn init_with_filter(level: log::LevelFilter) -> Result<(), SetLoggerError> {
         Self::builder().with_max_level(level).init()
     }
@@ -146,6 +147,7 @@ impl LogTracer {
     /// [`init_with_filter`]: #method.init_with_filter
     /// [`builder`]: #method.builder
     #[cfg(feature = "std")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
     pub fn init() -> Result<(), SetLoggerError> {
         Self::builder().init()
     }
@@ -241,6 +243,7 @@ impl Builder {
     ///
     /// Setting a global logger can only be done once.
     #[cfg(feature = "std")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
     pub fn init(self) -> Result<(), SetLoggerError> {
         let ignore_crates = self.ignore_crates.into_boxed_slice();
         let logger = Box::new(LogTracer { ignore_crates });

diff --git a/tracing-tower/Cargo.toml b/tracing-tower/Cargo.toml
@@ -36,3 +36,7 @@ http = { version = "0.1", optional = true }
 [badges]
 azure-devops = { project = "tracing/tracing", pipeline = "tokio-rs.tracing", build = "1" }
 maintenance = { status = "experimental" }
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/tracing-tower/src/lib.rs b/tracing-tower/src/lib.rs
@@ -1,3 +1,4 @@
+#![cfg_attr(docsrs, feature(doc_cfg))]
 #![warn(
     missing_debug_implementations,
     // missing_docs, // TODO: add documentation!
@@ -29,6 +30,7 @@ pub mod request_span;
 pub mod service_span;
 
 #[cfg(feature = "http")]
+#[cfg_attr(docsrs, doc(cfg(feature = "http")))]
 pub mod http;
 
 pub type InstrumentedService<S, R> = service_span::Service<request_span::Service<S, R>>;
@@ -65,6 +67,7 @@ where
 }
 
 #[cfg(feature = "tower-util")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-util")))]
 pub trait InstrumentMake<T, R>
 where
     Self: tower_util::MakeService<T, R> + Sized,
@@ -87,6 +90,7 @@ where
 impl<S, R> InstrumentableService<R> for S where S: Service<R> + Sized {}
 
 #[cfg(feature = "tower-util")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-util")))]
 impl<M, T, R> InstrumentMake<T, R> for M where M: tower_util::MakeService<T, R> {}
 
 pub trait GetSpan<T>: crate::sealed::Sealed<T> {

diff --git a/tracing-tower/src/request_span.rs b/tracing-tower/src/request_span.rs
@@ -18,9 +18,11 @@ where
 }
 
 #[cfg(feature = "tower-layer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
 pub use self::layer::*;
 
 #[cfg(feature = "tower-layer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
 mod layer {
     use super::*;
 
@@ -70,9 +72,11 @@ mod layer {
 }
 
 #[cfg(feature = "tower-make")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-make")))]
 pub use self::make::MakeService;
 
 #[cfg(feature = "tower-make")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-make")))]
 pub mod make {
     use super::*;
     use pin_project::pin_project;
@@ -85,6 +89,7 @@ pub mod make {
     }
 
     #[cfg(feature = "tower-layer")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
     #[derive(Debug)]
     pub struct MakeLayer<R, T, G = fn(&R) -> tracing::Span>
     where
@@ -104,6 +109,7 @@ pub mod make {
     }
 
     #[cfg(feature = "tower-layer")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
     pub fn layer<R, T, G>(get_span: G) -> MakeLayer<R, T, G>
     where
         G: GetSpan<R> + Clone,
@@ -117,6 +123,7 @@ pub mod make {
     // === impl MakeLayer ===
 
     #[cfg(feature = "tower-layer")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
     impl<S, R, G, T> tower_layer::Layer<S> for MakeLayer<R, T, G>
     where
         S: tower_make::MakeService<T, R>,
@@ -130,6 +137,7 @@ pub mod make {
     }
 
     #[cfg(feature = "tower-layer")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
     impl<R, T, G> Clone for MakeLayer<R, T, G>
     where
         G: GetSpan<R> + Clone,

diff --git a/tracing-tower/src/service_span.rs b/tracing-tower/src/service_span.rs
@@ -13,12 +13,15 @@ pub struct Service<S> {
 }
 
 #[cfg(feature = "tower-layer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
 pub use self::layer::*;
 
 #[cfg(feature = "tower-util")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-util")))]
 pub use self::make::MakeService;
 
 #[cfg(feature = "tower-layer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
 mod layer {
     use super::*;
 
@@ -73,6 +76,7 @@ mod layer {
 }
 
 #[cfg(feature = "tower-layer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
 pub mod make {
     use super::*;
     use pin_project::pin_project;
@@ -105,6 +109,7 @@ pub mod make {
     }
 
     #[cfg(feature = "tower-layer")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
     pub fn layer<T, R, G>(get_span: G) -> MakeLayer<T, R, G>
     where
         G: GetSpan<T> + Clone,
@@ -118,6 +123,7 @@ pub mod make {
     // === impl MakeLayer ===
 
     #[cfg(feature = "tower-layer")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
     impl<M, T, R, G> tower_layer::Layer<M> for MakeLayer<T, R, G>
     where
         M: tower_make::MakeService<T, R>,
@@ -131,6 +137,7 @@ pub mod make {
     }
 
     #[cfg(feature = "tower-layer")]
+    #[cfg_attr(docsrs, doc(cfg(feature = "tower-layer")))]
     impl<T, R, G> Clone for MakeLayer<T, R, G>
     where
         G: GetSpan<T> + Clone,