[PATCH cgroup/for-6.1-fixes] mm: cgroup: fix comments for get from fd/file helpers

[PATCH cgroup/for-6.1-fixes] mm: cgroup: fix comments for get from fd/file helpers

[Yosry Ahmed]

Fix the documentation comments for cgroup_[v1v2_]get_from_[fd/file]().

Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Yosry Ahmed <yosryahmed@google.com>
---
I cannot reproduce the warning so I cannot make sure it's fixed by this.

Again, apologies for missing updating the comment in the first place.
---
 kernel/cgroup/cgroup.c | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/kernel/cgroup/cgroup.c b/kernel/cgroup/cgroup.c
index 6349a9fe9ec1..d922773fa90b 100644
--- a/kernel/cgroup/cgroup.c
+++ b/kernel/cgroup/cgroup.c
@@ -6246,6 +6246,7 @@ static struct cgroup *cgroup_v1v2_get_from_file(struct file *f)
 /**
  * cgroup_get_from_file - same as cgroup_v1v2_get_from_file, but only supports
  * cgroup2.
+ * @f: file corresponding to cgroup2_dir
  */
 static struct cgroup *cgroup_get_from_file(struct file *f)
 {
@@ -6753,7 +6754,7 @@ struct cgroup *cgroup_get_from_path(const char *path)
 EXPORT_SYMBOL_GPL(cgroup_get_from_path);
 
 /**
- * cgroup_get_from_fd - get a cgroup pointer from a fd
+ * cgroup_v1v2_get_from_fd - get a cgroup pointer from a fd
  * @fd: fd obtained by open(cgroup_dir)
  *
  * Find the cgroup from a fd which should be obtained
@@ -6778,6 +6779,7 @@ struct cgroup *cgroup_v1v2_get_from_fd(int fd)
 /**
  * cgroup_get_from_fd - same as cgroup_v1v2_get_from_fd, but only supports
  * cgroup2.
+ * @fd: fd obtained by open(cgroup2_dir)
  */
 struct cgroup *cgroup_get_from_fd(int fd)
 {
-- 
2.38.0.rc1.362.ged0d419d3c-goog

Re: [PATCH cgroup/for-6.1-fixes] mm: cgroup: fix comments for get from fd/file helpers

[Tejun Heo]

On Tue, Oct 11, 2022 at 10:51:55PM +0000, Yosry Ahmed wrote:
> Fix the documentation comments for cgroup_[v1v2_]get_from_[fd/file]().
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Yosry Ahmed <yosryahmed@google.com>
> ---
> I cannot reproduce the warning so I cannot make sure it's fixed by this.
> 
> Again, apologies for missing updating the comment in the first place.

No worries at all. Thanks for fixing it. Applied to cgroup/for-6.1-fixes.

-- 
tejun