Fix new rustc #[macro_export] warning in doctests
#3031
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #3031 +/- ##
==========================================
- Coverage 89.14% 89.13% -0.02%
==========================================
Files 118 118
Lines 97850 97850
Branches 97850 97850
==========================================
- Hits 87230 87214 -16
- Misses 8376 8386 +10
- Partials 2244 2250 +6 ☔ View full report in Codecov by Sentry. |
rustc now warns any time a `#[macro_export]` is used inside a
function as it generates surprising results. Because doctests are
run inside implicit test functions this means any use of
`#[macro_export]` inside a doctest will now warn. We do this in
`lightning-custom-message` to demonstrated how to use the crate,
which now fails to compile.
Here we fix this by adding an `fn main() {}` to the doctest, which
causes doctests to be compiled as freestanding code rather than
inside a test function.
Note that while discussing this upstream it came up that rustc is
also planning on changing the way doctests are compiled to compile
an entire crate's doctests in one go rather than in separate
crates, causing doctests to have a shared namespace which may
generate future surprising outcomes.
TheBlueMatt
force-pushed
the
2024-04-new-rustc-warning
branch
from
01cbfd6 to
c8ddf36
Compare
valentinewallace
approved these changes
Apr 30, 2024
TheBlueMatt
added a commit
to TheBlueMatt/rust-lightning
that referenced
this pull request
May 6, 2024
…rustc-warning Fix new rustc `#[macro_export]` warning in doctests
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.
rustc now warns any time a
#[macro_export]is used inside a function as it generates surprising results. Because doctests are run inside implicit test functions this means any use of#[macro_export]inside a doctest will now warn. We do this inlightning-custom-messageto demonstrated how to use the crate, which now fails to compile.Here we fix this by adding an
fn main() {}to the doctest, which causes doctests to be compiled as freestanding code rather than inside a test function.Note that while discussing this upstream it came up that rustc is also planning on changing the way doctests are compiled to compile an entire crate's doctests in one go rather than in separate crates, causing doctests to have a shared namespace which may generate future surprising outcomes.