[kvm-unit-tests v2 2/2] README: Add intro about the configuration file

Wainer dos Santos Moschetta
2020-01-20T19:43:27Z

The 'Guarding unsafe tests' section mention the unittests.cfg
file which was never introduced before. In this change
it was added a section with a few words about the tests
configuration file (unittests.cfg).

Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
---
README.md | 11 +++++++++++
1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 367c92a..763759e 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,17 @@ ACCEL=name environment variable:

ACCEL=kvm ./x86-run ./x86/msr.flat

+# Tests configuration file
+
+The test case may need specific runtime configurations, for
+example, extra QEMU parameters and time to execute limited, the
+runner script reads those information from a configuration file found
+at ./ARCH/unittests.cfg.
+
+The configuration file also contain the groups (if any) each test belong
+to. So that a given group can be executed by specifying its name in the
+runner's -g option.
+
# Unit test inputs

Unit tests use QEMU's '-append args...' parameter for command line
--
2.23.0