Skip to contentSkip to conversation

docs: rm explicit reference to checkpatch.pl

PATCH New Richard Palethorpe 3 participants 7 messages Aug 31, 2021 – Sep 1, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 docs: rm explicit reference to checkpatch.pl

It is included in make check now.

---
 doc/maintainer-patch-review-checklist.txt | 3 +--
 doc/test-writing-guidelines.txt           | 5 ++---
 2 files changed, 3 insertions(+), 5 deletions(-)
doc/maintainer-patch-review-checklist.txt +1 -2
index 58662bed1..c8ace80f7 100644
@@ -38,8 +38,7 @@ New test should
 ### C tests
 * Use new https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#22-writing-a-test-in-c[C API]
 * Test binaries are added into corresponding '.gitignore' files
-* Check coding style with
-  https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl] and `make check`
+* Check coding style with `make check`
   (more in https://github.com/linux-test-project/ltp/wiki/Test-Writing-Guidelines#21-c-coding-style[C coding style])
 * Docparse documentation
 * If a test is a regression test it should include tags
doc/test-writing-guidelines.txt +2 -3
index 340c80cc6..e95373e84 100644
@@ -305,12 +305,11 @@ NOTE: See also
       https://github.com/linux-test-project/ltp/wiki/Maintainer-Patch-Review-Checklist[Maintainer Patch Review Checklist].
 
 1. Test compiles and runs fine (check with `-i 10` too)
-2. https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl]
-   does not report any errors
+2. `make check` does not emit any warnings for the test you are working on
+   (hint: run it in the test's directory and/or use `make check-$TCID`)
 3. The runtest entires are in place
 4. Test binaries are added into corresponding '.gitignore' files
 5. Patches apply over the latest git
-6. 'make check' does not emit any warnings
 
 6.1 About .gitignore files
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.31.1
#1 lore raw

PATCH 2/2 docs: Fix typo 'entires' -> 'entries'

---
 doc/test-writing-guidelines.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/test-writing-guidelines.txt +1 -1
index e95373e84..12fe4922a 100644
@@ -307,7 +307,7 @@ NOTE: See also
 1. Test compiles and runs fine (check with `-i 10` too)
 2. `make check` does not emit any warnings for the test you are working on
    (hint: run it in the test's directory and/or use `make check-$TCID`)
-3. The runtest entires are in place
+3. The runtest entries are in place
 4. Test binaries are added into corresponding '.gitignore' files
 5. Patches apply over the latest git
 
Signature · 1 line
2.31.1
#4 lore raw

PATCH 2/2 docs: Fix typo 'entires' -> 'entries'

Hi Richie, Cyril,

thanks, merged!

Kind regards,
Petr

#5 lore raw

PATCH 1/2 docs: rm explicit reference to checkpatch.pl

In reply to Richard Palethorpe

Hi Richie,

...

doc/test-writing-guidelines.txt NOTE: See also · line 309

Quoted 5 lines

1. Test compiles and runs fine (check with -i 10 too)
-2. https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl[checkpatch.pl]

doc/test-writing-guidelines.txt +2 -1
-   does not report any errors
+2. `make check` does not emit any warnings for the test you are working on
+   (hint: run it in the test's directory and/or use `make check-$TCID`)

I was thinking about mention what exactly make check does, but that'd again require being kept in sync.

Kind regards,
Petr