[PATCH] Documentation: Add a simple doc for selftests

From: Jeremy Kerr
Date: Fri Feb 08 2013 - 05:06:18 EST

On 08/02/13 07:13, Andrew Morton wrote:

> The general ruleset for selftests is: do as much as you can if you're not
> root and don't take too long and 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.

This change adds a little documentation to the tests under
tools/testing/selftests/, based on akpm's explanation.

Signed-off-by: Jeremy Kerr <jk@xxxxxxxxxx>

Documentation/selftests.txt | 43 ++++++++++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)

diff --git a/Documentation/selftests.txt b/Documentation/selftests.txt
new file mode 100644
index 0000000..a00e477
--- /dev/null
+++ b/Documentation/selftests.txt
@@ -0,0 +1,43 @@
+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
+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.
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/