[tj-cgroup:for-next 7/7] kernel/cgroup/rstat.c:334: warning: Function parameter or struct member 'cgrp' not described in 'cgroup_rstat_flush_release'

[tj-cgroup:for-next 7/7] kernel/cgroup/rstat.c:334: warning: Function parameter or struct member 'cgrp' not described in 'cgroup_rstat_flush_release'

[kernel test robot]

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup.git for-next
head:   fc29e04ae1ad4c99422c0b8ae4b43cfe99c70429
commit: fc29e04ae1ad4c99422c0b8ae4b43cfe99c70429 [7/7] cgroup/rstat: add cgroup_rstat_lock helpers and tracepoints
config: parisc-defconfig (https://download.01.org/0day-ci/archive/20240417/202404170821.HwZGISTY-lkp@intel.com/config)
compiler: hppa-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240417/202404170821.HwZGISTY-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/202404170821.HwZGISTY-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> kernel/cgroup/rstat.c:334: warning: Function parameter or struct member 'cgrp' not described in 'cgroup_rstat_flush_release'


vim +334 kernel/cgroup/rstat.c

6162cef0f741c7 Tejun Heo              2018-04-26  328  
6162cef0f741c7 Tejun Heo              2018-04-26  329  /**
6162cef0f741c7 Tejun Heo              2018-04-26  330   * cgroup_rstat_flush_release - release cgroup_rstat_flush_hold()
6162cef0f741c7 Tejun Heo              2018-04-26  331   */
fc29e04ae1ad4c Jesper Dangaard Brouer 2024-04-16  332  void cgroup_rstat_flush_release(struct cgroup *cgrp)
0fa294fb1985c0 Tejun Heo              2018-04-26  333  	__releases(&cgroup_rstat_lock)
6162cef0f741c7 Tejun Heo              2018-04-26 @334  {
fc29e04ae1ad4c Jesper Dangaard Brouer 2024-04-16  335  	__cgroup_rstat_unlock(cgrp, -1);
6162cef0f741c7 Tejun Heo              2018-04-26  336  }
6162cef0f741c7 Tejun Heo              2018-04-26  337  

:::::: The code at line 334 was first introduced by commit
:::::: 6162cef0f741c70eb0c7ac7e6142f85808d8abc4 cgroup: Factor out and expose cgroup_rstat_*() interface functions

:::::: TO: Tejun Heo <tj@kernel.org>
:::::: CC: Tejun Heo <tj@kernel.org>

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

[PATCH] cgroup/rstat: desc member cgrp in cgroup_rstat_flush_release

[Jesper Dangaard Brouer]

Recent change to cgroup_rstat_flush_release added a
parameter cgrp, which is used by tracepoint to correlate
with other tracepoints that also have this cgrp.

The kernel test robot detected kernel doc was missing
a description of this member.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202404170821.HwZGISTY-lkp@intel.com/
Signed-off-by: Jesper Dangaard Brouer <hawk@kernel.org>
---
 kernel/cgroup/rstat.c |    1 +
 1 file changed, 1 insertion(+)

TJ feel free to squash this into other patch

diff --git a/kernel/cgroup/rstat.c b/kernel/cgroup/rstat.c
index 8c71af67b197..4aebf43882e2 100644
--- a/kernel/cgroup/rstat.c
+++ b/kernel/cgroup/rstat.c
@@ -384,6 +384,7 @@ int cgroup_rstat_flush_hold(struct cgroup *cgrp)
 
 /**
  * cgroup_rstat_flush_release - release cgroup_rstat_flush_hold()
+ * @cgrp: cgroup used by tracepoint
  */
 void cgroup_rstat_flush_release(struct cgroup *cgrp)
 	__releases(&cgroup_rstat_lock)

Re: [PATCH] cgroup/rstat: desc member cgrp in cgroup_rstat_flush_release

[Tejun Heo]

On Wed, Apr 17, 2024 at 12:59:46PM +0200, Jesper Dangaard Brouer wrote:
> Recent change to cgroup_rstat_flush_release added a
> parameter cgrp, which is used by tracepoint to correlate
> with other tracepoints that also have this cgrp.
> 
> The kernel test robot detected kernel doc was missing
> a description of this member.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202404170821.HwZGISTY-lkp@intel.com/
> Signed-off-by: Jesper Dangaard Brouer <hawk@kernel.org>

Applied to cgroup/for-6.10.

Thanks.

-- 
tejun