| Message ID | 1c36d295423c5c20c21a7edede0eb29e338dd62a.1603282193.git.mchehab+huawei@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | Shuah Khan |
| Headers | show |
| Series | Documentation build fixes against upstream | expand |
On Wed, Oct 21, 2020 at 5:17 AM Mauro Carvalho Chehab <mchehab+huawei@kernel.org> 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> Reviewed-by: Brendan Higgins <brendanhiggins@google.com> Tested-by: Brendan Higgins <brendanhiggins@google.com>
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
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 @@ -252,13 +252,14 @@ static inline int kunit_run_all_tests(void) } #endif /* IS_BUILTIN(CONFIG_KUNIT) */ +#ifdef MODULE /** - * kunit_test_suites() - used to register one or more &struct kunit_suite - * with KUnit. + * kunit_test_suites_for_module() - used to register one or more + * &struct kunit_suite with KUnit. * - * @suites_list...: a statically allocated list of &struct kunit_suite. + * @__suites: a statically allocated list of &struct kunit_suite. * - * Registers @suites_list with the test framework. See &struct kunit_suite for + * Registers @__suites with the test framework. See &struct kunit_suite for * more information. * * If a test suite is built-in, module_init() gets translated into @@ -267,7 +268,6 @@ static inline int kunit_run_all_tests(void) * module_{init|exit} functions for the builtin case when registering * suites via kunit_test_suites() below. */ -#ifdef MODULE #define kunit_test_suites_for_module(__suites) \ static int __init kunit_test_suites_init(void) \ { \ @@ -294,7 +294,7 @@ static inline int kunit_run_all_tests(void) * kunit_test_suites() - used to register one or more &struct kunit_suite * with KUnit. * - * @suites: a statically allocated list of &struct kunit_suite. + * @__suites: a statically allocated list of &struct kunit_suite. * * Registers @suites with the test framework. See &struct kunit_suite for * more information. @@ -308,10 +308,10 @@ static inline int kunit_run_all_tests(void) * module. * */ -#define kunit_test_suites(...) \ +#define kunit_test_suites(__suites...) \ __kunit_test_suites(__UNIQUE_ID(array), \ __UNIQUE_ID(suites), \ - __VA_ARGS__) + ##__suites) #define kunit_test_suite(suite) kunit_test_suites(&suite)
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(-)