Documentation: kunit: Clean up some string casts in examples
authorDavid Gow <davidgow@google.com>
Thu, 13 May 2021 19:31:57 +0000 (12:31 -0700)
committerShuah Khan <skhan@linuxfoundation.org>
Wed, 23 Jun 2021 22:36:29 +0000 (16:36 -0600)
As the type checking is no longer excessively strict, get rid of the
unsightly (char*) casts -- and comment discussing them -- from the KUnit
usage page.

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

index 888c341..97c9a31 100644 (file)
@@ -465,10 +465,9 @@ fictitious example for ``sha1sum(1)``
 
 .. code-block:: c
 
-       /* Note: the cast is to satisfy overly strict type-checking. */
        #define TEST_SHA1(in, want) \
                sha1sum(in, out); \
-               KUNIT_EXPECT_STREQ_MSG(test, (char *)out, want, "sha1sum(%s)", in);
+               KUNIT_EXPECT_STREQ_MSG(test, out, want, "sha1sum(%s)", in);
 
        char out[40];
        TEST_SHA1("hello world",  "2aae6c35c94fcfb415dbe95f408b9ce91ee846ed");
@@ -507,7 +506,7 @@ In some cases, it can be helpful to write a *table-driven test* instead, e.g.
        };
        for (i = 0; i < ARRAY_SIZE(cases); ++i) {
                sha1sum(cases[i].str, out);
-               KUNIT_EXPECT_STREQ_MSG(test, (char *)out, cases[i].sha1,
+               KUNIT_EXPECT_STREQ_MSG(test, out, cases[i].sha1,
                                      "sha1sum(%s)", cases[i].str);
        }
 
@@ -568,7 +567,7 @@ Reusing the same ``cases`` array from above, we can write the test as a
                struct sha1_test_case *test_param = (struct sha1_test_case *)(test->param_value);
 
                sha1sum(test_param->str, out);
-               KUNIT_EXPECT_STREQ_MSG(test, (char *)out, test_param->sha1,
+               KUNIT_EXPECT_STREQ_MSG(test, out, test_param->sha1,
                                      "sha1sum(%s)", test_param->str);
        }