Skip to content

borrowck_graphviz_* attribute tweaks #139886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 16, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Improve borrowck_graphviz_* documentation.
In particular, `borrowck_graphviz_preflow` no longer exists.
  • Loading branch information
nnethercote committed Apr 15, 2025
commit 62882f355e50f9af3ddb84661dfad0559848a3f5
3 changes: 2 additions & 1 deletion src/doc/rustc-dev-guide/src/compiler-debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,8 @@ Right below you can find elaborate explainers on a selected few.

Some compiler options for debugging specific features yield graphviz graphs -
e.g. the `#[rustc_mir(borrowck_graphviz_postflow="suffix.dot")]` attribute
dumps various borrow-checker dataflow graphs.
on a function dumps various borrow-checker dataflow graphs in conjunction with
`-Zdump-mir-dataflow`.

These all produce `.dot` files. To view these files, install graphviz (e.g.
`apt-get install graphviz`) and then run the following commands:
Expand Down
9 changes: 0 additions & 9 deletions tests/ui/mir-dataflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,3 @@ each generated output path.
on *entry* to each block, as well as the gen- and kill-sets that
were so-called "transfer functions" summarizing the effect of each
basic block.

* (In addition to the `borrowck_graphviz_postflow` attribute-key
noted above, there is also `borrowck_graphviz_preflow`; it has the
same interface and generates the same set of files, but it renders
the dataflow state after building the gen- and kill-sets but
*before* running the dataflow analysis itself, so each entry-set is
just the initial default state for that dataflow analysis. This is
less useful for understanding the error message output in these
tests.)
Loading