From a1871b148005886dba780cb3165d051bf43f17ce Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Wed, 13 Mar 2019 10:29:27 -0700 Subject: [PATCH] Prepare `tokio-trace-core` for initial release. (#979) --- tokio-trace/tokio-trace-core/CHANGELOG.md | 3 +++ tokio-trace/tokio-trace-core/Cargo.toml | 13 +++++++++---- tokio-trace/tokio-trace-core/README.md | 22 +++++++++++----------- tokio-trace/tokio-trace-core/src/lib.rs | 1 + 4 files changed, 24 insertions(+), 15 deletions(-) create mode 100644 tokio-trace/tokio-trace-core/CHANGELOG.md diff --git a/tokio-trace/tokio-trace-core/CHANGELOG.md b/tokio-trace/tokio-trace-core/CHANGELOG.md new file mode 100644 index 000000000..e7362846a --- /dev/null +++ b/tokio-trace/tokio-trace-core/CHANGELOG.md @@ -0,0 +1,3 @@ +# 0.1.0 (March 13, 2019) + +- Initial release diff --git a/tokio-trace/tokio-trace-core/Cargo.toml b/tokio-trace/tokio-trace-core/Cargo.toml index 7c36498f0..391e47884 100644 --- a/tokio-trace/tokio-trace-core/Cargo.toml +++ b/tokio-trace/tokio-trace-core/Cargo.toml @@ -1,18 +1,23 @@ [package] name = "tokio-trace-core" +# When releasing to crates.io: +# - Update html_root_url. +# - Update doc url +# - Cargo.toml +# - README.md +# - Update CHANGELOG.md. +# - Create "v0.1.x" git tag. version = "0.1.0" -authors = ["Eliza Weisman "] +authors = ["Tokio Contributors "] license = "MIT" repository = "https://github.com/tokio-rs/tokio" homepage = "https://tokio.rs" +documentation = "https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core" description = """ Core primitives for tokio-trace. """ categories = ["development-tools::debugging"] keywords = ["logging", "tracing"] -# Not yet ready for production. -publish = false - [dependencies] lazy_static = "1.0.0" diff --git a/tokio-trace/tokio-trace-core/README.md b/tokio-trace/tokio-trace-core/README.md index 6b49b372c..60c5f1a54 100644 --- a/tokio-trace/tokio-trace-core/README.md +++ b/tokio-trace/tokio-trace-core/README.md @@ -2,7 +2,7 @@ Core primitives for `tokio-trace`. -[Documentation](https://tokio-rs.github.io/tokio/doc/tokio_trace_core/index.html) +[Documentation](https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/index.html) ## Overview @@ -34,16 +34,16 @@ API. However, this crate's API will change very infrequently, so it may be used when dependencies must be very stable. [`tokio-trace`]: ../ -[`Span`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/span/struct.Span.html -[`Event`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/event/struct.Event.html -[`Subscriber`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/subscriber/trait.Subscriber.html -[`Metadata`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/metadata/struct.Metadata.html -[`Callsite`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/callsite/trait.Callsite.html -[`Field`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/field/struct.Field.html -[`FieldSet`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/field/struct.FieldSet.html -[`Value`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/field/trait.Value.html -[`ValueSet`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/field/struct.ValueSet.html -[`Dispatch`]: https://tokio-rs.github.io/tokio/doc/tokio_trace_core/dispatcher/struct.Dispatch.html +[`Span`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/span/struct.Span.html +[`Event`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/event/struct.Event.html +[`Subscriber`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/subscriber/trait.Subscriber.html +[`Metadata`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/metadata/struct.Metadata.html +[`Callsite`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/callsite/trait.Callsite.html +[`Field`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/field/struct.Field.html +[`FieldSet`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/field/struct.FieldSet.html +[`Value`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/field/trait.Value.html +[`ValueSet`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/field/struct.ValueSet.html +[`Dispatch`]: https://docs.rs/tokio-trace-core/0.1.0/tokio_trace_core/dispatcher/struct.Dispatch.html ## License diff --git a/tokio-trace/tokio-trace-core/src/lib.rs b/tokio-trace/tokio-trace-core/src/lib.rs index 6d58980f7..5538b94a2 100644 --- a/tokio-trace/tokio-trace-core/src/lib.rs +++ b/tokio-trace/tokio-trace-core/src/lib.rs @@ -1,3 +1,4 @@ +#![doc(html_root_url = "https://docs.rs/tokio-trace-core/0.1.0")] #![deny(missing_debug_implementations, missing_docs, unreachable_pub)] #![cfg_attr(test, deny(warnings))]