linux-kernel - Re: [PATCH v2] sched/fair: fix all kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAKfTPtA6z3oBPd_QhVMeE40RdpbLKm0dJ_7xk_Y3hzrTOaEXAA@mail.gmail.com>
Date:   Wed, 22 Dec 2021 09:22:19 +0100
From:   Vincent Guittot <vincent.guittot@...aro.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        Ricardo Neri <ricardo.neri-calderon@...ux.intel.com>,
        Peter Zijlstra <peterz@...radead.org>,
        Ingo Molnar <mingo@...hat.com>,
        Juri Lelli <juri.lelli@...hat.com>
Subject: Re: [PATCH v2] sched/fair: fix all kernel-doc warnings

On Sat, 18 Dec 2021 at 06:59, Randy Dunlap <rdunlap@...radead.org> wrote:
>
> Quieten all kernel-doc warnings in kernel/sched/fair.c:
>
> kernel/sched/fair.c:3663: warning: No description found for return value of 'update_cfs_rq_load_avg'
> kernel/sched/fair.c:8601: warning: No description found for return value of 'asym_smt_can_pull_tasks'
> kernel/sched/fair.c:8673: warning: Function parameter or member 'sds' not described in 'update_sg_lb_stats'
> kernel/sched/fair.c:9483: warning: contents before sections
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Ricardo Neri <ricardo.neri-calderon@...ux.intel.com>
> Cc: Peter Zijlstra <peterz@...radead.org>
> Cc: Ingo Molnar <mingo@...hat.com>
> Cc: Juri Lelli <juri.lelli@...hat.com>
> Cc: Vincent Guittot <vincent.guittot@...aro.org>

Acked-by: Vincent Guittot <vincent.guittot@...aro.org>

> ---
> v2: Tweak the Return: text of asym_smt_can_pull_tasks() [per Ricardo]
>
>  kernel/sched/fair.c |    8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
>
> --- linux-next-20211217.orig/kernel/sched/fair.c
> +++ linux-next-20211217/kernel/sched/fair.c
> @@ -3652,7 +3652,7 @@ static inline void add_tg_cfs_propagate(
>   *
>   * cfs_rq->avg is used for task_h_load() and update_cfs_share() for example.
>   *
> - * Returns true if the load decayed or we removed load.
> + * Return: true if the load decayed or we removed load.
>   *
>   * Since both these conditions indicate a changed cfs_rq->avg.load we should
>   * call update_tg_load_avg() when this function returns true.
> @@ -8539,6 +8539,8 @@ group_type group_classify(unsigned int i
>   *
>   * If @sg does not have SMT siblings, only pull tasks if all of the SMT siblings
>   * of @dst_cpu are idle and @sg has lower priority.
> + *
> + * Return: true if @dst_cpu can pull tasks, false otherwise.
>   */
>  static bool asym_smt_can_pull_tasks(int dst_cpu, struct sd_lb_stats *sds,
>                                     struct sg_lb_stats *sgs,
> @@ -8614,6 +8616,7 @@ sched_asym(struct lb_env *env, struct sd
>  /**
>   * update_sg_lb_stats - Update sched_group's statistics for load balancing.
>   * @env: The load balancing environment.
> + * @sds: Load-balancing data with statistics of the local group.
>   * @group: sched_group whose statistics are to be updated.
>   * @sgs: variable to hold the statistics for this group.
>   * @sg_status: Holds flag indicating the status of the sched_group
> @@ -9421,12 +9424,11 @@ static inline void calculate_imbalance(s
>  /**
>   * find_busiest_group - Returns the busiest group within the sched_domain
>   * if there is an imbalance.
> + * @env: The load balancing environment.
>   *
>   * Also calculates the amount of runnable load which should be moved
>   * to restore balance.
>   *
> - * @env: The load balancing environment.
> - *
>   * Return:     - The busiest group if imbalance exists.
>   */
>  static struct sched_group *find_busiest_group(struct lb_env *env)