arch/x86/kernel/cpu/resctrl/monitor.c:38: warning: Cannot understand * @rmid_free_lru A least recently used list of free RMIDs

[kernel test robot <lkp@intel.com>]

Hi Johannes,

FYI, the error/warning was bisected to this commit, please ignore it if it's irrelevant.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head:   b78b18fb8ee19f7a05f20c3abc865b3bfe182884
commit: e6d429313ea5c776d2e76b4494df69102e6b7115 x86/resctrl: Avoid confusion over the new X86_RESCTRL config
date:   4 years, 8 months ago
config: x86_64-randconfig-003-20230909 (https://download.01.org/0day-ci/archive/20231006/202310062356.lX3xpLP9-lkp@intel.com/config)
compiler: gcc-9 (Debian 9.3.0-22) 9.3.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231006/202310062356.lX3xpLP9-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202310062356.lX3xpLP9-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> arch/x86/kernel/cpu/resctrl/monitor.c:38: warning: Cannot understand  * @rmid_free_lru    A least recently used list of free RMIDs
    on line 38 - I thought it was a doc line
>> arch/x86/kernel/cpu/resctrl/monitor.c:45: warning: Cannot understand  * @rmid_limbo_count     count of currently unused but (potentially)
    on line 45 - I thought it was a doc line
>> arch/x86/kernel/cpu/resctrl/monitor.c:54: warning: Cannot understand  * @rmid_entry - The entry in the limbo and free lists.
    on line 54 - I thought it was a doc line
--
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:803: warning: Function parameter or member 'of' not described in 'rdt_bit_usage_show'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:803: warning: Function parameter or member 'seq' not described in 'rdt_bit_usage_show'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:803: warning: Function parameter or member 'v' not described in 'rdt_bit_usage_show'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:1148: warning: Function parameter or member 'rdtgrp' not described in 'rdtgroup_mode_test_exclusive'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:1181: warning: Function parameter or member 'of' not described in 'rdtgroup_mode_write'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:1181: warning: Function parameter or member 'buf' not described in 'rdtgroup_mode_write'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:1181: warning: Function parameter or member 'nbytes' not described in 'rdtgroup_mode_write'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:1181: warning: Function parameter or member 'off' not described in 'rdtgroup_mode_write'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:1290: warning: Function parameter or member 'of' not described in 'rdtgroup_size_show'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:1290: warning: Function parameter or member 's' not described in 'rdtgroup_size_show'
>> arch/x86/kernel/cpu/resctrl/rdtgroup.c:1290: warning: Function parameter or member 'v' not described in 'rdtgroup_size_show'
   arch/x86/kernel/cpu/resctrl/rdtgroup.c:2483: warning: Function parameter or member 'rdtgrp' not described in 'rdtgroup_init_alloc'


vim +38 arch/x86/kernel/cpu/resctrl/monitor.c

6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  36  
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  37  /**
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25 @38   * @rmid_free_lru    A least recently used list of free RMIDs
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  39   *     These RMIDs are guaranteed to have an occupancy less than the
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  40   *     threshold occupancy
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  41   */
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  42  static LIST_HEAD(rmid_free_lru);
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  43  
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  44  /**
24247aeeabe99e arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-08-15 @45   * @rmid_limbo_count     count of currently unused but (potentially)
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  46   *     dirty RMIDs.
24247aeeabe99e arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-08-15  47   *     This counts RMIDs that no one is currently using but that
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  48   *     may have a occupancy value > intel_cqm_threshold. User can change
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  49   *     the threshold occupancy value.
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  50   */
5fd88b60e11b7d arch/x86/kernel/cpu/intel_rdt_monitor.c Colin Ian King 2017-10-02  51  static unsigned int rmid_limbo_count;
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  52  
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  53  /**
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25 @54   * @rmid_entry - The entry in the limbo and free lists.
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  55   */
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  56  static struct rmid_entry	*rmid_ptrs;
6a445edce65781 arch/x86/kernel/cpu/intel_rdt_monitor.c Vikas Shivappa 2017-07-25  57  

:::::: The code at line 38 was first introduced by commit
:::::: 6a445edce657810992594c7b9e679219aaf78ad9 x86/intel_rdt/cqm: Add RDT monitoring initialization

:::::: TO: Vikas Shivappa <vikas.shivappa@linux.intel.com>
:::::: CC: Thomas Gleixner <tglx@linutronix.de>

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki