Skip to content

Commit 01f90a8

Browse files
tests: document --performance flag
Some test require the `--performance` to pass. This commit updates the documentation to make the requirement more explicit. Signed-off-by: Marco Marangoni <mamarang@amazon.com>
1 parent 759f844 commit 01f90a8

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

tests/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,20 @@ excluding tests marked with `pytest.mark.nonci`):
1717
tools/devtool -y test
1818
```
1919

20+
Note: some performance tests require host performance tuning (e.g. dedicating
21+
some memory for `hugetlbfs`). For those tests, the `--performance` flag is also
22+
required:
23+
24+
```sh
25+
tools/devtool -y test --performance
26+
```
27+
2028
To run only tests from specific directories and/or files:
2129

2230
```sh
2331
tools/devtool -y test -- integration_tests/performance/test_boottime.py
32+
# Or
33+
tools/devtool -y test --performance -- integration_tests/performance/test_huge_pages.py
2434
```
2535

2636
To run a single specific test from a file:

0 commit comments

Comments
 (0)