3rd-party/linux-kernel-module-cheat
1
0
Fork 0
mirror of https://github.com/cirosantilli/linux-kernel-module-cheat.git synced 2026-01-22 17:55:57 +01:00
Code Issues Releases Wiki Activity

Move contributing to readme

Browse Source
This commit is contained in:
Ciro Santilli
2018-05-05 08:11:53 +01:00
parent 1b0c527848
commit fcffb4a6d6
2 changed files with 44 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
CONTRIBUTING.adoc
View File

@@ -1,42 +1,3 @@
= CONTRIBUTING
== Testing
Testing that should be done for every functional patch.
=== Guest testing
....
./run -a x86_64 -e '- lkmc_eval="/insrm.sh hello 5;/sbin/ifup -a;wget -S google.com;poweroff;"'
./run -a arm -e '- lkmc_eval="/insrm.sh hello 5;/sbin/ifup -a;wget -S google.com;poweroff;"'
....
Should:
* boot
* show `hello.ko` `init` and `exit` messages
* make a network request
* shutdown gracefully
TODO automate all of this with a `/test-all.sh` script in guest which outputs to stdout `LKMC_TEST_PASS` or `LKMC_TEST_FAIL` and grep that from host.
=== Host testing
Shell 1:
....
./run -d
....
Shell 2:
....
./rungdb start_kernel
....
Should break GDB at `start_kernel`.
Then proceed to do the following tests:
* `/count.sh` and `b sys_write`
* `insmod /timer.ko` and `b lkmc_timer_callback`
See: link:README.adoc#contributing[]

43
README.adoc
View File

@@ -5419,6 +5419,49 @@ include::run-usage.adoc[]
:leveloffset: -3
=== CONTRIBUTING
==== Testing
Testing that should be done for every functional patch.
===== Guest testing
....
./run -a x86_64 -e '- lkmc_eval="/insrm.sh hello 5;/sbin/ifup -a;wget -S google.com;poweroff;"'
./run -a arm -e '- lkmc_eval="/insrm.sh hello 5;/sbin/ifup -a;wget -S google.com;poweroff;"'
....
Should:
* boot
* show `hello.ko` `init` and `exit` messages
* make a network request
* shutdown gracefully
TODO automate all of this with a `/test-all.sh` script in guest which outputs to stdout `LKMC_TEST_PASS` or `LKMC_TEST_FAIL` and grep that from host.
===== Host testing
Shell 1:
....
./run -d
....
Shell 2:
....
./rungdb start_kernel
....
Should break GDB at `start_kernel`.
Then proceed to do the following tests:
* `/count.sh` and `b sys_write`
* `insmod /timer.ko` and `b lkmc_timer_callback`
:leveloffset: +2
include::CONTRIBUTING.adoc[]