[PATCH] Documentation: kunit: remove claims that kunit is a mocking framework

[PATCH] Documentation: kunit: remove claims that kunit is a mocking framework

[Daniel Latypov]

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>
---
 Documentation/dev-tools/kunit/api/index.rst | 3 +--
 Documentation/dev-tools/kunit/api/test.rst  | 3 +--
 Documentation/dev-tools/kunit/index.rst     | 2 +-
 3 files changed, 3 insertions(+), 5 deletions(-)

diff --git a/Documentation/dev-tools/kunit/api/index.rst b/Documentation/dev-tools/kunit/api/index.rst
index b33ad72bcf0b..3006cadcf44a 100644
--- a/Documentation/dev-tools/kunit/api/index.rst
+++ b/Documentation/dev-tools/kunit/api/index.rst
@@ -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
diff --git a/Documentation/dev-tools/kunit/api/test.rst b/Documentation/dev-tools/kunit/api/test.rst
index aaa97f17e5b3..c5eca423e8b6 100644
--- a/Documentation/dev-tools/kunit/api/test.rst
+++ b/Documentation/dev-tools/kunit/api/test.rst
@@ -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:
diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst
index cacb35ec658d..7af7dec83646 100644
--- a/Documentation/dev-tools/kunit/index.rst
+++ b/Documentation/dev-tools/kunit/index.rst
@@ -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

base-commit: 2ab5d5e67f7ab2d2ecf67b8855ac65691f4e4b4d
-- 
2.33.0.1079.g6e70778dc9-goog

Re: [PATCH] Documentation: kunit: remove claims that kunit is a mocking framework

[David Gow]

On Tue, Oct 26, 2021 at 11:36 PM Daniel Latypov <dlatypov@google.com> wrote:
>
> 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>
> ---

Yeah: this definitely is a bit misleading. Thanks for updating it.

Reviewed-by: David Gow <davidgow@google.com>

Cheers,
-- David

>  Documentation/dev-tools/kunit/api/index.rst | 3 +--
>  Documentation/dev-tools/kunit/api/test.rst  | 3 +--
>  Documentation/dev-tools/kunit/index.rst     | 2 +-
>  3 files changed, 3 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/dev-tools/kunit/api/index.rst b/Documentation/dev-tools/kunit/api/index.rst
> index b33ad72bcf0b..3006cadcf44a 100644
> --- a/Documentation/dev-tools/kunit/api/index.rst
> +++ b/Documentation/dev-tools/kunit/api/index.rst
> @@ -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
> diff --git a/Documentation/dev-tools/kunit/api/test.rst b/Documentation/dev-tools/kunit/api/test.rst
> index aaa97f17e5b3..c5eca423e8b6 100644
> --- a/Documentation/dev-tools/kunit/api/test.rst
> +++ b/Documentation/dev-tools/kunit/api/test.rst
> @@ -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:
> diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst
> index cacb35ec658d..7af7dec83646 100644
> --- a/Documentation/dev-tools/kunit/index.rst
> +++ b/Documentation/dev-tools/kunit/index.rst
> @@ -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
>
> base-commit: 2ab5d5e67f7ab2d2ecf67b8855ac65691f4e4b4d
> --
> 2.33.0.1079.g6e70778dc9-goog
>

Re: [PATCH] Documentation: kunit: remove claims that kunit is a mocking framework

[Brendan Higgins]

On Tue, Oct 26, 2021 at 11:36 AM Daniel Latypov <dlatypov@google.com> wrote:
>
> 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: Brendan Higgins <brendanhiggins@google.com>