Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
MIME-Version: 1.0
References: <20220702051205.3292468-1-davidgow@google.com>
In-Reply-To: <20220702051205.3292468-1-davidgow@google.com>
From:   Brendan Higgins <brendanhiggins@google.com>
Date:   Wed, 6 Jul 2022 14:46:00 -0400
Message-ID: <CAFd5g47AVBUV8qdWF0B_oY8EMwTE85apv3b+nSsQu=bOZV=o4g@mail.gmail.com>
Subject: Re: [PATCH] kunit: Documentation: Fix a kernel-doc reference
To:     David Gow <davidgow@google.com>
Cc:     Shuah Khan <skhan@linuxfoundation.org>,
        Jonathan Corbet <corbet@lwn.net>,
        Daniel Latypov <dlatypov@google.com>,
        Martin Fernandez <martin.fernandez@eclypsium.com>,
        Kees Cook <keescook@chromium.org>,
        KUnit Development <kunit-dev@googlegroups.com>,
        linux-kselftest@vger.kernel.org, linux-doc@vger.kernel.org,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Sat, Jul 2, 2022 at 1:12 AM David Gow <davidgow@google.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@google.com>

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