diff options
| author | Nicholas Nethercote <n.nethercote@gmail.com> | 2025-04-16 08:57:15 +1000 |
|---|---|---|
| committer | Nicholas Nethercote <n.nethercote@gmail.com> | 2025-04-16 08:57:15 +1000 |
| commit | 62882f355e50f9af3ddb84661dfad0559848a3f5 (patch) | |
| tree | faa249bc1a08414732337d7e18781205c4dacedf | |
| parent | 766cd3a58320f2ec9e30573f39e377513f1a4443 (diff) | |
| download | rust-62882f355e50f9af3ddb84661dfad0559848a3f5.tar.gz rust-62882f355e50f9af3ddb84661dfad0559848a3f5.zip | |
Improve `borrowck_graphviz_*` documentation.
In particular, `borrowck_graphviz_preflow` no longer exists.
| -rw-r--r-- | src/doc/rustc-dev-guide/src/compiler-debugging.md | 3 | ||||
| -rw-r--r-- | tests/ui/mir-dataflow/README.md | 9 |
2 files changed, 2 insertions, 10 deletions
diff --git a/src/doc/rustc-dev-guide/src/compiler-debugging.md b/src/doc/rustc-dev-guide/src/compiler-debugging.md index 47f39762022..102e2020779 100644 --- a/src/doc/rustc-dev-guide/src/compiler-debugging.md +++ b/src/doc/rustc-dev-guide/src/compiler-debugging.md @@ -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: diff --git a/tests/ui/mir-dataflow/README.md b/tests/ui/mir-dataflow/README.md index a3ab14b23c7..886020226d0 100644 --- a/tests/ui/mir-dataflow/README.md +++ b/tests/ui/mir-dataflow/README.md @@ -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.) |