From: Shuah Khan <skhan@linuxfoundation.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Alan Maguire <alan.maguire@oracle.com>,
Brendan Higgins <brendanhiggins@google.com>,
Iurii Zaikin <yzaikin@google.com>,
Kees Cook <keescook@chromium.org>,
Stephen Boyd <sboyd@kernel.org>,
kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org,
linux-kselftest@vger.kernel.org,
Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: [PATCH v3 5/6] kunit: test: fix remaining kernel-doc warnings
Date: Mon, 26 Oct 2020 13:29:42 -0600 [thread overview]
Message-ID: <7d7b8947-38db-2b96-21ca-78428b01365b@linuxfoundation.org> (raw)
In-Reply-To: <1c36d295423c5c20c21a7edede0eb29e338dd62a.1603282193.git.mchehab+huawei@kernel.org>
On 10/21/20 6:17 AM, Mauro Carvalho Chehab wrote:
> test.h still produce three warnings:
>
> include/kunit/test.h:282: warning: Function parameter or member '__suites' not described in 'kunit_test_suites_for_module'
> include/kunit/test.h:282: warning: Excess function parameter 'suites_list' description in 'kunit_test_suites_for_module'
> include/kunit/test.h:314: warning: Excess function parameter 'suites' description in 'kunit_test_suites'
>
> They're all due to errors at kernel-doc markups. Update them.
>
> It should be noticed that this patch moved a kernel-doc
> markup that were located at the wrong place, and using a wrong
> name. Kernel-doc only supports kaving the markup just before the
> function/macro declaration. Placing it elsewhere will make it do
> wrong assumptions.
>
> Fixes: aac35468ca20 ("kunit: test: create a single centralized executor for all tests")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> include/kunit/test.h | 16 ++++++++--------
> 1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/include/kunit/test.h b/include/kunit/test.h
> index a423fffefea0..14224baca3be 100644
> --- a/include/kunit/test.h
> +++ b/include/kunit/test.h
Applied to linux-kselftest kunit-fixes branch
after auto-fixing the checkpatch warn
WARNING: please, no space before tabs
#108: FILE: include/kunit/test.h:258:
+ * ^I^I^I &struct kunit_suite with KUnit.$
total: 0 errors, 1 warnings, 45 lines checked
thanks,
-- Shuah
next prev parent reply other threads:[~2020-10-26 19:29 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-21 12:17 [PATCH v3 0/6] Documentation build fixes against upstream Mauro Carvalho Chehab
2020-10-21 12:17 ` [PATCH v3 1/6] drm: amdgpu: kernel-doc: update some adev parameters Mauro Carvalho Chehab
2020-10-21 18:37 ` Alex Deucher
2020-10-21 12:17 ` [PATCH v3 2/6] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-10-21 3:27 ` Boqun Feng
2020-10-21 12:17 ` [PATCH v3 3/6] locking/refcount: move kernel-doc markups to the proper place Mauro Carvalho Chehab
2020-10-21 12:17 ` [PATCH v3 4/6] IB/srpt: docs: add a description for cq_size member Mauro Carvalho Chehab
2020-10-22 0:25 ` Bart Van Assche
2020-10-21 12:17 ` [PATCH v3 5/6] kunit: test: fix remaining kernel-doc warnings Mauro Carvalho Chehab
2020-10-21 21:12 ` Brendan Higgins
2020-10-26 19:29 ` Shuah Khan [this message]
2020-10-21 12:17 ` [PATCH v3 6/6] docs: fs: api-summary.rst: get rid of kernel-doc include Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7d7b8947-38db-2b96-21ca-78428b01365b@linuxfoundation.org \
--to=skhan@linuxfoundation.org \
--cc=alan.maguire@oracle.com \
--cc=brendanhiggins@google.com \
--cc=corbet@lwn.net \
--cc=keescook@chromium.org \
--cc=kunit-dev@googlegroups.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-kselftest@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=sboyd@kernel.org \
--cc=yzaikin@google.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).