README: describe what './new' script documents

The knowledge required to implement blktests test cases are documented
in './new' script which generates test case script template. This is
handy when we implement new test cases. However, it is difficult to
refer the documentation when we do not implement new test cases.

To help to refer the documentation, add a pointer to it and describe
what it documents.

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>

diff --git a/README.md b/README.md
index 186fc3b2825556fbfac2866d21ad9b1e1f114fc2..6e7dbe4b85a8d62e4e609eefd5a01c246da0f16e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -49,7 +49,10 @@ configuration and running tests.
 ## Adding Tests
 
 The `./new` script creates a new test from a template. The generated template
-contains more detailed documentation.
+contains more detailed documentation. [The ./new script itself](new) can be
+referred to as a document. It describes variables and functions that test cases
+should implement, global variables that test cases can refer and coding
+guidelines.
 
 Pull requests on GitHub and patches to <linux-block@vger.kernel.org> are both
 accepted. See [here](CONTRIBUTING.md) for more information on contributing.