Re: [PATCH v13 27/39] dyndbg-API: promote DYNAMIC_DEBUG_CLASSMAP_PARAM to API

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] dyndbg: wrong function name in param_set_dyndbg_module_classes() kernel-doc
--

commit 43feafd46a08a5ee8ddfaa269bc39a26e9e8a8a4
Author: Jim Cromie <jim.cromie@gmail.com>

dyndbg-API: promote DYNAMIC_DEBUG_CLASSMAP_PARAM to API

This commit moves the DYNAMIC_DEBUG_CLASSMAP_PARAM macro from
test_dynamic_debug.c into dynamic_debug.h, splits it into
DYNAMIC_DEBUG_CLASSMAP_PARAM and DYNAMIC_DEBUG_CLASSMAP_PARAM_REF, and adds
fallback definitions for !CONFIG_DYNAMIC_DEBUG.

> diff --git a/lib/dynamic_debug.c b/lib/dynamic_debug.c
> index 1983f672dcfb2..8d9eb7dc09995 100644
> --- a/lib/dynamic_debug.c
> +++ b/lib/dynamic_debug.c
> @@ -698,9 +698,42 @@ static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,

[ ... ]

> +/**
> + * param_set_dyndbg_classes - class FOO >control
> + * @instr: string echo>d to sysfs, input depends on map_type
> + * @kp:    kp->arg has state: bits/lvl, map, map_type
> + * @mod_name: module name or null for all modules with the classes
> + *
> + * Enable/disable prdbgs by their class, as given in the arguments to
> + * DECLARE_DYNDBG_CLASSMAP.  For LEVEL map-types, enforce relative
> + * levels by bitpos.
> + *
> + * Returns: 0 or <0 if error.
>   */
>  static int param_set_dyndbg_module_classes(const char *instr,
>  					   const struct kernel_param *kp,
>  					   const char *mod_name)

[Severity: Low]
Should the kernel-doc identifier here be param_set_dyndbg_module_classes
instead of param_set_dyndbg_classes?

With the comment converted to a /** kernel-doc block in lib/dynamic_debug.c,
building with W=1 causes scripts/kernel-doc (via dump_function() in
tools/lib/python/kdoc/kdoc_parser.py) to warn that it was expecting a
prototype for param_set_dyndbg_classes() when encountering the prototype for
param_set_dyndbg_module_classes().

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261027-dd-cmap-part2-clean-v13-0-9267923be612@gmail.com?part=27