]> www.infradead.org Git - users/sagi/blktests.git/commitdiff
README: clarify motivations to add new test cases
authorShin'ichiro Kawasaki <shinichiro.kawasaki@wdc.com>
Fri, 28 Jul 2023 11:07:20 +0000 (20:07 +0900)
committerShin'ichiro Kawasaki <shinichiro.kawasaki@wdc.com>
Fri, 11 Aug 2023 01:53:26 +0000 (10:53 +0900)
It is often questioned when new test cases should be added to blktests.
Clarify it in "Adding Tests" section.

Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com>
Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
Signed-off-by: Shin'ichiro Kawasaki <shinichiro.kawasaki@wdc.com>
README.md

index dbb483c79c8585bd77e3e7adcff7ee64806cfd23..b6445d6c1a6f0c491b5d81771abec9671348c738 100644 (file)
--- 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