2022-02-07 22:53:58

by Akira Kawata

[permalink] [raw]
Subject: [PATCH v1] Documentation: KUnit: Fix usage bug

Fix a bug of kunit documentation.
Link: https://bugzilla.kernel.org/show_bug.cgi?id=205773

: Quoting Steve Pfetsch:
:
: kunit documentation is incorrect:
: https://kunit.dev/third_party/stable_kernel/docs/usage.html
: struct rectangle *self = container_of(this, struct shape, parent);
:
:
: Shouldn't it be:
: struct rectangle *self = container_of(this, struct rectangle, parent);
: ?

Signed-off-by: Akira Kawata <[email protected]>
---
Documentation/dev-tools/kunit/usage.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 76af931a332c..1c83e7d60a8a 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -242,7 +242,7 @@ example:

int rectangle_area(struct shape *this)
{
- struct rectangle *self = container_of(this, struct shape, parent);
+ struct rectangle *self = container_of(this, struct rectangle, parent);

return self->length * self->width;
};
--
2.25.1



2022-02-09 07:18:48

by Brendan Higgins

[permalink] [raw]
Subject: Re: [PATCH v1] Documentation: KUnit: Fix usage bug

On Mon, Feb 7, 2022 at 6:21 AM Akira Kawata <[email protected]> wrote:
>
> Fix a bug of kunit documentation.
> Link: https://bugzilla.kernel.org/show_bug.cgi?id=205773
>
> : Quoting Steve Pfetsch:
> :
> : kunit documentation is incorrect:
> : https://kunit.dev/third_party/stable_kernel/docs/usage.html
> : struct rectangle *self = container_of(this, struct shape, parent);
> :
> :
> : Shouldn't it be:
> : struct rectangle *self = container_of(this, struct rectangle, parent);
> : ?
>
> Signed-off-by: Akira Kawata <[email protected]>

Wow. I can't believe we let this go for this long...and even after
doing an *almost* complete rewrite of that page.

Anyway, thanks for fixing this!

Reviewed-by: Brendan Higgins <[email protected]>