Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

finish doc_cfg for tracing-tower and tracing-log #537

Merged
merged 3 commits into from
Jan 15, 2020
Merged

Conversation

yaahc
Copy link
Collaborator

@yaahc yaahc commented Jan 11, 2020

Closes #440

this should be the last of them

@yaahc yaahc requested a review from hawkw January 13, 2020 18:28
Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this PR doesn't add the Cargo metadata that tells docs.rs to pass the docsrs config when building, so crates.io releases of these crates won't get the doc-cfg feature enabled. Can I get you to add

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]

to the Cargo.toml files for tracing-log and tracing-tower? Then, I think, this should be good to merge!

Thanks again for working on this!

@yaahc
Copy link
Collaborator Author

yaahc commented Jan 13, 2020

Done and my pleasure

Copy link
Member

@hawkw hawkw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome, lgtm! since this is the last doc_cfg PR, can we add "Closes #440" to the commit message before merging?

@yaahc
Copy link
Collaborator Author

yaahc commented Jan 13, 2020

I updated the original PR comment body, that should do it right @hawkw ?

@hawkw
Copy link
Member

hawkw commented Jan 13, 2020

I updated the original PR comment body, that should do it right @hawkw ?

Yup, looks good to me. It looks like CI is stuck, though. Possibly GitHub Actions is down?

@hawkw
Copy link
Member

hawkw commented Jan 14, 2020

@yaahc It looks like GitHub Actions is stuck for this branch, either the build was never started or its status was never reported. One way to trigger a new build when GitHub Actions gets stuck is to push a new empty commit, like

$ git commit --allow-empty -m "re-trigger CI" && git push

Can I get you to do that please? Thanks!

@hawkw hawkw merged commit dee99ac into tokio-rs:master Jan 15, 2020
hawkw added a commit that referenced this pull request Feb 19, 2021
Added

- Re-export the `log` crate so that users can ensure consistent versions
  ([#602])
- `AsLog` implementation for `tracing::LevelFilter` ([#1248])
- `AsTrace` implementation for `log::LevelFilter` ([#1248])

Fixed

- **log-tracer**: Fixed `Log::enabled` implementation for `LogTracer`
  not calling `Subscriber::enabled` ([#1254])
- **log-tracer**: Fixed `Log::enabled` implementation for `LogTracer`
  not checking the max level hint ([#1247])
- Several documentation fixes ([#483], [#485], [#537], [#595], [#941],
  [#981])

[#483]: https://github.com/tokio-rs/tracing/pulls/483
[#485]: https://github.com/tokio-rs/tracing/pulls/485
[#537]: https://github.com/tokio-rs/tracing/pulls/537
[#595]: https://github.com/tokio-rs/tracing/pulls/595
[#605]: https://github.com/tokio-rs/tracing/pulls/604
[#941]: https://github.com/tokio-rs/tracing/pulls/941
[#1247]: https://github.com/tokio-rs/tracing/pulls/1247
[#1248]: https://github.com/tokio-rs/tracing/pulls/1248
[#1254]: https://github.com/tokio-rs/tracing/pulls/1254

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
kaffarell pushed a commit to kaffarell/tracing that referenced this pull request May 22, 2024
Added

- Re-export the `log` crate so that users can ensure consistent versions
  ([tokio-rs#602])
- `AsLog` implementation for `tracing::LevelFilter` ([tokio-rs#1248])
- `AsTrace` implementation for `log::LevelFilter` ([tokio-rs#1248])

Fixed

- **log-tracer**: Fixed `Log::enabled` implementation for `LogTracer`
  not calling `Subscriber::enabled` ([tokio-rs#1254])
- **log-tracer**: Fixed `Log::enabled` implementation for `LogTracer`
  not checking the max level hint ([tokio-rs#1247])
- Several documentation fixes ([tokio-rs#483], [tokio-rs#485], [tokio-rs#537], [tokio-rs#595], [tokio-rs#941],
  [tokio-rs#981])

[tokio-rs#483]: https://github.com/tokio-rs/tracing/pulls/483
[tokio-rs#485]: https://github.com/tokio-rs/tracing/pulls/485
[tokio-rs#537]: https://github.com/tokio-rs/tracing/pulls/537
[tokio-rs#595]: https://github.com/tokio-rs/tracing/pulls/595
[tokio-rs#605]: https://github.com/tokio-rs/tracing/pulls/604
[tokio-rs#941]: https://github.com/tokio-rs/tracing/pulls/941
[tokio-rs#1247]: https://github.com/tokio-rs/tracing/pulls/1247
[tokio-rs#1248]: https://github.com/tokio-rs/tracing/pulls/1248
[tokio-rs#1254]: https://github.com/tokio-rs/tracing/pulls/1254

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: enable feature(doc_cfg) when on nightly
2 participants