RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

tests/README.md: add documentation about uart interaction

Browse Source 
Add some documentation about tests using `cleanterm` and what guarantees
it gives.
This commit is contained in:
Gaëtan Harter 2019-09-30 16:38:30 +02:00
parent 1fce298441
commit 66300b2f72
No known key found for this signature in database
GPG Key ID: 76DF6BCF1B1F883B
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
tests/README.md
View File

@ -27,3 +27,18 @@ An automated way of knowing if a test is available is to execute the
It executes without error if tests run by 'make test' are present.
make test/available
Interaction through the uart
----------------------------
Tests implemented with `testrunner` use the `cleanterm` target that
provides an interaction without adding extra text output or input handling.
It can currently be expected to have unmodified line based interaction with the
board.
The expected behavior is verified with the test in `tests/test_tools`.
Tests cannot rely on having on all boards and terminal programs:
* unbuffered input
* allowing sending special characters like `ctrl+c/ctrl+d`