diff options
| author | Brendan Higgins <brendanhiggins@google.com> | 2019-09-23 11:02:45 +0200 |
|---|---|---|
| committer | Shuah Khan <skhan@linuxfoundation.org> | 2019-10-01 01:35:01 +0200 |
| commit | c23a283b532c833de486e0fb8d756c7e7581803b (patch) | |
| tree | 884a227378099dbde8a451589b52c4034c545650 /Documentation/dev-tools/kunit/api | |
| parent | kunit: defconfig: add defconfigs for building KUnit tests (diff) | |
| download | linux-c23a283b532c833de486e0fb8d756c7e7581803b.tar.xz linux-c23a283b532c833de486e0fb8d756c7e7581803b.zip | |
Documentation: kunit: add documentation for KUnit
Add documentation for KUnit, the Linux kernel unit testing framework.
- Add intro and usage guide for KUnit
- Add API reference
Signed-off-by: Felix Guo <felixguoxiuping@gmail.com>
Signed-off-by: Brendan Higgins <brendanhiggins@google.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Reviewed-by: Logan Gunthorpe <logang@deltatee.com>
Reviewed-by: Stephen Boyd <sboyd@kernel.org>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Diffstat (limited to 'Documentation/dev-tools/kunit/api')
| -rw-r--r-- | Documentation/dev-tools/kunit/api/index.rst | 16 | ||||
| -rw-r--r-- | Documentation/dev-tools/kunit/api/test.rst | 11 |
2 files changed, 27 insertions, 0 deletions
diff --git a/Documentation/dev-tools/kunit/api/index.rst b/Documentation/dev-tools/kunit/api/index.rst new file mode 100644 index 000000000000..9b9bffe5d41a --- /dev/null +++ b/Documentation/dev-tools/kunit/api/index.rst @@ -0,0 +1,16 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============= +API Reference +============= +.. toctree:: + + test + +This section documents the KUnit kernel testing API. It is divided into the +following sections: + +================================= ============================================== +:doc:`test` documents all of the standard testing API + excluding mocking or mocking related features. +================================= ============================================== diff --git a/Documentation/dev-tools/kunit/api/test.rst b/Documentation/dev-tools/kunit/api/test.rst new file mode 100644 index 000000000000..aaa97f17e5b3 --- /dev/null +++ b/Documentation/dev-tools/kunit/api/test.rst @@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +======== +Test API +======== + +This file documents all of the standard testing API excluding mocking or mocking +related features. + +.. kernel-doc:: include/kunit/test.h + :internal: |