diff mbox series

[v2] Add more check points for Review Checklist doc

Message ID 20240123140404.15481-1-wegao@suse.com
State Accepted
Headers show
Series [v2] Add more check points for Review Checklist doc | expand

Commit Message

Wei Gao Jan. 23, 2024, 2:04 p.m. UTC
Signed-off-by: Wei Gao <wegao@suse.com>
---
 doc/Maintainer-Patch-Review-Checklist.asciidoc | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Comments

Cyril Hrubis March 19, 2024, 12:35 p.m. UTC | #1
Hi!
I've adjusted the wording here and there and pushed, thanks.
diff mbox series

Patch

diff --git a/doc/Maintainer-Patch-Review-Checklist.asciidoc b/doc/Maintainer-Patch-Review-Checklist.asciidoc
index 452de0d49..e5dd624b1 100644
--- a/doc/Maintainer-Patch-Review-Checklist.asciidoc
+++ b/doc/Maintainer-Patch-Review-Checklist.asciidoc
@@ -22,6 +22,7 @@  The following are examples and may not be appropriate for all tests.
   - Use sanitizers e.g. undefined behaviour, address.
   - Compile on non-x86
   - Compile on x86 with -m32
+  - Test patches on GitHub Actions will covers various architectures
 * Use `make check`
 * Run effected tests in a VM
   - Use single vCPU
@@ -30,10 +31,12 @@  The following are examples and may not be appropriate for all tests.
 * Run effected tests on an embedded device
 * Run effected tests on non-x86 machine in general
 * Run reproducers on a kernel where the bug is present
-* Run tests with "-i0"
+* Run tests with "-i0" and "-in"
 * Compare usage of system calls with man page descriptions
-* Compare usage of system calls with kernel code
+* Compare usage of system calls with kernel code or commit message
 * Search the LTP library for existing helper functions
+* Check doc formatting e.g. cd metadata && make && chromium ../docparse/*.html
+* Preview in your fork when change doc such as C-Test-API.asciidoc
 
 ## How to find subtle errors