Merge branch 'submitting-drivers-removal' into docs-next
[linux-block.git] / lib / kunit / Kconfig
CommitLineData
914cc63e
BH
1#
2# KUnit base configuration
3#
4
5menuconfig KUNIT
9fe124bf 6 tristate "KUnit - Enable support for unit tests"
5d31f71e 7 select GLOB if KUNIT=y
914cc63e
BH
8 help
9 Enables support for kernel unit tests (KUnit), a lightweight unit
10 testing and mocking framework for the Linux kernel. These tests are
11 able to be run locally on a developer's workstation without a VM or
12 special hardware when using UML. Can also be used on most other
13 architectures. For more information, please see
14 Documentation/dev-tools/kunit/.
d8e2a76b
BH
15
16if KUNIT
17
e2219db2 18config KUNIT_DEBUGFS
beaed42c
AR
19 bool "KUnit - Enable /sys/kernel/debug/kunit debugfs representation" if !KUNIT_ALL_TESTS
20 default KUNIT_ALL_TESTS
e2219db2
AM
21 help
22 Enable debugfs representation for kunit. Currently this consists
23 of /sys/kernel/debug/kunit/<test_suite>/results files for each
24 test suite, which allow users to see results of the last test suite
25 run that occurred.
26
d8e2a76b 27config KUNIT_TEST
beaed42c
AR
28 tristate "KUnit test for KUnit" if !KUNIT_ALL_TESTS
29 default KUNIT_ALL_TESTS
d8e2a76b
BH
30 help
31 Enables the unit tests for the KUnit test framework. These tests test
32 the KUnit test framework itself; the tests are both written using
33 KUnit and test KUnit. This option should only be enabled for testing
34 purposes by developers interested in testing that KUnit works as
35 expected.
36
37config KUNIT_EXAMPLE_TEST
beaed42c
AR
38 tristate "Example test for KUnit" if !KUNIT_ALL_TESTS
39 default KUNIT_ALL_TESTS
d8e2a76b
BH
40 help
41 Enables an example unit test that illustrates some of the basic
42 features of KUnit. This test only exists to help new users understand
43 what KUnit is and how it is used. Please refer to the example test
44 itself, lib/kunit/example-test.c, for more information. This option
45 is intended for curious hackers who would like to understand how to
46 use KUnit for kernel development.
47
92238b31
AR
48config KUNIT_ALL_TESTS
49 tristate "All KUnit tests with satisfied dependencies"
50 help
51 Enables all KUnit tests, if they can be enabled.
52 KUnit tests run during boot and output the results to the debug log
53 in TAP format (http://testanything.org/). Only useful for kernel devs
54 running the KUnit test harness, and not intended for inclusion into a
55 production build.
56
57 For more information on KUnit and unit tests in general please refer
58 to the KUnit documentation in Documentation/dev-tools/kunit/.
59
60 If unsure, say N.
61
d8e2a76b 62endif # KUNIT