[PATCH v3] kselftest: kselftest documentation improvement

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxx>
---
v3:
- it was made clear that tests aren't intended to be run by "users"
v2:
- same as v1 but in right format
---
 Documentation/kselftest.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/kselftest.txt b/Documentation/kselftest.txt
index 979eaca..54bee77 100644
--- a/Documentation/kselftest.txt
+++ b/Documentation/kselftest.txt
@@ -1,8 +1,9 @@
 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
-- 
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-kselftest" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux Wireless]     [Linux Kernel]     [ATH6KL]     [Linux Bluetooth]     [Linux Netdev]     [Kernel Newbies]     [Share Photos]     [IDE]     [Security]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux ATA RAID]     [Samba]     [Device Mapper]

  Powered by Linux