linux

History

Jeremy Kerr 80d0342859 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>		2013-02-27 19:10:24 -08:00
..
breakpoints	breakpoint selftests: print failure status instead of cause make error	2012-12-17 17:15:27 -08:00
cpu-hotplug	cpu-hotplug selftests: print failure status instead of cause make error	2012-12-17 17:15:27 -08:00
efivarfs	selftests/efivarfs: add create-read test	2013-02-27 19:10:24 -08:00
ipc	selftests: IPC message queue copy feature test	2013-01-04 16:11:45 -08:00
kcmp	tools/testing/selftests/kcmp/kcmp_test.c: print reason for failure in kcmp_test	2012-12-17 17:15:27 -08:00
memory-hotplug	mem-hotplug selftests: print failure status instead of cause make error	2012-12-17 17:15:27 -08:00
mqueue	mqueue selftests: print failure status instead of cause make error	2012-12-17 17:15:26 -08:00
vm	vm selftests: print failure status instead of cause make error	2012-12-17 17:15:26 -08:00
Makefile	tools/testing/selftests/Makefile: rearrange targets	2013-02-27 19:10:24 -08:00
README.txt	selftests: add a simple doc	2013-02-27 19:10:24 -08:00

README.txt

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.