diff mbox series

kunit: Fix kernel-doc for EXPORT_SYMBOL_IF_KUNIT

Message ID 20240829183150.1616-1-michal.wajdeczko@intel.com
State Accepted
Commit a4311c274e08001b129bd5ffd2a41dcbd3e0a855
Headers show
Series kunit: Fix kernel-doc for EXPORT_SYMBOL_IF_KUNIT | expand

Commit Message

Michal Wajdeczko Aug. 29, 2024, 6:31 p.m. UTC
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>
---
Cc: Rae Moar <rmoar@google.com>
Cc: David Gow <davidgow@google.com>
---
 include/kunit/visibility.h | 1 +
 1 file changed, 1 insertion(+)

Comments

David Gow Sept. 4, 2024, 9:24 p.m. UTC | #1
On Thu, 29 Aug 2024 at 11:32, Michal Wajdeczko
<michal.wajdeczko@intel.com> wrote:
>
> 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>
> ---
> Cc: Rae Moar <rmoar@google.com>
> Cc: David Gow <davidgow@google.com>
> ---

Acked-by: David Gow <davidgow@google.com>

Thanks,
-- David
diff mbox series

Patch

diff --git a/include/kunit/visibility.h b/include/kunit/visibility.h
index 0dfe35feeec6..efff77b58dd6 100644
--- a/include/kunit/visibility.h
+++ b/include/kunit/visibility.h
@@ -22,6 +22,7 @@ 
      * EXPORTED_FOR_KUNIT_TESTING namespace only if CONFIG_KUNIT is
      * enabled. Must use MODULE_IMPORT_NS(EXPORTED_FOR_KUNIT_TESTING)
      * in test file in order to use symbols.
+     * @symbol: the symbol identifier to export
      */
     #define EXPORT_SYMBOL_IF_KUNIT(symbol) EXPORT_SYMBOL_NS(symbol, \
 	    EXPORTED_FOR_KUNIT_TESTING)