[PATCH] mm: memcontrol: fix kernel-doc

[PATCH] mm: memcontrol: fix kernel-doc

[Yang Li]

Fix function name in mm/memcontrol.c kernel-doc comment
to remove a warning.

mm/memcontrol.c:6546: warning: expecting prototype for
mem_cgroup_protected(). Prototype was for
mem_cgroup_calculate_protection() instead.

Reported-by: Abaci Robot <abaci-KPsoFbNs7GizrGE5bRqYAgC/G2K4zDHf@public.gmane.org>
Signed-off-by: Yang Li <yang.lee-KPsoFbNs7GizrGE5bRqYAgC/G2K4zDHf@public.gmane.org>
---
 mm/memcontrol.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/mm/memcontrol.c b/mm/memcontrol.c
index 64ada9e..030c1dc 100644
--- a/mm/memcontrol.c
+++ b/mm/memcontrol.c
@@ -6456,7 +6456,7 @@ static unsigned long effective_protection(unsigned long usage,
 }
 
 /**
- * mem_cgroup_protected - check if memory consumption is in the normal range
+ * mem_cgroup_calculate_protection - check if memory consumption is in the normal range
  * @root: the top ancestor of the sub-tree being checked
  * @memcg: the memory cgroup to check
  *
-- 
1.8.3.1

Re: [PATCH] mm: memcontrol: fix kernel-doc

[Michal Hocko]

On Mon 24-05-21 18:24:22, Yang Li wrote:
> Fix function name in mm/memcontrol.c kernel-doc comment
> to remove a warning.
> 
> mm/memcontrol.c:6546: warning: expecting prototype for
> mem_cgroup_protected(). Prototype was for
> mem_cgroup_calculate_protection() instead.
> 
> Reported-by: Abaci Robot <abaci-KPsoFbNs7GizrGE5bRqYAgC/G2K4zDHf@public.gmane.org>
> Signed-off-by: Yang Li <yang.lee-KPsoFbNs7GizrGE5bRqYAgC/G2K4zDHf@public.gmane.org>

Acked-by: Michal Hocko <mhocko-IBi9RG/b67k@public.gmane.org>

Thanks!

> ---
>  mm/memcontrol.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/mm/memcontrol.c b/mm/memcontrol.c
> index 64ada9e..030c1dc 100644
> --- a/mm/memcontrol.c
> +++ b/mm/memcontrol.c
> @@ -6456,7 +6456,7 @@ static unsigned long effective_protection(unsigned long usage,
>  }
>  
>  /**
> - * mem_cgroup_protected - check if memory consumption is in the normal range
> + * mem_cgroup_calculate_protection - check if memory consumption is in the normal range
>   * @root: the top ancestor of the sub-tree being checked
>   * @memcg: the memory cgroup to check
>   *
> -- 
> 1.8.3.1

-- 
Michal Hocko
SUSE Labs

Re: [PATCH] mm: memcontrol: fix kernel-doc

[Yang Shi]

On Tue, May 25, 2021 at 1:34 AM Michal Hocko <mhocko-IBi9RG/b67k@public.gmane.org> wrote:
>
> On Mon 24-05-21 18:24:22, Yang Li wrote:
> > Fix function name in mm/memcontrol.c kernel-doc comment
> > to remove a warning.
> >
> > mm/memcontrol.c:6546: warning: expecting prototype for
> > mem_cgroup_protected(). Prototype was for
> > mem_cgroup_calculate_protection() instead.
> >
> > Reported-by: Abaci Robot <abaci-KPsoFbNs7GizrGE5bRqYAgC/G2K4zDHf@public.gmane.org>
> > Signed-off-by: Yang Li <yang.lee-KPsoFbNs7GizrGE5bRqYAgC/G2K4zDHf@public.gmane.org>
>
> Acked-by: Michal Hocko <mhocko-IBi9RG/b67k@public.gmane.org>

It seems this has been covered by Mel's W=1 warning cleanup series,
see https://lore.kernel.org/linux-mm/20210520084809.8576-7-mgorman-3eNAlZScCAx27rWaFMvyedHuzzzSOjJt@public.gmane.org/.

>
> Thanks!
>
> > ---
> >  mm/memcontrol.c | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/mm/memcontrol.c b/mm/memcontrol.c
> > index 64ada9e..030c1dc 100644
> > --- a/mm/memcontrol.c
> > +++ b/mm/memcontrol.c
> > @@ -6456,7 +6456,7 @@ static unsigned long effective_protection(unsigned long usage,
> >  }
> >
> >  /**
> > - * mem_cgroup_protected - check if memory consumption is in the normal range
> > + * mem_cgroup_calculate_protection - check if memory consumption is in the normal range
> >   * @root: the top ancestor of the sub-tree being checked
> >   * @memcg: the memory cgroup to check
> >   *
> > --
> > 1.8.3.1
>
> --
> Michal Hocko
> SUSE Labs
>