diff mbox series

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

Message ID 20200120194310.3942-3-wainersm@redhat.com (mailing list archive)
State New, archived
Headers show
Series README: Markdown fixes and improvements | expand

Commit Message

Wainer dos Santos Moschetta Jan. 20, 2020, 7:43 p.m. UTC
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(+)

Comments

Andrew Jones Jan. 21, 2020, 9:22 a.m. UTC | #1
On Mon, Jan 20, 2020 at 04:43:10PM -0300, Wainer dos Santos Moschetta wrote:
> 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

s/The test case/Test cases/

> +example, extra QEMU parameters and time to execute limited, the

s,and time to execute limited,and/or timeouts,

> +runner script reads those information from a configuration file found

s/those/that/

> +at ./ARCH/unittests.cfg.
> +
> +The configuration file also contain the groups (if any) each test belong

s/contain/contains/
s/belong/belongs/

> +to. So that a given group can be executed by specifying its name in the

s/So that a/A/
s/can/may/

> +runner's -g option.
> +
>  # Unit test inputs
>  
>  Unit tests use QEMU's '-append args...' parameter for command line
> -- 
> 2.23.0
> 

Thanks,
drew
diff mbox series

Patch

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