Re: [PATCH v4] x86/resctrl: Fix kernel-doc in internal.h

[Reinette Chatre]

Hi Fabio,

On 6/18/2021 3:32 PM, Fabio M. De Francesco wrote:
> Add description of undocumented parameters. Issues detected by
> scripts/kernel-doc.
>
> Signed-off-by: Fabio M. De Francesco <fmdefrancesco@xxxxxxxxx>
> ---

Before this patch:
$ scripts/kernel-doc -none arch/x86/kernel/cpu/resctrl/internal.h
arch/x86/kernel/cpu/resctrl/internal.h:78: warning: Function parameter 
or member 'list' not described in 'mon_evt'
arch/x86/kernel/cpu/resctrl/internal.h:93: warning: Function parameter 
or member 'priv' not described in 'mon_data_bits'
arch/x86/kernel/cpu/resctrl/internal.h:93: warning: Function parameter 
or member 'u' not described in 'mon_data_bits'
arch/x86/kernel/cpu/resctrl/internal.h:141: warning: Enum value 
'RDT_NUM_MODES' not described in enum 'rdtgrp_mode'
arch/x86/kernel/cpu/resctrl/internal.h:155: warning: Function parameter 
or member 'mon_data_kn' not described in 'mongroup'
arch/x86/kernel/cpu/resctrl/internal.h:298: warning: Function parameter 
or member 'prev_msr' not described in 'mbm_state'
arch/x86/kernel/cpu/resctrl/internal.h:298: warning: Function parameter 
or member 'prev_bw' not described in 'mbm_state'
arch/x86/kernel/cpu/resctrl/internal.h:298: warning: Function parameter 
or member 'delta_bw' not described in 'mbm_state'
arch/x86/kernel/cpu/resctrl/internal.h:298: warning: Function parameter 
or member 'delta_comp' not described in 'mbm_state'
arch/x86/kernel/cpu/resctrl/internal.h:492: warning: Function parameter 
or member 'membw' not described in 'rdt_resource'
arch/x86/kernel/cpu/resctrl/internal.h:492: warning: Function parameter 
or member 'mbm_width' not described in 'rdt_resource'
$

After this patch:
$ scripts/kernel-doc -none arch/x86/kernel/cpu/resctrl/internal.h
$

Thank you very much.

Reviewed-by: Reinette Chatre <reinette.chatre@xxxxxxxxx>

Reinette