Skip to content

Commit

Permalink
Rollup merge of #100777 - pnkfelix:expand-codegen-tests-readme, r=TaK…
Browse files Browse the repository at this point in the history
…O8Ki

elaborate how revisions work with FileCheck stuff in src/test/codegen

elaborate how revisions work with FileCheck stuff in src/test/codegen
  • Loading branch information
matthiaskrgr authored Aug 20, 2022
2 parents 7f02896 + f47b61d commit 44894a7
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions src/test/codegen/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
The files here use the LLVM FileCheck framework, documented at
<https://llvm.org/docs/CommandGuide/FileCheck.html>.

One extension worth noting is the use of revisions as custom prefixes for
FileCheck. If your codegen test has different behavior based on the chosen
target or different compiler flags that you want to exercise, you can use a
revisions annotation, like so:

```rust
// revisions: aaa bbb
// [bbb] compile-flags: --flags-for-bbb
```

After specifying those variations, you can write different expected, or
explicitly *unexpected* output by using `<prefix>-SAME:` and `<prefix>-NOT:`,
like so:

```rust
// CHECK: expected code
// aaa-SAME: emitted-only-for-aaa
// aaa-NOT: emitted-only-for-bbb
// bbb-NOT: emitted-only-for-aaa
// bbb-SAME: emitted-only-for-bbb
```

0 comments on commit 44894a7

Please sign in to comment.