summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEliza Weisman <eliza@buoyant.io>2019-02-22 11:07:53 -0800
committerGitHub <noreply@github.com>2019-02-22 11:07:53 -0800
commit02a50918851b5789ddbf0a394470689b1761f364 (patch)
treea68234e2fd1b6dad44673253e36759175e4866bd
parent80162306e71c8561873a9c9496d65f2c1387d119 (diff)
trace: Minor doc improvements (#913)
This branch adds links to the master RustDoc published by CI to the `tokio-trace` and `tokio-trace-core` README. In addition, it fixes a broken links in the RustDoc for `tokio-trace` and updates the `tokio-trace-core` RustDoc to match the README. Signed-off-by: Eliza Weisman <eliza@buoyant.io>
-rw-r--r--tokio-trace/README.md3
-rw-r--r--tokio-trace/src/lib.rs2
-rw-r--r--tokio-trace/tokio-trace-core/README.md26
-rw-r--r--tokio-trace/tokio-trace-core/src/lib.rs30
4 files changed, 43 insertions, 18 deletions
diff --git a/tokio-trace/README.md b/tokio-trace/README.md
index a2190514..ca553ca6 100644
--- a/tokio-trace/README.md
+++ b/tokio-trace/README.md
@@ -2,6 +2,8 @@
A scoped, structured logging and diagnostics system.
+[Documentation](https://tokio-rs.github.io/tokio/tokio_trace/index.html)
+
## Overview
`tokio-trace` is a framework for instrumenting Rust programs to collect
@@ -156,6 +158,7 @@ be used with the `tokio-trace` ecosystem. It includes a collection of
`Subscriber` implementations, as well as utility and adapter crates.
[`log`]: https://docs.rs/log/0.4.6/log/
+[`tokio-trace-nursery`]: https://github.com/tokio-rs/tokio-trace-nursery
## License
diff --git a/tokio-trace/src/lib.rs b/tokio-trace/src/lib.rs
index 631d0e3b..84c9ff56 100644
--- a/tokio-trace/src/lib.rs
+++ b/tokio-trace/src/lib.rs
@@ -292,7 +292,7 @@
//! [`exit`]: subscriber/trait.Subscriber.html#tymethod.exit
//! [`enabled`]: subscriber/trait.Subscriber.html#tymethod.enabled
//! [metadata]: struct.Metadata.html
-//! [`tokio-trace-nursury`]: https://github.com/tokio-rs/tokio-trace-nursery
+//! [`tokio-trace-nursery`]: https://github.com/tokio-rs/tokio-trace-nursery
extern crate tokio_trace_core;
// Somehow this `use` statement is necessary for us to re-export the `core`
diff --git a/tokio-trace/tokio-trace-core/README.md b/tokio-trace/tokio-trace-core/README.md
index 9fab7429..3bc117b1 100644
--- a/tokio-trace/tokio-trace-core/README.md
+++ b/tokio-trace/tokio-trace-core/README.md
@@ -2,6 +2,8 @@
Core primitives for `tokio-trace`.
+[Documentation](https://tokio-rs.github.io/tokio/tokio_trace_core/index.html)
+
## Overview
`tokio-trace` is a framework for instrumenting Rust programs to collect
@@ -10,16 +12,18 @@ primitives of `tokio-trace`.
The crate provides:
-* `Span` identifies a span within the execution of a program.
+* [`Span`] identifies a span within the execution of a program.
+
+* [`Event`] represents a single event within a trace.
-* `Subscriber`, the trait implemented to collect trace data.
+* [`Subscriber`], the trait implemented to collect trace data.
-* `Metadata` and `Callsite` provide information describing `Span`s.
+* [`Metadata`] and [`Callsite`] provide information describing `Span`s.
-* `Field` and `FieldSet` describe and access the structured data attached to a
- `Span`.
+* [`Field`], [`FieldSet`], [`Value`], and [`ValueSet`] represent the
+ structured data attached to a `Span`.
-* `Dispatch` allows span events to be dispatched to `Subscriber`s.
+* [`Dispatch`] allows span events to be dispatched to `Subscriber`s.
In addition, it defines the global callsite registry and per-thread current
dispatcher which other components of the tracing system rely on.
@@ -30,6 +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/tokio_trace_core/span/struct.Span.html
+[`Event`]: https://tokio-rs.github.io/tokio/tokio_trace_core/event/struct.Event.html
+[`Subscriber`]: https://tokio-rs.github.io/tokio/tokio_trace_core/subscriber/trait.Subscriber.html
+[`Metadata`]: https://tokio-rs.github.io/tokio/tokio_trace_core/metadata/struct.Metadata.html
+[`Callsite`]: https://tokio-rs.github.io/tokio/tokio_trace_core/callsite/trait.Callsite.html
+[`Field`]: https://tokio-rs.github.io/tokio/tokio_trace_core/field/struct.Field.html
+[`FieldSet`]: https://tokio-rs.github.io/tokio/tokio_trace_core/field/struct.FieldSet.html
+[`Value`]: https://tokio-rs.github.io/tokio/tokio_trace_core/field/trait.Value.html
+[`ValueSet`]: https://tokio-rs.github.io/tokio/tokio_trace_core/field/struct.ValueSet.html
+[`Dispatch`]: https://tokio-rs.github.io/tokio/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 965aaea2..ab9c4b7c 100644
--- a/tokio-trace/tokio-trace-core/src/lib.rs
+++ b/tokio-trace/tokio-trace-core/src/lib.rs
@@ -7,16 +7,18 @@
//! structured, event-based diagnostic information. This crate defines the core
//! primitives of `tokio-trace`.
//!
-//! The crate provides:
+//! This crate provides:
//!
//! * [`Span`] identifies a span within the execution of a program.
//!
+//! * [`Event`] represents a single event within a trace.
+//!
//! * [`Subscriber`], the trait implemented to collect trace data.
//!
//! * [`Metadata`] and [`Callsite`] provide information describing `Span`s.
//!
-//! * [`Field`] and [`FieldSet`] describe and access the structured data attached to
-//! a `Span`.
+//! * [`Field`], [`FieldSet`], [`Value`], and [`ValueSet`] represent the
+//! structured data attached to a `Span`.
//!
//! * [`Dispatch`] allows span events to be dispatched to `Subscriber`s.
//!
@@ -28,15 +30,21 @@
//! fully-featured API. However, this crate's API will change very infrequently,
//! so it may be used when dependencies must be very stable.
//!
-//! [`Span`]: ::span::Span
-//! [`Subscriber`]: ::subscriber::Subscriber
-//! [`Metadata`]: ::metadata::Metadata
-//! [`Callsite`]: ::callsite::Callsite
-//! [`Field`]: ::field::Field
-//! [`FieldSet`]: ::field::FieldSet
-//! [`Dispatch`]: ::dispatcher::Dispatch
+//! The [`tokio-trace-nursery`] repository contains less stable crates designed to
+//! be used with the `tokio-trace` ecosystem. It includes a collection of
+//! `Subscriber` implementations, as well as utility and adapter crates.
//!
-
+//! [`Span`]: span/struct.Span.html
+//! [`Event`]: event/struct.Event.html
+//! [`Subscriber`]: subscriber/trait.Subscriber.html
+//! [`Metadata`]: metadata/struct.Metadata.html
+//! [`Callsite`]: callsite/trait.Callsite.html
+//! [`Field`]: field/struct.Field.html
+//! [`FieldSet`]: field/struct.FieldSet.html
+//! [`Value`]: field/trait.Value.html
+//! [`ValueSet`]: field/struct.ValueSet.html
+//! [`Dispatch`]: dispatcher/struct.Dispatch.html
+//! [`tokio-trace-nursery`]: https://github.com/tokio-rs/tokio-trace-nursery
#[macro_use]
extern crate lazy_static;