Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider: - [Low] docs/dyndbg: incorrect signature for DYNAMIC_DEBUG_CLASSMAP_PARAM - [Low] docs/dyndbg: commit message count mismatch for API macros --
commit 28be193f6b722396acbf0216c1b36e74ba099d0b Author: Jim Cromie <[email protected]> docs/dyndbg: add classmap info to howto Describes the dynamic debug classmaps API and macro usage in the howto documentation. > Describe the 3 API macros providing dynamic_debug's classmaps > > DYNAMIC_DEBUG_CLASSMAP_DEFINE - create & export a classmap > DYNAMIC_DEBUG_CLASSMAP_USE - refer to exported map > DYNAMIC_DEBUG_CLASSMAP_PARAM - bind control param to the classmap > DYNAMIC_DEBUG_CLASSMAP_PARAM_REF + use module's storage - __drm_debug [Severity: Low] This isn't a bug, but the commit message states it will describe 3 API macros while actually listing and describing 4 of them. Should this count be updated to match the list? > diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst > b/Documentation/admin-guide/dynamic-debug-howto.rst > index a8962ab22aaf0..f5b1470a4b881 100644 > --- a/Documentation/admin-guide/dynamic-debug-howto.rst > +++ b/Documentation/admin-guide/dynamic-debug-howto.rst [ ... ] > +Dynamic Debug Classmap API > +========================== > + > +DYNAMIC_DEBUG_CLASSMAP_DEFINE(clname,type,_base,classnames) - this maps > +classnames (a list of strings) onto class-ids consecutively, starting > +at _base. > + > +DYNAMIC_DEBUG_CLASSMAP_USE(clname) & _USE_(clname,_base) - modules > +call this to refer to the var _DEFINEd elsewhere (and exported). > + > +DYNAMIC_DEBUG_CLASSMAP_PARAM(clname) - creates the sysfs/kparam, > +maps/exposes bits 0..N as class-names. [Severity: Low] Does DYNAMIC_DEBUG_CLASSMAP_PARAM only take one argument here? The kernel macro defined in include/linux/dynamic_debug.h requires three arguments: _name, _var, and _flags. Could this discrepancy mislead developers attempting to use the API? -- Sashiko AI review ยท https://sashiko.dev/#/patchset/[email protected]?part=32
