Re: [PATCH] kunit: Fix kernel-doc for EXPORT_SYMBOL_IF_KUNIT

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Aug 29, 2024 at 11:32 AM Michal Wajdeczko
<michal.wajdeczko@xxxxxxxxx> 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@xxxxxxxxx>

Hello!

This looks good to me. Thanks for adding this. We will need to do a
patch on making this recognized as a kernel-doc at some point.

Reviewed-by: Rae Moar <rmoar@xxxxxxxxxx>

Thanks!
-Rae

> ---
> Cc: Rae Moar <rmoar@xxxxxxxxxx>
> Cc: David Gow <davidgow@xxxxxxxxxx>
> ---
>  include/kunit/visibility.h | 1 +
>  1 file changed, 1 insertion(+)
>
> 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)
> --
> 2.43.0
>
> --
> You received this message because you are subscribed to the Google Groups "KUnit Development" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@xxxxxxxxxxxxxxxx.
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20240829183150.1616-1-michal.wajdeczko%40intel.com.





[Index of Archives]     [Linux Wireless]     [Linux Kernel]     [ATH6KL]     [Linux Bluetooth]     [Linux Netdev]     [Kernel Newbies]     [Share Photos]     [IDE]     [Security]     [Git]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux ATA RAID]     [Samba]     [Device Mapper]

  Powered by Linux