Skip to content

Commit 192add3

Browse files
Add documentation on required tools to run visualizer tests locally.
1 parent 1540fe5 commit 192add3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

debug_metadata/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,15 @@ fn test() {
8787
In the example above, the second expected statement uses pattern matching through a regular expression
8888
by using the `pattern:` prefix.
8989

90+
#### Testing Locally
91+
92+
Currently, only Natvis visualizations have been defined for the `regex` crate via `debug_metadata/regex.natvis`,
93+
which means the `tests/test_visualizer.rs` tests need to be run on Windows using the `*-pc-windows-msvc` targets.
94+
To run these tests locally, first ensure the debugging tools for Windows are installed or install them following
95+
the steps listed here, [Debugging Tools for Windows](https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/).
96+
Once the debugging tools have been installed, the tests can be run in the same manner as they are in the CI
97+
pipeline.
98+
9099
#### Note
91100

92101
When running the debugger visualizer tests, `tests/test_visualizer.rs`, they need to be run consecutively

0 commit comments

Comments
 (0)