Skip to content

Commit 78b05d0

Browse files
author
Albin Stjerna
committed
Add a section about testing to the Polonius book
1 parent c0dea8e commit 78b05d0

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@
77
- [Rules](./rules.md)
88
- [Atoms](./rules/atoms.md)
99
- [Initialization](./rules/initialization.md)
10+
- [Testing Polonius](./testing.md)
1011
- [See also](./see_also.md)

book/src/testing.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Testing Polonius
2+
3+
## Rust UI Tests with Polonius Compare Mode
4+
5+
There is a mode of the Rust test suite that compares Polonius' output to the
6+
current NLL one. You can invoke it by using `--compare-mode polonius`. For
7+
example, the following will run the UI tests:
8+
9+
```
10+
$ ./x.py test -i --stage 1 --compare-mode polonius src/test/ui
11+
```
12+
13+
## Polonius' Own Unit Test
14+
15+
(Not yet written, but this section should describe how to use `polonius-parser`
16+
to generate input for unit tests.)

0 commit comments

Comments
 (0)