| Message ID | 20230728110720.1280124-3-shinichiro.kawasaki@wdc.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | clarify confusions in blktests contributions | expand |
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@wdc.com> > --- > 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.
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@vger.kernel.org> are both accepted. See [here](CONTRIBUTING.md) for more information on contributing.
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@wdc.com> --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)