Skip to content

Commit 35ee0d8

Browse files
d-e-s-odanielocfb
authored andcommitted
Add note about test artifact generation for capi tests
When *only* running the capi test suite and never having run the overall blazesym one, we end up not generating test artifacts. The fix isn't trivial, unfortunately, and given that this is a very unlikely pattern, let's just fudge this case with documentation. Refs: #1103 Signed-off-by: Daniel Müller <[email protected]>
1 parent 4ee536d commit 35ee0d8

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README-devel.md

+7
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ transparently created as long as the `generate-unit-test-files` feature for the
2323
`blazesym-dev` package is active, which is enabled by default for
2424
testing.
2525

26+
Note that if you explicitly and *only* run the test suite for the C API
27+
bindings (`blazesym-c`), you will have to explicitly have to generate test
28+
artifacts before the first test run, via:
29+
```sh
30+
cargo check --package blazesym-dev --features=generate-unit-test-files
31+
```
32+
2633
### Running Miri
2734
[Miri][miri] is used for testing the crate for any undefined behavior.
2835
The interpreter is restricted to functionality that does not cross FFI

0 commit comments

Comments
 (0)