[PATCH blktests 2/4] README: describe what './new' script documents

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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.

Signed-off-by: Shin'ichiro Kawasaki <shinichiro.kawasaki@xxxxxxx>
---
 README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 186fc3b..1324159 100644
--- 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 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@xxxxxxxxxxxxxxx> are both
 accepted. See [here](CONTRIBUTING.md) for more information on contributing.
-- 
2.40.1




[Index of Archives]     [Linux RAID]     [Linux SCSI]     [Linux ATA RAID]     [IDE]     [Linux Wireless]     [Linux Kernel]     [ATH6KL]     [Linux Bluetooth]     [Linux Netdev]     [Kernel Newbies]     [Security]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Device Mapper]

  Powered by Linux