Skip to content

Commit

Permalink
Documentation: kunit: remove claims that kunit is a mocking framework
Browse files Browse the repository at this point in the history
KUnit does not have any first party support for "mocking".

The original RFC had some, but the code got dropped.
However, the documentation patches never got updated. This fixes that.

https://kunit.dev/mocking.html has a current writeup on the status quo
and will hopefully be eventually folded into the in-kernel
Documentation.

Signed-off-by: Daniel Latypov <dlatypov@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
  • Loading branch information
Daniel Latypov authored and Shuah Khan committed Dec 13, 2021
1 parent 9a6bb30 commit 58b391d
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
3 changes: 1 addition & 2 deletions Documentation/dev-tools/kunit/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@ following sections:

Documentation/dev-tools/kunit/api/test.rst

- documents all of the standard testing API excluding mocking
or mocking related features.
- documents all of the standard testing API
3 changes: 1 addition & 2 deletions Documentation/dev-tools/kunit/api/test.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
Test API
========

This file documents all of the standard testing API excluding mocking or mocking
related features.
This file documents all of the standard testing API.

.. kernel-doc:: include/kunit/test.h
:internal:
2 changes: 1 addition & 1 deletion Documentation/dev-tools/kunit/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ KUnit - Unit Testing for the Linux Kernel
What is KUnit?
==============

KUnit is a lightweight unit testing and mocking framework for the Linux kernel.
KUnit is a lightweight unit testing framework for the Linux kernel.

KUnit is heavily inspired by JUnit, Python's unittest.mock, and
Googletest/Googlemock for C++. KUnit provides facilities for defining unit test
Expand Down

0 comments on commit 58b391d

Please sign in to comment.