Skip to content

Commit

Permalink
Add note on ASAN/UBSAN affecting test performance
Browse files Browse the repository at this point in the history
This came up while submitting rpm-software-management#3540.

(cherry picked from commit ad33670)
  • Loading branch information
dmnks committed Feb 3, 2025
1 parent fddaffc commit 032ac9e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,15 @@ as well as the existing tests. Below are the specifics of RPM's test-suite:

### Tips & Tricks

* If you've configured your CMake build with the `ENABLE_ASAN` and/or
`ENABLE_UBSAN` options enabled (OFF by default), the test-suite will run
significantly slower, increasing the total execution time by as much as 2
minutes on modern hardware. If this is an issue, consider setting up a
separate CMake build on the side without these options enabled and use that
for running the test-suite iteratively. Before submitting a PR, though,
please verify that the test-suite still passes with those options enabled
(the easiest way is to run `make ci`).

* Sometimes, you may need to specify a literal square bracket, such as in RPM
commands using `--qf` format strings. Do that by wrapping the whole script
(or expected output) in double square brackets, for example:
Expand Down

0 comments on commit 032ac9e

Please # to comment.