From: Nicholas Piggin <npiggin@gmail.com>
To: Thomas Huth <thuth@redhat.com>, Andrew Jones <andrew.jones@linux.dev>
Cc: Nicholas Piggin <npiggin@gmail.com>, kvm@vger.kernel.org
Subject: [kvm-unit-tests PATCH] doc: update unittests doc
Date: Fri, 3 May 2024 16:00:38 +1000 [thread overview]
Message-ID: <20240503060039.978863-1-npiggin@gmail.com> (raw)
Some cleanups and a comment about the check parameter restrictions.
Signed-off-by: Nicholas Piggin <npiggin@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.
--
2.43.0
next reply other threads:[~2024-05-03 6:00 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-03 6:00 Nicholas Piggin [this message]
2024-05-03 6:56 ` [kvm-unit-tests PATCH] doc: update unittests doc Thomas Huth
2024-05-07 4:00 ` Nicholas Piggin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240503060039.978863-1-npiggin@gmail.com \
--to=npiggin@gmail.com \
--cc=andrew.jones@linux.dev \
--cc=kvm@vger.kernel.org \
--cc=thuth@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).