Commit 2be32bbe authored by Eric Chan's avatar Eric Chan Committed by Shuah Khan
Browse files

kunit: Fix the comment of KUNIT_ASSERT_STRNEQ as assertion 



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: default avatarEric Chan <ericchancf@google.com>
Reviewed-by: default avatarDavid Gow <davidgow@google.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 7554a7b9

include/kunit/test.h

+2 −2
Original line number Diff line number Diff line
@@ -1455,12 +1455,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.