denuvo-ref/capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/capstone synced 2026-08-11 16:26:07 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document the test boolean values. (#2892)

Browse source
This commit is contained in:
Rot127 2026-04-10 11:41:16 +00:00 • committed by GitHub
parent fedc9b4822
commit 95fe762a41
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
tests/README.md
View file

@ -120,6 +120,20 @@ ensure they are added on the `suite/cstest/include/test_mapping.h`. Otherwise, `
to the values for comparison.
- Rarely used, but useful fields are: `name`, `skip`, `skip_reason`.
> [!IMPORTANT]
> Boolean values in the YAML files are encoded like the following:
> ```yaml
> # 1 = true
> # 0 = unset
> # -1 = false
>
> is_alias: 1 # Equivalent to is_alias: true
> is_alias: 0 # Equivalent to an unset is_alias field
> is_alias: -1 # Equivalent to is_alias: false
> ```
> The reason is the C library parsing the YAML files.
> It sets all unset (not present) fields to 0.
#### MC regression tests
The `MCUpdater` translates most test files of the LLVM MC regression tests into our YAML files.