diff options
| -rw-r--r-- | tools/testing/selftests/README.txt | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/tools/testing/selftests/README.txt b/tools/testing/selftests/README.txt new file mode 100644 index 000000000000..5e2faf9c55d3 --- /dev/null +++ b/tools/testing/selftests/README.txt | |||
| @@ -0,0 +1,42 @@ | |||
| 1 | Linux Kernel Selftests | ||
| 2 | |||
| 3 | The kernel contains a set of "self tests" under the tools/testing/selftests/ | ||
| 4 | directory. These are intended to be small unit tests to exercise individual | ||
| 5 | code paths in the kernel. | ||
| 6 | |||
| 7 | Running the selftests | ||
| 8 | ===================== | ||
| 9 | |||
| 10 | To build the tests: | ||
| 11 | |||
| 12 | $ make -C tools/testing/selftests | ||
| 13 | |||
| 14 | |||
| 15 | To run the tests: | ||
| 16 | |||
| 17 | $ make -C tools/testing/selftests run_tests | ||
| 18 | |||
| 19 | - note that some tests will require root privileges. | ||
| 20 | |||
| 21 | |||
| 22 | To run only tests targetted for a single subsystem: | ||
| 23 | |||
| 24 | $ make -C tools/testing/selftests TARGETS=cpu-hotplug run_tests | ||
| 25 | |||
| 26 | See the top-level tools/testing/selftests/Makefile for the list of all possible | ||
| 27 | targets. | ||
| 28 | |||
| 29 | |||
| 30 | Contributing new tests | ||
| 31 | ====================== | ||
| 32 | |||
| 33 | In general, the rules for for selftests are | ||
| 34 | |||
| 35 | * Do as much as you can if you're not root; | ||
| 36 | |||
| 37 | * Don't take too long; | ||
| 38 | |||
| 39 | * Don't break the build on any architecture, and | ||
| 40 | |||
| 41 | * Don't cause the top-level "make run_tests" to fail if your feature is | ||
| 42 | unconfigured. | ||
