From 35b7cce07860aa0a87beec1f135d742f01a1b917 Mon Sep 17 00:00:00 2001 From: Shin'ichiro Kawasaki Date: Fri, 28 Jul 2023 20:07:20 +0900 Subject: [PATCH] README: clarify motivations to add new test cases It is often questioned when new test cases should be added to blktests. Clarify it in "Adding Tests" section. Reviewed-by: Chaitanya Kulkarni Reviewed-by: Johannes Thumshirn Signed-off-by: Shin'ichiro Kawasaki --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index dbb483c..b6445d6 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,14 @@ configuration and running tests. ## Adding Tests +New test cases are welcomed when, + +- a bug in block layer or storage stack is found and the new test case confirms + fix of the bug, +- a new feature is introduced in block layer or storage stack, and the new test + cases confirm that the feature is working well, or, +- the new test cases extend coverage of block layer and storage stack code. + The `./new` script creates a new test from a template. The generated template contains more detailed documentation. [The ./new script itself](new) can be referred to as a document. It describes variables and functions that test cases -- 2.51.0