Re: [PATCH v3 5/6] kunit: test: fix remaining kernel-doc warnings
From: Shuah Khan <skhan@linuxfoundation.org>
Date: 2020-10-26 19:29:46
Also in:
linux-kselftest, lkml
On 10/21/20 6:17 AM, Mauro Carvalho Chehab wrote:
quoted hunk ↗ jump to hunk
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