Documentation: KUnit: reword description of assertions
authorDaniel Latypov <dlatypov@google.com>
Fri, 11 Nov 2022 18:29:05 +0000 (10:29 -0800)
committerShuah Khan <skhan@linuxfoundation.org>
Mon, 12 Dec 2022 21:13:47 +0000 (14:13 -0700)
commitec0a42a17e463ee5b1ebd2d60337e8ae8e5ace2b
treeb8a5744c0b3db2b5abac47fb48b3f518d21cf6ff
parent65c48a48ead042856525b92cedf673d2bf5bdfc9
Documentation: KUnit: reword description of assertions

The existing wording implies that kunit_kmalloc_array() is "the method
under test". We're actually testing the sort() function in that example.
This is because the example was changed in commit 953574390634
("Documentation: KUnit: Rework writing page to focus on writing tests"),
but the wording was not.

Also add a `note` telling people they can use the KUNIT_ASSERT_EQ()
macros from any function. Some users might be coming from a framework
like gUnit where that'll compile but silently do the wrong thing.

Signed-off-by: Daniel Latypov <dlatypov@google.com>
Reviewed-by: Sadiya Kazi <sadiyakazi@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
Documentation/dev-tools/kunit/usage.rst