iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

kselftest: kselftest documentation improvement

Browse Source 
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>
This commit is contained in:
Aleksander Alekseev 2016-08-18 12:36:53 +03:00 committed by Shuah Khan
parent 29b4817d40
commit 3409f9ab71
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/kselftest.txt
View File

@ -1,8 +1,9 @@
Linux Kernel Selftests Linux Kernel Selftests
The kernel contains a set of "self tests" under the tools/testing/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 directory. These are intended to be small tests to exercise individual code
code paths in the kernel. 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 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 memory to be ready to be offlined. A special hot-plug target is created