mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove outdated references to `-Z dump-mir-spanview` 

This flag was removed by <https://github.com/rust-lang/rust/pull/119566>.
This commit is contained in:
Zalathar 2024-01-16 17:16:22 +11:00 committed by Tshepang Mbambo
parent ca6139dd0d
commit 7650a97c11
3 changed files with 3 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/compiler-debugging.md
View File

@ -241,24 +241,6 @@ $ dot -T pdf maybe_init_suffix.dot > maybe_init_suffix.pdf
$ firefox maybe_init_suffix.pdf # Or your favorite pdf viewer
```
## Viewing Spanview output (.html files)
[viewing-spanview-output]: #viewing-spanview-output
In addition to [graphviz output](#formatting-graphviz-output-dot-files), MIR debugging
flags include an option to generate a MIR representation called `Spanview` that
uses HTML to highlight code regions in the original source code and display
compiler metadata associated with each region.
[`-Z dump-mir-spanview`](./mir/debugging.md), for example, highlights spans
associated with each MIR `Statement`, `Terminator`, and/or `BasicBlock`.
These `.html` files use CSS features to dynamically expand spans obscured by
overlapping spans, and native tooltips (based on the HTML `title` attribute) to
reveal the actual MIR elements, as text.
To view these files, simply use a modern browser, or a CSS-capable HTML preview
feature in a modern IDE. (The default HTML preview pane in *VS Code* is known to
work, for instance.)
## Narrowing (Bisecting) Regressions
The [cargo-bisect-rustc][bisect] tool can be used as a quick and easy way to

5
src/mir/debugging.md
View File

@ -8,11 +8,6 @@ additional output formats, including:
control-flow graph
* `-Z dump-mir-dataflow` - dumps a `.dot` file showing the [dataflow state] at
each point in the control-flow graph
* `-Z dump-mir-spanview` - dumps an `.html` file that highlights the source
spans associated with MIR elements (including mouse-over actions to reveal
elements obscured by overlaps, and tooltips to view the MIR statements).
This flag takes an optional value: `statement` (the default), `terminator`, or
`block`, to generate span highlights with different levels of granularity.
`-Z dump-mir=F` is a handy compiler option that will let you view the MIR for
each function at each stage of compilation. `-Z dump-mir` takes a **filter** `F`

6
src/tests/compiletest.md
View File

@ -354,9 +354,9 @@ There are several forms the `EMIT_MIR` comment can take:
This is useful if you want to see how an optimization changes the MIR.
* `// EMIT_MIR $MIR_PATH.dot` or `$MIR_PATH.html` — These are special cases
for other MIR outputs (via `-Z dump-mir-graphviz` and `-Z dump-mir-spanview`)
that will check that the output matches the given file.
* `// EMIT_MIR $MIR_PATH.dot` — When using specific flags that dump additional
MIR data (e.g. `-Z dump-mir-graphviz` to produce `.dot` files), this will
check that the output matches the given file.
By default 32 bit and 64 bit targets use the same dump files, which can be
problematic in the presence of pointers in constants or other bit width