From d53481900431212ae8556c51879c4bd73789bf89 Mon Sep 17 00:00:00 2001 From: Eliza Weisman Date: Tue, 21 Jul 2020 10:42:18 -0700 Subject: [PATCH] chore: add tracing logo to RustDoc Now that the new https://tokio.rs is live, we can add the new Tracing logo to the RustDoc! I also added a couple missing `html_root_url` attributes in published crates. Signed-off-by: Eliza Weisman --- assets/logo.svg | 5 +++++ tracing-appender/src/lib.rs | 4 ++++ tracing-attributes/src/lib.rs | 4 ++++ tracing-core/src/lib.rs | 4 ++++ tracing-error/src/lib.rs | 4 ++++ tracing-flame/src/lib.rs | 4 ++++ tracing-futures/src/lib.rs | 6 +++++- tracing-journald/src/lib.rs | 4 ++++ tracing-log/src/lib.rs | 4 ++++ tracing-opentelemetry/src/lib.rs | 5 +++++ tracing-serde/src/lib.rs | 5 +++++ tracing-subscriber/src/lib.rs | 4 ++++ tracing-tower/src/lib.rs | 4 ++++ tracing/src/lib.rs | 4 ++++ 14 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 assets/logo.svg diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 0000000000..9af725a253 --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/tracing-appender/src/lib.rs b/tracing-appender/src/lib.rs index 7f1a0f2405..56509d4436 100644 --- a/tracing-appender/src/lib.rs +++ b/tracing-appender/src/lib.rs @@ -105,6 +105,10 @@ //! # } //! ``` #![doc(html_root_url = "https://docs.rs/tracing-appender/0.1.1")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![warn( missing_debug_implementations, missing_docs, diff --git a/tracing-attributes/src/lib.rs b/tracing-attributes/src/lib.rs index 6845344a44..a8d3aadc64 100644 --- a/tracing-attributes/src/lib.rs +++ b/tracing-attributes/src/lib.rs @@ -36,6 +36,10 @@ //! [span]: https://docs.rs/tracing/latest/tracing/span/index.html //! [instrument]: attr.instrument.html #![doc(html_root_url = "https://docs.rs/tracing-attributes/0.1.9")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![warn( missing_debug_implementations, missing_docs, diff --git a/tracing-core/src/lib.rs b/tracing-core/src/lib.rs index 4c24b40232..4ce6e38919 100644 --- a/tracing-core/src/lib.rs +++ b/tracing-core/src/lib.rs @@ -69,6 +69,10 @@ //! [`tokio-rs/tracing`]: https://github.com/tokio-rs/tracing //! [`tracing`]: https://crates.io/crates/tracing #![doc(html_root_url = "https://docs.rs/tracing-core/0.1.11")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(docsrs, feature(doc_cfg))] #![warn( diff --git a/tracing-error/src/lib.rs b/tracing-error/src/lib.rs index 1d5da97af3..f802309c18 100644 --- a/tracing-error/src/lib.rs +++ b/tracing-error/src/lib.rs @@ -170,6 +170,10 @@ //! [`std::error::Error`]: https://doc.rust-lang.org/stable/std/error/trait.Error.html #![cfg_attr(docsrs, feature(doc_cfg))] #![doc(html_root_url = "https://docs.rs/tracing-error/0.1.2")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![warn( missing_debug_implementations, missing_docs, diff --git a/tracing-flame/src/lib.rs b/tracing-flame/src/lib.rs index be7f918c3b..b804bd8561 100644 --- a/tracing-flame/src/lib.rs +++ b/tracing-flame/src/lib.rs @@ -91,6 +91,10 @@ //! [`FlameLayer`]: struct.FlameLayer.html //! [`FlushGuard`]: struct.FlushGuard.html //! [`inferno-flamegraph`]: https://docs.rs/inferno/0.9.5/inferno/index.html#producing-a-flame-graph +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![warn( missing_debug_implementations, missing_docs, diff --git a/tracing-futures/src/lib.rs b/tracing-futures/src/lib.rs index 5f3325c3a8..46f7570df9 100644 --- a/tracing-futures/src/lib.rs +++ b/tracing-futures/src/lib.rs @@ -54,7 +54,11 @@ //! [`Instrument`]: trait.Instrument.html //! [`WithSubscriber`]: trait.WithSubscriber.html //! [`futures`]: https://crates.io/crates/futures -#![doc(html_root_url = "https://docs.rs/tracing-futures/0.2.3")] +#![doc(html_root_url = "https://docs.rs/tracing-futures/0.2.4")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![warn( missing_debug_implementations, missing_docs, diff --git a/tracing-journald/src/lib.rs b/tracing-journald/src/lib.rs index ab8b4d1aad..044927df74 100644 --- a/tracing-journald/src/lib.rs +++ b/tracing-journald/src/lib.rs @@ -1,3 +1,7 @@ +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #[cfg(unix)] use std::os::unix::net::UnixDatagram; use std::{fmt, io, io::Write}; diff --git a/tracing-log/src/lib.rs b/tracing-log/src/lib.rs index 98f86024c9..caf2791937 100644 --- a/tracing-log/src/lib.rs +++ b/tracing-log/src/lib.rs @@ -88,6 +88,10 @@ //! [`tracing::Event`]: https://docs.rs/tracing/latest/tracing/struct.Event.html //! [flags]: https://docs.rs/tracing/latest/tracing/#crate-feature-flags #![doc(html_root_url = "https://docs.rs/tracing-log/0.1.1")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![cfg_attr(docsrs, feature(doc_cfg))] #![warn( missing_debug_implementations, diff --git a/tracing-opentelemetry/src/lib.rs b/tracing-opentelemetry/src/lib.rs index e8fbb3abf1..60ac74947b 100644 --- a/tracing-opentelemetry/src/lib.rs +++ b/tracing-opentelemetry/src/lib.rs @@ -46,6 +46,11 @@ //! ``` #![deny(unreachable_pub)] #![cfg_attr(test, deny(warnings))] +#![doc(html_root_url = "https://docs.rs/tracing-opentelemetry/0.5.0")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] /// Implementation of the trace::Layer as a source of OpenTelemetry data. mod layer; diff --git a/tracing-serde/src/lib.rs b/tracing-serde/src/lib.rs index 7e143d6445..9b4cc70f58 100644 --- a/tracing-serde/src/lib.rs +++ b/tracing-serde/src/lib.rs @@ -1,3 +1,8 @@ +#![doc(html_root_url = "https://docs.rs/tracing-serde/0.1.1")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![warn( missing_debug_implementations, // missing_docs, // TODO: add documentation diff --git a/tracing-subscriber/src/lib.rs b/tracing-subscriber/src/lib.rs index 268359bef9..5a3ec13239 100644 --- a/tracing-subscriber/src/lib.rs +++ b/tracing-subscriber/src/lib.rs @@ -50,6 +50,10 @@ //! [`parking_lot`]: https://crates.io/crates/parking_lot //! [`registry`]: registry/index.html #![doc(html_root_url = "https://docs.rs/tracing-subscriber/0.2.8")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![cfg_attr(docsrs, feature(doc_cfg))] #![warn( missing_debug_implementations, diff --git a/tracing-tower/src/lib.rs b/tracing-tower/src/lib.rs index e2e22083c3..b1905efa3d 100644 --- a/tracing-tower/src/lib.rs +++ b/tracing-tower/src/lib.rs @@ -1,4 +1,8 @@ #![cfg_attr(docsrs, feature(doc_cfg))] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![warn( missing_debug_implementations, // missing_docs, // TODO: add documentation! diff --git a/tracing/src/lib.rs b/tracing/src/lib.rs index 7b31d6880e..ad7d3d50d0 100644 --- a/tracing/src/lib.rs +++ b/tracing/src/lib.rs @@ -795,6 +795,10 @@ #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(docsrs, feature(doc_cfg))] #![doc(html_root_url = "https://docs.rs/tracing/0.1.16")] +#![doc( + html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo.svg", + issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/" +)] #![warn( missing_debug_implementations, missing_docs,