[kvm-unit-tests PATCH v9 01/31] doc: update unittests doc

[Thomas Huth]

On 04/05/2024 14.28, Nicholas Piggin wrote:
> This adds a few minor fixes.
> 
> Signed-off-by: Nicholas Piggin <npiggin at gmail.com>
> ---
>   docs/unittests.txt | 12 +++++++-----
>   1 file changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/docs/unittests.txt b/docs/unittests.txt
> index 3192a60ec..7cf2c55ad 100644
> --- a/docs/unittests.txt
> +++ b/docs/unittests.txt
> @@ -15,8 +15,8 @@ unittests.cfg format
>   
>   # is the comment symbol, all following contents of the line is ignored.
>   
> -Each unit test is defined with a [unit-test-name] line, followed by
> -a set of parameters that control how the test case is run. The name is
> +Each unit test is defined with a [unit-test-name] line, followed by a
> +set of parameters that control how the test case is run. The name is
>   arbitrary and appears in the status reporting output.
>   
>   Parameters appear on their own lines under the test name, and have a
> @@ -62,8 +62,8 @@ groups
>   groups = <group_name1> <group_name2> ...
>   
>   Used to group the test cases for the `run_tests.sh -g ...` run group
> -option. Adding a test to the nodefault group will cause it to not be
> -run by default.
> +option. The group name is arbitrary, aside from the nodefault group
> +which makes the test to not be run by default.
>   
>   accel
>   -----
> @@ -82,8 +82,10 @@ Optional timeout in seconds, after which the test will be killed and fail.
>   
>   check
>   -----
> -check = <path>=<<value>
> +check = <path>=<value>
>   
>   Check a file for a particular value before running a test. The check line
>   can contain multiple files to check separated by a space, but each check
>   parameter needs to be of the form <path>=<value>
> +
> +The path and value can not contain space, =, or shell wildcard characters.

Could you comment on my feedback here, please:

  https://lore.kernel.org/kvm/951ccd88-0e39-4379-8d86-718e72594dd9@redhat.com/

  Thanks,
   Thomas