linux-kernel - Re: [PATCH] kunit: Documentation: Fix a kernel-doc reference

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] [day] [month] [year] [list]

Message-ID: <CAFd5g47AVBUV8qdWF0B_oY8EMwTE85apv3b+nSsQu=bOZV=o4g@mail.gmail.com>
Date:   Wed, 6 Jul 2022 14:46:00 -0400
From:   Brendan Higgins <brendanhiggins@...gle.com>
To:     David Gow <davidgow@...gle.com>
Cc:     Shuah Khan <skhan@...uxfoundation.org>,
        Jonathan Corbet <corbet@....net>,
        Daniel Latypov <dlatypov@...gle.com>,
        Martin Fernandez <martin.fernandez@...ypsium.com>,
        Kees Cook <keescook@...omium.org>,
        KUnit Development <kunit-dev@...glegroups.com>,
        linux-kselftest@...r.kernel.org, linux-doc@...r.kernel.org,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] kunit: Documentation: Fix a kernel-doc reference

On Sat, Jul 2, 2022 at 1:12 AM David Gow <davidgow@...gle.com> wrote:
>
> When building the KUnit documentation, the reference to
> kunit_test_suites in the kunit_test_init_section_suites kernel-doc
> comment gives an error:
> Documentation/dev-tools/kunit/api/test:9: ./include/kunit/test.h:323: WARNING: Inline interpreted text or phrase reference start-string without end-string.
>
> This is because the reference is mixing two function reference styles:
> adding an '&' to the front, and "()" to the end. The latter is neater,
> so get rid of the '&'.
>
> Fixes: 9bf2eed995f9 ("kunit: add support for kunit_suites that reference init code")
> Signed-off-by: David Gow <davidgow@...gle.com>

Reviewed-by: Brendan Higgins <brendanhiggins@...gle.com>