fix: prefix macro calls with ::core to avoid clashing with local macros #3024
Conversation
This file contains 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
This commit fixes a bug where a macro call to macros defined in the standard lib from the `tracing` and `tracing-core` crates could be resolved to a local macro with the same name, causing a compilation error. This commit prefixes these calls with `::core::` to ensure that they are resolved to the standard library macros. Fixes: <tokio-rs#3023>
joshka
requested review from
hawkw,
carllerche,
davidbarsky and
a team
as code owners
This ensures that the tracing lib correctly builds when a crate is named `core`. See tokio-rs#2761 and tokio-rs#2762 for more info.
|
Wow, that's an interesting problem -
Addressed in 5960e0a by adding these to the __macro_support in tracing / tracing_core. I didn't change all the occurrences of |
|
ping |
|
Can this also be backported to the 0.1 branch please? (Happy to add another PR for that if needed) |
davidbarsky
approved these changes
Jul 24, 2024
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
This commit fixes a bug where a macro call to macros defined in the
standard lib from the
tracingandtracing-corecrates could beresolved to a local macro with the same name, causing a compilation
error.
Solution
This commit prefixes these calls with
::core::to ensure thatthey are resolved to the standard library macros.
Fixes: #3023
While this fixes the specific issue at hand, there's likely many macro calls that are impacted by this problem - specifically every call to module_path (there are many). I haven't updated all of those places as I was unsure if that was a good idea as there's about 220 calls of that macro. I also haven't checked for other macros that would also be problematic.