Skip to content

Commit

Permalink
[doc] add coverage flow usage
Browse files Browse the repository at this point in the history
Signed-off-by: Clo91eaf <[email protected]>
  • Loading branch information
Clo91eaf committed Dec 22, 2024
1 parent 3e1aaca commit 30f2156
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ $ nix develop -c t1-helper run -i <top-name> -c <config-name> -e <emulator-type>
wheres
- `<config-name>` is the configuration name
- `<top-name>` is one of the `t1emu`, `t1rocketemu`
- `<emulator-type>` is one of the `verilator-emu`, `verilator-emu-trace`, `vcs-emu`, `vcs-emu-trace`
- `<emulator-type>` is one of the `verilator-emu`, `verilator-emu-trace`, `vcs-emu`, `vcs-emu-trace`, `vcs-emu-cover`
- `<case-name>` is the name of a testcase, you can resolve runnable test cases by command: `t1-helper listCases -c <config-name> <regexp>`

For example:
Expand Down Expand Up @@ -206,6 +206,12 @@ $ nix develop -c t1-helper check
The `t1-helper check` subcommand will read RTL event produced in `run` stage,
so make sure you `run` a test before `check`.

To get the coverage report, use the `vcs-emu-cover` emulator type:

```console
$ nix develop -c t1-helper run -i t1emu -c blastoise -e vcs-emu-cover mlir.hello
```

#### Export RTL Properties

```shell
Expand Down

0 comments on commit 30f2156

Please sign in to comment.