2021-05-26 03:02:40

by Yang Li

[permalink] [raw]
Subject: [PATCH] cgroup: Fix kernel-doc

Fix function name in cgroup.c and rstat.c kernel-doc comment
to remove these warnings found by clang_w1.

kernel/cgroup/cgroup.c:2401: warning: expecting prototype for
cgroup_taskset_migrate(). Prototype was for cgroup_migrate_execute()
instead.
kernel/cgroup/rstat.c:233: warning: expecting prototype for
cgroup_rstat_flush_begin(). Prototype was for cgroup_rstat_flush_hold()
instead.

Reported-by: Abaci Robot <[email protected]>
Fixes: 'commit e595cd706982 ("cgroup: track migration context in cgroup_mgctx")'
Signed-off-by: Yang Li <[email protected]>
---
kernel/cgroup/cgroup.c | 2 +-
kernel/cgroup/rstat.c | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/kernel/cgroup/cgroup.c b/kernel/cgroup/cgroup.c
index 21ecc6e..fc344f4 100644
--- a/kernel/cgroup/cgroup.c
+++ b/kernel/cgroup/cgroup.c
@@ -2389,7 +2389,7 @@ struct task_struct *cgroup_taskset_next(struct cgroup_taskset *tset,
}

/**
- * cgroup_taskset_migrate - migrate a taskset
+ * cgroup_migrate_execute - migrate a taskset
* @mgctx: migration context
*
* Migrate tasks in @mgctx as setup by migration preparation functions.
diff --git a/kernel/cgroup/rstat.c b/kernel/cgroup/rstat.c
index cee265c..7f0e589 100644
--- a/kernel/cgroup/rstat.c
+++ b/kernel/cgroup/rstat.c
@@ -220,7 +220,7 @@ void cgroup_rstat_flush_irqsafe(struct cgroup *cgrp)
}

/**
- * cgroup_rstat_flush_begin - flush stats in @cgrp's subtree and hold
+ * cgroup_rstat_flush_hold - flush stats in @cgrp's subtree and hold
* @cgrp: target cgroup
*
* Flush stats in @cgrp's subtree and prevent further flushes. Must be
--
1.8.3.1


2021-06-04 14:53:53

by Tejun Heo

[permalink] [raw]
Subject: Re: [PATCH] cgroup: Fix kernel-doc

On Wed, May 26, 2021 at 10:49:09AM +0800, Yang Li wrote:
> Fix function name in cgroup.c and rstat.c kernel-doc comment
> to remove these warnings found by clang_w1.
>
> kernel/cgroup/cgroup.c:2401: warning: expecting prototype for
> cgroup_taskset_migrate(). Prototype was for cgroup_migrate_execute()
> instead.
> kernel/cgroup/rstat.c:233: warning: expecting prototype for
> cgroup_rstat_flush_begin(). Prototype was for cgroup_rstat_flush_hold()
> instead.
>
> Reported-by: Abaci Robot <[email protected]>
> Fixes: 'commit e595cd706982 ("cgroup: track migration context in cgroup_mgctx")'
> Signed-off-by: Yang Li <[email protected]>

Applied to cgroup/for-5.14.

Thanks.

--
tejun