[LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist

[LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist

[Petr Vorel]

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/maintainer-patch-review-checklist.txt | 32 +++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 doc/maintainer-patch-review-checklist.txt

diff --git a/doc/maintainer-patch-review-checklist.txt b/doc/maintainer-patch-review-checklist.txt
new file mode 100644
index 000000000..cfe3918c1
--- /dev/null
+++ b/doc/maintainer-patch-review-checklist.txt
@@ -0,0 +1,32 @@
+# Maintainer Patch Review Checklist
+
+Patchset should be tested locally and ideally also in maintainer's fork in
+https://travis-ci.org/[Travis CI].
+
+Commit messages should have
+
+* author's `Signed-off-by` tag
+* committer's `Reviewed-by` or `Signed-off-by` tag
+* check also mailing lists for other reviewers / testers
+
+## New tests
+New test should have
+
+* record in runtest file
+* test run with more iteration (`-i 100`)
+
+### C tests
+* use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
+* record in `.gitignore`
+* check coding style with `checkpatch.pl`
+(more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
+* docparse documentation
+
+### Shell tests
+* use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#23-writing-a-testcase-in-shell[shell API]
+* check coding style with `checkbashism.pl`
+(more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#132-shell-coding-style[Shell coding style])
+
+## LTP library
+For patchset touching library please check also
+https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines].
-- 
2.30.2

[LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist

[Petr Vorel]

Hi,

> +## New tests
> +New test should have
> +
> +* record in runtest file
> +* test run with more iteration (`-i 100`)
sorry, plural (iterations) should be used.

Kind regards,
Petr

[LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist

[Petr Vorel]

Hi,

...
> +++ b/doc/maintainer-patch-review-checklist.txt
> @@ -0,0 +1,32 @@
> +# Maintainer Patch Review Checklist
> +
> +Patchset should be tested locally and ideally also in maintainer's fork in
> +https://travis-ci.org/[Travis CI].
> +
> +Commit messages should have
> +
> +* author's `Signed-off-by` tag
> +* committer's `Reviewed-by` or `Signed-off-by` tag
> +* check also mailing lists for other reviewers / testers

Also add:
Please update patchset status in https://patchwork.ozlabs.org/project/ltp/list/[LTP patchwork].

> +
> +## New tests
> +New test should have
> +
> +* record in runtest file
> +* test run with more iteration (`-i 100`)
...

Kind regards,
Petr

[LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist

[Li Wang]

Hi Petr,

On Wed, Mar 17, 2021 at 5:16 PM Petr Vorel <pvorel@suse.cz> wrote:

> Hi,
>
> ...
> > +++ b/doc/maintainer-patch-review-checklist.txt
> > @@ -0,0 +1,32 @@
> > +# Maintainer Patch Review Checklist
> > +
> > +Patchset should be tested locally and ideally also in maintainer's fork
> in
> > +https://travis-ci.org/[Travis CI].
> > +
> > +Commit messages should have
> > +
> > +* author's `Signed-off-by` tag
> > +* committer's `Reviewed-by` or `Signed-off-by` tag
> > +* check also mailing lists for other reviewers / testers
>
> Also add:
> Please update patchset status in
> https://patchwork.ozlabs.org/project/ltp/list/[LTP patchwork].
>

Also Add:

Please update LTP WIKI if touch doc/*.txt.
https://github.com/linux-test-project/ltp.wiki.git

Otherwise, LGTM.

-- 
Regards,
Li Wang
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.linux.it/pipermail/ltp/attachments/20210317/13b53ac9/attachment.htm>

[LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist

[Cyril Hrubis]

Hi!
>  doc/maintainer-patch-review-checklist.txt | 32 +++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 doc/maintainer-patch-review-checklist.txt

Overall this is a good idea, a few notes below.

> diff --git a/doc/maintainer-patch-review-checklist.txt b/doc/maintainer-patch-review-checklist.txt
> new file mode 100644
> index 000000000..cfe3918c1
> --- /dev/null
> +++ b/doc/maintainer-patch-review-checklist.txt
> @@ -0,0 +1,32 @@
> +# Maintainer Patch Review Checklist
> +
> +Patchset should be tested locally and ideally also in maintainer's fork in
> +https://travis-ci.org/[Travis CI].

We should add something like this here:


Note: Travis does only build testing, passing the CI means only that the
      test compiles fine on variety of different distributions and
      releases.

The test should be executed at least once locally and should PASS as well.

> +Commit messages should have
> +
> +* author's `Signed-off-by` tag
> +* committer's `Reviewed-by` or `Signed-off-by` tag
> +* check also mailing lists for other reviewers / testers
> +
> +## New tests
> +New test should have
> +
> +* record in runtest file

> +* test run with more iteration (`-i 100`)

This is slightly confusing, it should probably be:

* Tests should work fine with more than one iteration
  (e.g. run with `-i 100`)

> +### C tests
> +* use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
> +* record in `.gitignore`
> +* check coding style with `checkpatch.pl`

Checkpatch is distributed with linux kernel source code, please also use
reasonably recent one.

> +(more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
> +* docparse documentation

+ proper documentation comment
  -- this should be explained somewhere and linked here

+ If a test is a regression test it should include tags
  -- this should be explained somewhere as well and linked here

> +### Shell tests
> +* use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#23-writing-a-testcase-in-shell[shell API]
> +* check coding style with `checkbashism.pl`

I guess that we should add the link to debian devscripts here

> +(more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#132-shell-coding-style[Shell coding style])
> +
> +## LTP library
> +For patchset touching library please check also
> +https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines].

-- 
Cyril Hrubis
chrubis@suse.cz

[LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist

[Jan Stancek]

----- Original Message -----
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
>  doc/maintainer-patch-review-checklist.txt | 32 +++++++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 doc/maintainer-patch-review-checklist.txt
> 
> diff --git a/doc/maintainer-patch-review-checklist.txt
> b/doc/maintainer-patch-review-checklist.txt
> new file mode 100644
> index 000000000..cfe3918c1
> --- /dev/null
> +++ b/doc/maintainer-patch-review-checklist.txt
> @@ -0,0 +1,32 @@
> +# Maintainer Patch Review Checklist
> +
> +Patchset should be tested locally and ideally also in maintainer's fork in
> +https://travis-ci.org/[Travis CI].
> +
> +Commit messages should have
> +
> +* author's `Signed-off-by` tag
> +* committer's `Reviewed-by` or `Signed-off-by` tag
> +* check also mailing lists for other reviewers / testers

Maybe "Fixes #" if it fixes github issue, so it's automatically closed?

> +
> +## New tests
> +New test should have
> +
> +* record in runtest file
> +* test run with more iteration (`-i 100`)
> +
> +### C tests
> +* use new
> https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C
> API]
> +* record in `.gitignore`
> +* check coding style with `checkpatch.pl`
> +(more in
> https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C
> coding style])
> +* docparse documentation
> +
> +### Shell tests
> +* use new
> https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#23-writing-a-testcase-in-shell[shell
> API]
> +* check coding style with `checkbashism.pl`
> +(more in
> https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#132-shell-coding-style[Shell
> coding style])
> +
> +## LTP library
> +For patchset touching library please check also
> +https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP
> Library API Writing Guidelines].

One more things that comes to mind:

After patch is accepted or rejected, set correct state and archive
in LTP patchwork instance: http://patchwork.ozlabs.org/project/ltp/list/

[LTP] [RFC PATCH 1/1] doc: Add Maintainer Patch Review Checklist

[Petr Vorel]

Hi all,

Cyril, Li, Jan, thanks for your tips, I'll use them for v2.
Few notes to some of Cyril's tips.

> > +### C tests
> > +* use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
> > +* record in `.gitignore`
> > +* check coding style with `checkpatch.pl`

> Checkpatch is distributed with linux kernel source code, please also use
> reasonably recent one.
I'd prefer not duplicate the info, that's why I linked it docs, which already
mention this. Thus I'd prefer add "reasonably recent one" to
doc/test-writing-guidelines.txt.

> > +(more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
> > +* docparse documentation

> + proper documentation comment
>   -- this should be explained somewhere and linked here
Agree, but I'll probably skip this one.

> + If a test is a regression test it should include tags
>   -- this should be explained somewhere as well and linked here
+1

> > +### Shell tests
> > +* use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#23-writing-a-testcase-in-shell[shell API]
> > +* check coding style with `checkbashism.pl`

> I guess that we should add the link to debian devscripts here
Again, I wanted to remove duplicity, but just repeating link here does no harm.

Kind regards,
Petr