linux-kernel - Re: [PATCH] Documentation: Kunit: Fix example with compilation error

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ba474460-6035-90d8-651a-8b1bc60ecea9@riseup.net>
Date:   Sat, 2 Jul 2022 10:35:20 -0300
From:   Maíra Canal <mairacanal@...eup.net>
To:     David Gow <davidgow@...gle.com>
Cc:     Brendan Higgins <brendanhiggins@...gle.com>,
        Jonathan Corbet <corbet@....net>,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@...r.kernel.org>,
        KUnit Development <kunit-dev@...glegroups.com>,
        "open list:DOCUMENTATION" <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] Documentation: Kunit: Fix example with compilation error

On 7/2/22 01:32, David Gow wrote:
> On Sat, Jul 2, 2022 at 2:17 AM Maíra Canal <mairacanal@...eup.net> wrote:
>>
>> The Parameterized Testing example contains a compilation error, as the
>> signature for the description helper function should be void(*)(struct
>> sha1_test_case *, char *), so the struct should not be const. This is
>> warned by Clang:
>>
>> error: initialization of ‘void (*)(struct sha1_test_case *, char *)’
>> from incompatible pointer type ‘void (*)(const struct sha1_test_case *,
>> char *)’ [-Werror=incompatible-pointer-types]
>>     33 | KUNIT_ARRAY_PARAM(sha1, cases, case_to_desc);
>>        |                                ^~~~~~~~~~~~
>> ../include/kunit/test.h:1339:70: note: in definition of macro
>> ‘KUNIT_ARRAY_PARAM’
>> 1339 |                         void (*__get_desc)(typeof(__next), char *) = get_desc; \
>>
>> Signed-off-by: Maíra Canal <mairacanal@...eup.net>
>> ---
> 
> Thanks for catching this. The change to the documentation looks good,
> but it may be better to change the array to be:
> const struct cases[] = { ... }

I missed that! Would you rather that I change it on a v2?

Best Regards,
- Maíra Canal

> 
> That matches most of the existing uses of this, such as the mctp test,
> and encourages the use of const in cases (like the example) where it
> makes sense.
> 
> I'm okay with it either way, though: they're both valid.
> 
> Reviewed-by: David Gow <davidgow@...gle.com>
> 
> Cheers,
> -- David
> 
>>  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 d62a04255c2e..8e72fb277058 100644
>> --- a/Documentation/dev-tools/kunit/usage.rst
>> +++ b/Documentation/dev-tools/kunit/usage.rst
>> @@ -517,7 +517,7 @@ By reusing the same ``cases`` array from above, we can write the test as a
>>         };
>>
>>         // Need a helper function to generate a name for each test case.
>> -       static void case_to_desc(const struct sha1_test_case *t, char *desc)
>> +       static void case_to_desc(struct sha1_test_case *t, char *desc)
>>         {
>>                 strcpy(desc, t->str);
>>         }
>> --
>> 2.36.1
>>
>> --