Commit 3409f9ab authored Aug 18, 2016 by Aleksander Alekseev Committed by Shuah Khan Sep 20, 2016

kselftest: kselftest documentation improvement



Suggested patch solves two issues:

1) Currently documentation is unclear whether `make kselftest` should
be run before or after kernel was installed and booted. `make help`
gives a clear answer on that: "kselftest - Build and run kernel selftest
(run as root). Build, install, and boot kernel before running kselftest
on it."

2) Documentation states that `make kselftest` executes "unit" tests.
Technically it's not a _unit_ test if it requires to install an
application first. It's either integration or system test. To not to
confuse a user I suggest not to use a word "unit".

Signed-off-by: Aleksander Alekseev <afiskon@devzen.ru>
Acked-by: Michael Ellerman <mpe@ellerman.id.au>
Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com>

parent 29b4817d

Documentation/kselftest.txt

+3 −2

Original line number	Diff line number	Diff line
		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.
		directory. These are intended to be small tests to exercise individual code
		paths in the kernel. Tests are intended to be run after building, installing
		and booting a kernel.

		On some systems, hot-plug tests could hang forever waiting for cpu and
		memory to be ready to be offlined. A special hot-plug target is created