| Message ID | 20240711193917.109380-1-ericchancf@google.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 2be32bbe6989e071aea1767cb54c7528a0dac07f |
| Delegated to: | Brendan Higgins |
| Headers | show |
| Series | kunit: Improve the readability and functionality of macro | expand |
On Fri, 12 Jul 2024 at 03:39, Eric Chan <ericchancf@google.com> wrote: > > The current comment for KUNIT_ASSERT_STRNEQ incorrectly describes it as > an expectation. Since KUNIT_ASSERT_STRNEQ is an assertion, updates the > comment to correctly refer to it as such. > > Signed-off-by: Eric Chan <ericchancf@google.com> > --- Reviewed-by: David Gow <davidgow@google.com> Thanks, -- David > include/kunit/test.h | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/include/kunit/test.h b/include/kunit/test.h > index 61637ef32302..87a232421089 100644 > --- a/include/kunit/test.h > +++ b/include/kunit/test.h > @@ -1420,12 +1420,12 @@ do { \ > ##__VA_ARGS__) > > /** > - * KUNIT_ASSERT_STRNEQ() - Expects that strings @left and @right are not equal. > + * KUNIT_ASSERT_STRNEQ() - An assertion that strings @left and @right are not equal. > * @test: The test context object. > * @left: an arbitrary expression that evaluates to a null terminated string. > * @right: an arbitrary expression that evaluates to a null terminated string. > * > - * Sets an expectation that the values that @left and @right evaluate to are > + * Sets an assertion that the values that @left and @right evaluate to are > * not equal. This is semantically equivalent to > * KUNIT_ASSERT_TRUE(@test, strcmp((@left), (@right))). See KUNIT_ASSERT_TRUE() > * for more information. > -- > 2.45.2.993.g49e7a77208-goog >
diff --git a/include/kunit/test.h b/include/kunit/test.h index 61637ef32302..87a232421089 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -1420,12 +1420,12 @@ do { \ ##__VA_ARGS__) /** - * KUNIT_ASSERT_STRNEQ() - Expects that strings @left and @right are not equal. + * KUNIT_ASSERT_STRNEQ() - An assertion that strings @left and @right are not equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a null terminated string. * @right: an arbitrary expression that evaluates to a null terminated string. * - * Sets an expectation that the values that @left and @right evaluate to are + * Sets an assertion that the values that @left and @right evaluate to are * not equal. This is semantically equivalent to * KUNIT_ASSERT_TRUE(@test, strcmp((@left), (@right))). See KUNIT_ASSERT_TRUE() * for more information.
The current comment for KUNIT_ASSERT_STRNEQ incorrectly describes it as an expectation. Since KUNIT_ASSERT_STRNEQ is an assertion, updates the comment to correctly refer to it as such. Signed-off-by: Eric Chan <ericchancf@google.com> --- include/kunit/test.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)