mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-02 07:20:35 +00:00

History

docs: consistent MSRV docs & policy explanation (#941 )

## Motivation

PR #934 fixed a bug in the CI configuration where MSRV checks were not
being run correctly. After this was fixed, it was necessary to bump the
MSRV to 1.40.0, as the tests were no longer actually passing on 1.39,
because some dependencies no longer support it.

While updating the documentation to indicate that the new MSRV is 1.40,
I noticed that the note on the MSRV was located inconsistently in the
READMEs and `lib.rs` documentation of various crates, and missing
entirely in some cases. Additionally, there have been some questions on
what our MSRV _policies_ are, and whether MSRV bumps are considered
breaking changes (see e.g. #936). 

## Solution

I've updated all the MSRV notes in the documentation and READMEs to
indicate that the MSRV is 1.40. I've also ensured that the MSRV note is
in the same place for every crate (at the end of the "Overview" section
in the docs), and that it's formatted consistently.

Furthermore, I added a new section to the READMEs and `lib.rs` docs
explaining the current MSRV policy in some detail. Hopefully, this
should answer questions like #936 in the future. The MSRV note in the
overview section includes a link to the section with further details.

Finally, while doing this, I noticed a couple of crates
(`tracing-journald` and `tracing-serde`) were missing top-level `lib.rs`
docs. Rather than just adding an MSRV note and nothing else, I went
ahead and fixed this using documentation from those crate's READMEs.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>

2020-08-18 12:11:16 -07:00

src

docs: consistent MSRV docs & policy explanation (#941 )

2020-08-18 12:11:16 -07:00

tests

log: Re-export the log crate from tracing-log (#602 )

2020-02-26 16:47:55 -08:00

Cargo.toml

chore(deps): update env_logger dependency (#794 )

2020-07-10 09:03:15 -07:00

CHANGELOG.md

log: prepare to release 0.1.1 (#413 )

2019-10-29 12:59:15 -07:00

LICENSE

chore: Include the LICENSE in every crate (#842 )

2020-07-23 12:23:04 -07:00

README.md

docs: consistent MSRV docs & policy explanation (#941 )

2020-08-18 12:11:16 -07:00

README.md

tracing-log

log compatibility for tracing.

Documentation | Chat (discord)

Overview

tracing is a framework for instrumenting Rust programs with context-aware, structured, event-based diagnostic information. This crate provides compatibility layers for using tracing alongside the logging facade provided by the log crate.

This crate provides:

AsTrace and AsLog traits for converting between tracing and log types.
LogTracer, a log::Log implementation that consumes log::Records and outputs them as tracing::Events.
An [env_logger] module, with helpers for using the [env_logger crate] with tracing (optional, enabled by the env_logger feature).

Compiler support: requires rustc 1.40+

Supported Rust Versions

Tracing is built against the latest stable release. The minimum supported version is 1.40. The current Tracing version is not guaranteed to build on Rust versions earlier than the minimum supported version.

Tracing follows the same compiler support policies as the rest of the Tokio project. The current stable Rust compiler and the three most recent minor versions before it will always be supported. For example, if the current stable compiler version is 1.45, the minimum supported version will not be increased past 1.42, three minor versions prior. Increasing the minimum supported compiler version is not considered a semver breaking change as long as doing so complies with this policy.

License

This project is licensed under the MIT license.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Tracing by you, shall be licensed as MIT, without any additional terms or conditions.