Files
retroSoC/tests/README.md
T
maksyuki 1e37314a99 chore: enhance RTL style checks and enforce naming conventions
- Updated  to enforce stricter naming rules for new owned RTL.
- Expanded documentation on RTL coding style to include detailed naming contracts.
- Refactored RTL code to comply with new naming conventions, including:
  - Renaming typedefs to use  suffix for enums and  for other types.
  - Ensuring module names use lower snake case and ports have appropriate direction suffixes.
  - Adjusting instance names to start with  and ensuring state variables use  and  suffixes.
- Modified scripts to include checks for new naming rules and updated tests to validate these changes.
- Updated  to reflect new naming guidelines and exceptions.
2026-08-13 12:01:38 +08:00

24 lines
813 B
Markdown

# Repository Tests
This directory contains tests for deterministic SDK behavior and build/quality
tooling.
- `c/test_runtime.c` is the host C test program used by `make sw-host-test`.
- `test_script_tools.py` covers setup, dependency, filelist, warning, metric,
archive, and regression-helper behavior.
- `test_rtl_readiness.py` covers the machine-readable RTL maturity and
synthesis-intent checks.
- `test_rtl_style.py` covers ownership, named connections, and staged naming
rules for new owned RTL.
Add a host C test when changing deterministic runtime or media logic; add a
Python test when changing scripts or build policy. Run:
```sh
make sw-host-test
python3 -m pytest -q
```
These tests complement, but do not replace, firmware builds, RTL simulation,
synthesis, timing, or hardware validation.