diff options
author | 2013-02-27 17:05:57 -0800 | |
---|---|---|
committer | 2013-02-27 19:10:24 -0800 | |
commit | 80d03428597056f4e2d1aed389929ece7879dad1 (patch) | |
tree | 5bbf67ce8681ca7ce13b2a7b9c2f5c2f6a8ee51c /tools | |
parent | tools/testing/selftests/Makefile: rearrange targets (diff) | |
download | linux-80d03428597056f4e2d1aed389929ece7879dad1.tar.gz linux-80d03428597056f4e2d1aed389929ece7879dad1.tar.bz2 linux-80d03428597056f4e2d1aed389929ece7879dad1.zip |
selftests: add a simple doc
This change adds a little documentation to the tests under
tools/testing/selftests/, based on akpm's explanation.
[akpm@linux-foundation.org: move from Documentation to tools/testing/selftests/README.txt]
Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
Cc: Dave Young <dyoung@redhat.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'tools')
-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 @@ +Linux Kernel Selftests + +The kernel contains a set of "self tests" under the tools/testing/selftests/ +directory. These are intended to be small unit tests to exercise individual +code paths in the kernel. + +Running the selftests +===================== + +To build the tests: + + $ make -C tools/testing/selftests + + +To run the tests: + + $ make -C tools/testing/selftests run_tests + +- note that some tests will require root privileges. + + +To run only tests targetted for a single subsystem: + + $ make -C tools/testing/selftests TARGETS=cpu-hotplug run_tests + +See the top-level tools/testing/selftests/Makefile for the list of all possible +targets. + + +Contributing new tests +====================== + +In general, the rules for for selftests are + + * Do as much as you can if you're not root; + + * Don't take too long; + + * Don't break the build on any architecture, and + + * Don't cause the top-level "make run_tests" to fail if your feature is + unconfigured. |