From f8b52bdf104399b810da65dc396ba29cef835ef0 Mon Sep 17 00:00:00 2001 From: Zeki Sherif <9832640+zekisherif@users.noreply.github.com> Date: Tue, 5 May 2020 13:19:36 -0400 Subject: [PATCH] appender: prepare tracing-appender for release (#705) Following the release process for https://github.com/tokio-rs/tracing/blob/master/CONTRIBUTING.md and these changes are the only things left to commit before release. I'd like to hopefully get this released today so we can start using this crate internally. Note: I need to get PR #703 and PR #678 merged before release. Co-authored-by: Zeki Sherif Co-authored-by: Eliza Weisman --- tracing-appender/CHANGELOG.md | 3 +++ tracing-appender/Cargo.toml | 18 ++++++++++++++---- tracing-appender/src/lib.rs | 23 +++++++++++++++++++++++ 3 files changed, 40 insertions(+), 4 deletions(-) create mode 100644 tracing-appender/CHANGELOG.md diff --git a/tracing-appender/CHANGELOG.md b/tracing-appender/CHANGELOG.md new file mode 100644 index 0000000000..26ddfd3ebb --- /dev/null +++ b/tracing-appender/CHANGELOG.md @@ -0,0 +1,3 @@ +# 0.1.0 (May 5, 2020) + +- Initial release \ No newline at end of file diff --git a/tracing-appender/Cargo.toml b/tracing-appender/Cargo.toml index fc40923fb9..e8434e2630 100644 --- a/tracing-appender/Cargo.toml +++ b/tracing-appender/Cargo.toml @@ -1,13 +1,23 @@ [package] name = "tracing-appender" version = "0.1.0" -authors = ["Zeki Sherif "] -edition = "2018" +authors = [ + "Zeki Sherif ", + "Tokio Contributors " +] +license = "MIT" +readme = "README.md" repository = "https://github.com/tokio-rs/tracing" homepage = "https://tokio.rs" description = """ -Provides an `appender` that writes to a file +Provides utilities for file appenders and making non-blocking writers. """ +categories = [ + "development-tools::debugging", + "asynchronous", +] +keywords = ["logging", "tracing", "file-appender", "non-blocking-writer"] +edition = "2018" [dependencies] tracing-subscriber = {path = "../tracing-subscriber", version = "0.2.4"} @@ -16,4 +26,4 @@ chrono = "0.4.11" [dev-dependencies] tracing = { path = "../tracing", version = "0.1" } -tempdir = "0.3" \ No newline at end of file +tempdir = "0.3" diff --git a/tracing-appender/src/lib.rs b/tracing-appender/src/lib.rs index 4c057c355e..0ee663f120 100644 --- a/tracing-appender/src/lib.rs +++ b/tracing-appender/src/lib.rs @@ -104,6 +104,29 @@ //! .init(); //! # } //! ``` +#![doc(html_root_url = "https://docs.rs/tracing-appender/0.1.0")] +#![warn( + missing_debug_implementations, + missing_docs, + rust_2018_idioms, + unreachable_pub, + bad_style, + const_err, + dead_code, + improper_ctypes, + non_shorthand_field_patterns, + no_mangle_generic_items, + overflowing_literals, + path_statements, + patterns_in_fns_without_body, + private_in_public, + unconditional_recursion, + unused, + unused_allocation, + unused_comparisons, + unused_parens, + while_true +)] use crate::non_blocking::{NonBlocking, WorkerGuard}; use std::io::Write;