On 28.07.23 13:07, Shin'ichiro Kawasaki wrote: > 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 referred to as a document.
