Skip to content

Commit 62882f3

Browse files
committed
Improve borrowck_graphviz_* documentation.
In particular, `borrowck_graphviz_preflow` no longer exists.
1 parent 766cd3a commit 62882f3

File tree

2 files changed

+2
-10
lines changed

2 files changed

+2
-10
lines changed

src/doc/rustc-dev-guide/src/compiler-debugging.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,8 @@ Right below you can find elaborate explainers on a selected few.
301301

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

306307
These all produce `.dot` files. To view these files, install graphviz (e.g.
307308
`apt-get install graphviz`) and then run the following commands:

tests/ui/mir-dataflow/README.md

-9
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,3 @@ each generated output path.
4242
on *entry* to each block, as well as the gen- and kill-sets that
4343
were so-called "transfer functions" summarizing the effect of each
4444
basic block.
45-
46-
* (In addition to the `borrowck_graphviz_postflow` attribute-key
47-
noted above, there is also `borrowck_graphviz_preflow`; it has the
48-
same interface and generates the same set of files, but it renders
49-
the dataflow state after building the gen- and kill-sets but
50-
*before* running the dataflow analysis itself, so each entry-set is
51-
just the initial default state for that dataflow analysis. This is
52-
less useful for understanding the error message output in these
53-
tests.)

0 commit comments

Comments
 (0)