Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

kunit: Fix kernel-doc for EXPORT_SYMBOL_IF_KUNIT

While kunit/visibility.h is today not included in any generated
kernel documentation, also likely due to the fact that none of the
existing comments are correctly recognized as kernel-doc, but once
we decide to add this header and fix the tool, there will be:

../include/kunit/visibility.h:61: warning: Function parameter or
struct member 'symbol' not described in 'EXPORT_SYMBOL_IF_KUNIT'

Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
Reviewed-by: Rae Moar <rmoar@google.com>
Acked-by: David Gow <davidgow@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>

authored by

Michal Wajdeczko and committed by
Shuah Khan
a4311c27 1757cc29

+1
+1
include/kunit/visibility.h
··· 22 22 * EXPORTED_FOR_KUNIT_TESTING namespace only if CONFIG_KUNIT is 23 23 * enabled. Must use MODULE_IMPORT_NS(EXPORTED_FOR_KUNIT_TESTING) 24 24 * in test file in order to use symbols. 25 + * @symbol: the symbol identifier to export 25 26 */ 26 27 #define EXPORT_SYMBOL_IF_KUNIT(symbol) EXPORT_SYMBOL_NS(symbol, \ 27 28 EXPORTED_FOR_KUNIT_TESTING)