• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Maintainer Patch Review Checklist
2
3Patchset should be tested locally and ideally also in maintainer's fork in
4https://travis-ci.org/[Travis CI].
5
6NOTE: Travis does only build testing, passing the CI means only that the
7      test compiles fine on variety of different distributions and
8      releases.
9
10The test should be executed at least once locally and should PASS as well.
11
12Commit messages should have
13
14* Author's `Signed-off-by` tag
15* Committer's `Reviewed-by` or `Signed-off-by` tag
16* Check also mailing lists for other reviewers / testers tags, notes and failure reports
17* `Fixes: hash` if it fixes particular LTP commit
18* `Fixes: #N` if it fixes github issue number N, so it's automatically closed
19
20After patch is accepted or rejected, set correct state and archive in
21https://patchwork.ozlabs.org/project/ltp/list/[LTP patchwork instance].
22
23Also update LTP WIKI (git URL https://github.com/linux-test-project/ltp.wiki.git)
24if touch `doc/*.txt`.
25
26## New tests
27New test should
28
29* Have a record in runtest file
30* Test should work fine with more than one iteration
31  (e.g. run with `-i 100`)
32* Have a brief description
33* License: the default license for new tests is GPL v2 or later, use
34  GPL-2.0-or-later; the licence for test (e.g. GPL-2.0) should not change
35  unless test is completely rewritten
36* Old copyrights should be kept unless test is completely rewritten
37
38### C tests
39* Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
40* Test binaries are added into corresponding '.gitignore' files
41* Check coding style with
42  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl]
43  (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#131-c-coding-style[C coding style])
44* Docparse documentation
45* If a test is a regression test it should include tags
46  (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#2238-test-tags[Test tags])
47
48### Shell tests
49* Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#23-writing-a-testcase-in-shell[shell API]
50* Check coding style with
51  https://salsa.debian.org/debian/devscripts/raw/master/scripts/checkbashisms.pl[checkbashism.pl]
52  (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#132-shell-coding-style[Shell coding style])
53* If a test is a regression test it should include related kernel or glibc commits as a comment
54
55## LTP library
56For patchset touching library please check also
57https://github.com/linux-test-project/ltp/wiki/LTP-Library-API-Writing-Guidelines[LTP Library API Writing Guidelines].
58