From 613e05fd42480351cac1bef259f4afce38d2226b Mon Sep 17 00:00:00 2001 From: Alexandre Abadie Date: Tue, 22 Jan 2019 08:48:03 +0100 Subject: [PATCH] tools/compile_test_one_board: update documentation README Provide some notes on how to perform basic checks on the script using tox --- dist/tools/compile_and_test_for_board/README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/dist/tools/compile_and_test_for_board/README.md b/dist/tools/compile_and_test_for_board/README.md index c62e56ba57..4155f1b707 100644 --- a/dist/tools/compile_and_test_for_board/README.md +++ b/dist/tools/compile_and_test_for_board/README.md @@ -20,6 +20,20 @@ They can be checked with: find results/ -name '*.failed' find results/ -name 'test.success' +Script checks +------------- + +Use [tox](https://tox.readthedocs.io/en/latest/) to run basic checks on the +script: + + $ tox + +This runs doctest (via pytest), pylint and flake8 checks in a row. +Use `-e` to run each check independently: + + $ tox -e test + $ tox -e lint + $ tox -e flake8 Implementation TODO ------------------- @@ -31,6 +45,6 @@ simply adapt to be used from within RIOT. * Provide a RIOT/Makefile integration * Save output files into `${BUILD_DIR}/output/compile_and_test` directory by default -* tox file to run `doctests/pylint/flake8`. Add tests. +* Add tests. * Implement the `board_is_supported`/`board_has_enough_memory`/`has_tests` to make targets instead of fiddling to get the value