Remove tracing re-export from bevy_utils
#17161
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bushrat011899
added
D-Trivial
BenjaminBrienen
approved these changes
Jan 5, 2025
As @mockersf pointed out to me, the challenge with workspace dependencies is that the features must be shared across all users of the crate. That might be appropriate for tracing, but it's something we should consider (and write down). |
alice-i-cecile
added
S-Ready-For-Final-Review
bushrat011899
added
S-Needs-Review
alice-i-cecile
added
S-Ready-For-Final-Review
BenjaminBrienen
approved these changes
Jan 5, 2025
cBournhonesque
approved these changes
Jan 5, 2025
This was referenced Jan 6, 2025
mrchantey
pushed a commit
to mrchantey/bevy
that referenced
this pull request
Feb 4, 2025
# Objective - Contributes to bevyengine#11478 ## Solution - Made `bevy_utils::tracing` `doc(hidden)` - Re-exported `tracing` from `bevy_log` for end-users - Added `tracing` directly to crates that need it. ## Testing - CI --- ## Migration Guide If you were importing `tracing` via `bevy::utils::tracing`, instead use `bevy::log::tracing`. Note that many items within `tracing` are also directly re-exported from `bevy::log` as well, so you may only need `bevy::log` for the most common items (e.g., `warn!`, `trace!`, etc.). This also applies to the `log_once!` family of macros. ## Notes - While this doesn't reduce the line-count in `bevy_utils`, it further decouples the internal crates from `bevy_utils`, making its eventual removal more feasible in the future. - I have just imported `tracing` as we do for all dependencies. However, a workspace dependency may be more appropriate for version management.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Solution
bevy_utils::tracingdoc(hidden)tracingfrombevy_logfor end-userstracingdirectly to crates that need it.Testing
Migration Guide
If you were importing
tracingviabevy::utils::tracing, instead usebevy::log::tracing. Note that many items withintracingare also directly re-exported frombevy::logas well, so you may only needbevy::logfor the most common items (e.g.,warn!,trace!, etc.). This also applies to thelog_once!family of macros.Notes
bevy_utils, it further decouples the internal crates frombevy_utils, making its eventual removal more feasible in the future.tracingas we do for all dependencies. However, a workspace dependency may be more appropriate for version management.