tracing: revert "make valueset macro sanitary"
#3425
Merged
+44
−15
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
The change merged in #3382 caused a breaking change when released. This is because users of the tracing macros depend on being able to use a bare `debug` or `display` function within the macro itself, for example: ```rust tracing::info!(foo = debug(foo), bar = display(bar)); ``` This change reverts the breaking part of the original commit, which is removing the import statement from the `valueset!` macro. However, it leaves the change to use full module paths inside the macro. E.g. `$crate::field::debug`. This is best practice, and so worth keeping. This change also adds a nice warning comment above the import statement to try and avoid another break happening in the future (because this isn't the first time that this has happened). It also adds explicit tests for the use of bare `debug` and `display` usage with the same end.
hds
force-pushed
the
hds/revert-valueset-macro-sanitary
branch
from
2dbac6e to
206944a
Compare
djc
approved these changes
Nov 27, 2025
hds
added a commit
that referenced
this pull request
Nov 27, 2025
# 0.1.43 (November 28, 2025) #### Important The previous release [0.1.42] was yanked because [#3382] was a breaking change. See further details in [#3424]. This release contains all the changes from that version, plus a revert for the problematic part of the breaking PR. ### Fixed - Revert "make `valueset` macro sanitary" ([#3425]) [#3382]: #3382 [#3424]: #3424 [#3425]: #3425 [0.1.42]: https://github.com/tokio-rs/tracing/releases/tag/tracing-0.1.42
hds
added a commit
that referenced
this pull request
Nov 28, 2025
# 0.1.43 (November 28, 2025) #### Important The previous release [0.1.42] was yanked because [#3382] was a breaking change. See further details in [#3424]. This release contains all the changes from that version, plus a revert for the problematic part of the breaking PR. ### Fixed - Revert "make `valueset` macro sanitary" ([#3425]) [#3382]: #3382 [#3424]: #3424 [#3425]: #3425 [0.1.42]: https://github.com/tokio-rs/tracing/releases/tag/tracing-0.1.42
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.
Motivation
The change merged in #3382 caused a breaking change when released. This
is because users of the tracing macros depend on being able to use a
bare
debugordisplayfunction within the macro itself, for example:Solution
This change reverts the breaking part of the original commit, which is
removing the import statement from the
valueset!macro. However, itleaves the change to use full module paths inside the macro. E.g.
$crate::field::debug. This is best practice, and so worth keeping.This change also adds a nice warning comment above the import statement
to try and avoid another break happening in the future (because this
isn't the first time that this has happened). It also adds explicit
tests for the use of bare
debuganddisplayusage with the same end.