Include debug_metadata/*.natvis in the published crate to fix debugger_visualizer/docs.rs build#417
Open
teddytennant wants to merge 1 commit into
Open
Include debug_metadata/*.natvis in the published crate to fix debugger_visualizer/docs.rs build#417teddytennant wants to merge 1 commit into
teddytennant wants to merge 1 commit into
Conversation
The include allow-list added in servo#397 omitted debug_metadata/smallvec.natvis, which src/lib.rs references via debugger_visualizer(natvis_file = ...). As a result the published crate fails to compile whenever the debugger_visualizer feature is enabled (including docs.rs, which builds with --all-features on nightly) with "couldn't read src/../debug_metadata/smallvec.natvis". Ship the file so both docs.rs and downstream users of the feature build again.
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
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.
What
Add
debug_metadata/*.natvisto theincludeallow-list inCargo.tomlso the natvis debugger-visualizer file is shipped in the published crate.Why
Fixes #415.
The
includeallow-list added in #397 (to keep dev scripts out of the package) omitteddebug_metadata/smallvec.natvis. Butsrc/lib.rsreferences that file:Because the file is no longer packaged, the published 1.15.2 crate fails to compile whenever the
debugger_visualizerfeature is enabled:This is why the docs.rs build for 1.15.2 is red (docs.rs builds with
--all-featureson nightly), and it also breaks any downstream crate that enables the feature. Shipping the file fixes both, rather than just dropping the feature from docs.rs metadata. The tightdebug_metadata/*.natvisglob keeps unrelated dev files out, consistent with #397's intent.Testing
Metadata/packaging fix, so verified via
cargo package:cargo package --listnow listsdebug_metadata/smallvec.natvis(previously absent).cd target/package/smallvec-1.15.2 && cargo +nightly build --features debugger_visualizerfails with thecouldn't read ...smallvec.natviserror above.cargo testpasses (no source change);cargo +nightly test --test debugger_visualizer --features debugger_visualizercompiles against the natvis file and passes.